1
2
3
4
5
6 """
7 VMD control
8 ===========
9
10 Simple client to transmit Tcl commands to a server running in `VMD`_.
11
12 VMD and the server run locally and can be started from the module. Once the
13 server is running, one can use :class:`vmd.client` to communicate with the server
14 process via a local socket.
15
16 Example
17 -------
18
19 Start a VMD server and connect::
20
21 from vmd.control import *
22 VMD = server()
23 VMD.command('molecule new load 1AKE')
24
25 or start an interactive `Tcl`_ session connected to a running VMD
26 server process::
27
28 interactive(host)
29 asyncore.loop() # necessary
30
31 See `VMD Tcl Text Commands`_ for all available commands.
32
33 .. _VMD: http://www.ks.uiuc.edu/Research/vmd/
34 .. _Tcl: http://www.tcl.tk/man/
35 .. _VMD Tcl Text Commands: http://www.ks.uiuc.edu/Research/vmd/current/ug/node107.html
36
37 Module content
38 --------------
39
40 .. automodule:: vmd.control
41 :members:
42
43 """
44 __docformat__ = "restructuredtext en"
45 __all__ = [ 'control', ]
46
47 import control
48 from control import command as cmd
49