Package user_functions :: Module vmd
[hide private]
[frames] | no frames]

Source Code for Module user_functions.vmd

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2003-2012 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax is free software; you can redistribute it and/or modify               # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation; either version 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax is distributed in the hope that it will be useful,                    # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Module docstring. 
24  """The vmd user function definitions for controlling VMD.""" 
25   
26  # relax module imports. 
27  from generic_fns import vmd 
28  from graphics import WIZARD_IMAGE_PATH 
29  from user_functions.data import Uf_info; uf_info = Uf_info() 
30  from user_functions.objects import Desc_container 
31   
32  # The user function class. 
33  uf_class = uf_info.add_class('vmd') 
34  uf_class.title = "Class for interfacing with VMD." 
35  uf_class.menu_text = "&vmd" 
36   
37   
38  # The vmd.view user function. 
39  uf = uf_info.add_uf('vmd.view') 
40  uf.title = "View the structures loaded into the relax data store using VMD." 
41  uf.title_short = "Molecular viewing using VMD." 
42  # Description. 
43  uf.desc.append(Desc_container()) 
44  uf.desc[-1].add_paragraph("This will launch VMD with all of the structures loaded into the relax data store.") 
45  # Prompt examples. 
46  uf.desc.append(Desc_container("Prompt examples")) 
47  uf.desc[-1].add_prompt("relax> vmd.view()") 
48  uf.backend = vmd.view 
49  uf.menu_text = "&view" 
50  uf.wizard_size = (700, 400) 
51  uf.wizard_apply_button = False 
52