Source Code for Package user_functions

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 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  # Package docstring. 
 23  """Package containing all of the user function details. 
 24   
 25  This package contains all information and details about user functions, from documentation to icons to be used in the GUI.  This package contains a special data structure which will be used by the different UIs to automatically generate their interfaces to the user functions. 
 26  """ 
 27   
 28  # The __all__ package list (main modules). 
 29  __all__ = [ 
 30      'data', 
 31      'objects' 
 32  ] 
 33   
 34  # The __all__ package list (user function modules). 
 35  __all__ += [ 
 36      'align_tensor', 
 37      'angles', 
 38      'bmrb', 
 39      'bruker', 
 40      'consistency_tests', 
 41      'dasha', 
 42      'deselect', 
 43      'diffusion_tensor', 
 44      'dipole_pair', 
 45      'dx', 
 46      'eliminate', 
 47      'fix', 
 48      'frame_order', 
 49      'frq', 
 50      'grace', 
 51      'interatomic', 
 52      'jw_mapping', 
 53      'minimisation', 
 54      'model_free', 
 55      'model_selection', 
 56      'molecule', 
 57      'molmol', 
 58      'monte_carlo', 
 59      'n_state_model', 
 60      'noe', 
 61      'palmer', 
 62      'paramag', 
 63      'pcs', 
 64      'pipe', 
 65      'pymol_control', 
 66      'rdc', 
 67      'relax_data', 
 68      'relax_fit', 
 69      'residue', 
 70      'reset', 
 71      'results', 
 72      'script', 
 73      'select', 
 74      'sequence', 
 75      'spectrum', 
 76      'spin', 
 77      'state', 
 78      'structure', 
 79      'sys_info', 
 80      'temperature', 
 81      'value', 
 82      'vmd' 
 83  ] 
 84   
 85  # Import all the modules to set up the data. 
 86  import user_functions.align_tensor 
 87  import user_functions.angles 
 88  import user_functions.bmrb 
 89  import user_functions.bruker 
 90  import user_functions.consistency_tests 
 91  import user_functions.dasha 
 92  import user_functions.deselect 
 93  import user_functions.diffusion_tensor 
 94  import user_functions.dipole_pair 
 95  import user_functions.dx 
 96  import user_functions.eliminate 
 97  import user_functions.fix 
 98  import user_functions.frame_order 
 99  import user_functions.frq 
100  import user_functions.grace 
101  import user_functions.interatomic 
102  import user_functions.jw_mapping 
103  import user_functions.minimisation 
104  import user_functions.model_free 
105  import user_functions.model_selection 
106  import user_functions.molecule 
107  import user_functions.molmol 
108  import user_functions.monte_carlo 
109  import user_functions.n_state_model 
110  import user_functions.noe 
111  import user_functions.palmer 
112  import user_functions.paramag 
113  import user_functions.pcs 
114  import user_functions.pipe 
115  import user_functions.pymol_control 
116  import user_functions.rdc 
117  import user_functions.relax_data 
118  import user_functions.relax_fit 
119  import user_functions.residue 
120  import user_functions.reset 
121  import user_functions.results 
122  import user_functions.script 
123  import user_functions.select 
124  import user_functions.sequence 
125  import user_functions.spectrum 
126  import user_functions.spin 
127  import user_functions.state 
128  import user_functions.structure 
129  import user_functions.sys_info 
130  import user_functions.temperature 
131  import user_functions.value 
132  import user_functions.vmd 
133   
134  # Import the data structure. 
135  from user_functions.data import Uf_info; uf_info = Uf_info() 
136   
137  # Check the validity of the data. 
138  uf_info.validate() 
139