Source Code for Module user_functions.vmd

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2003-2004,2012 Edward d'Auvergne                              # 
 4  #                                                                             # 
 5  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 6  #                                                                             # 
 7  # This program 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 3 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.       # 
19  #                                                                             # 
20  ############################################################################### 
21   
22  # Module docstring. 
23  """The vmd user function definitions for controlling VMD.""" 
24   
25  # relax module imports. 
26  from pipe_control import vmd 
27  from user_functions.data import Uf_info; uf_info = Uf_info() 
28  from user_functions.objects import Desc_container 
29   
30  # The user function class. 
31  uf_class = uf_info.add_class('vmd') 
32  uf_class.title = "Class for interfacing with VMD." 
33  uf_class.menu_text = "&vmd" 
34   
35   
36  # The vmd.view user function. 
37  uf = uf_info.add_uf('vmd.view') 
38  uf.title = "View the structures loaded into the relax data store using VMD." 
39  uf.title_short = "Molecular viewing using VMD." 
40  # Description. 
41  uf.desc.append(Desc_container()) 
42  uf.desc[-1].add_paragraph("This will launch VMD with all of the structures loaded into the relax data store.") 
43  # Prompt examples. 
44  uf.desc.append(Desc_container("Prompt examples")) 
45  uf.desc[-1].add_prompt("relax> vmd.view()") 
46  uf.backend = vmd.view 
47  uf.menu_text = "&view" 
48  uf.wizard_size = (700, 400) 
49  uf.wizard_apply_button = False 
50