Source Code for Package user_functions

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 2012-2013 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      'chemical_shift', 
 41      'consistency_tests', 
 42      'dasha', 
 43      'deselect', 
 44      'diffusion_tensor', 
 45      'domain', 
 46      'dx', 
 47      'eliminate', 
 48      'fix', 
 49      'frame_order', 
 50      'grace', 
 51      'interatom', 
 52      'j_coupling', 
 53      'jw_mapping', 
 54      'minimisation', 
 55      'model_free', 
 56      'model_selection', 
 57      'molecule', 
 58      'molmol', 
 59      'monte_carlo', 
 60      'n_state_model', 
 61      'noe', 
 62      'palmer', 
 63      'paramag', 
 64      'pcs', 
 65      'pipe', 
 66      'pymol_control', 
 67      'rdc', 
 68      'relax_data', 
 69      'relax_disp', 
 70      'relax_fit', 
 71      'residue', 
 72      'reset', 
 73      'results', 
 74      'script', 
 75      'select', 
 76      'sequence', 
 77      'spectrometer', 
 78      'spectrum', 
 79      'spin', 
 80      'state', 
 81      'structure', 
 82      'sys_info', 
 83      'value', 
 84      'vmd' 
 85  ] 
 86   
 87   
 88 -def initialise(): 
 89      """Initialise all of the user function definitions by importing then validating them.""" 
 90   
 91      # Import all the modules to set up the data. 
 92      import user_functions.align_tensor 
 93      import user_functions.angles 
 94      import user_functions.bmrb 
 95      import user_functions.bruker 
 96      import user_functions.chemical_shift 
 97      import user_functions.consistency_tests 
 98      import user_functions.dasha 
 99      import user_functions.deselect 
100      import user_functions.diffusion_tensor 
101      import user_functions.domain 
102      import user_functions.dx 
103      import user_functions.eliminate 
104      import user_functions.fix 
105      import user_functions.frame_order 
106      import user_functions.grace 
107      import user_functions.interatom 
108      import user_functions.j_coupling 
109      import user_functions.jw_mapping 
110      import user_functions.minimisation 
111      import user_functions.model_free 
112      import user_functions.model_selection 
113      import user_functions.molecule 
114      import user_functions.molmol 
115      import user_functions.monte_carlo 
116      import user_functions.n_state_model 
117      import user_functions.noe 
118      import user_functions.palmer 
119      import user_functions.paramag 
120      import user_functions.pcs 
121      import user_functions.pipe 
122      import user_functions.pymol_control 
123      import user_functions.rdc 
124      import user_functions.relax_data 
125      import user_functions.relax_disp 
126      import user_functions.relax_fit 
127      import user_functions.residue 
128      import user_functions.reset 
129      import user_functions.results 
130      import user_functions.script 
131      import user_functions.select 
132      import user_functions.sequence 
133      import user_functions.spectrometer 
134      import user_functions.spectrum 
135      import user_functions.spin 
136      import user_functions.state 
137      import user_functions.structure 
138      import user_functions.sys_info 
139      import user_functions.value 
140      import user_functions.vmd 
141   
142      # Import the data structure. 
143      from user_functions.data import Uf_info; uf_info = Uf_info() 
144   
145      # Check the validity of the data. 
146      uf_info.validate() 
147