Source Code for Module prompt.run

  1  ############################################################################### 
  2  #                                                                             # 
  3  # Copyright (C) 2004-2005 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  import sys 
 24   
 25  import help 
 26   
 27   
 28 -class Run: 
 29 -    def __init__(self, relax): 
 30          # Help. 
 31          self.__relax_help__ = \ 
 32          """Class for holding the functions for manipulating runs.""" 
 33   
 34          # Add the generic help string. 
 35          self.__relax_help__ = self.__relax_help__ + "\n" + help.relax_class_help 
 36   
 37          # Place relax in the class namespace. 
 38          self.__relax__ = relax 
 39   
 40   
 41 -    def create(self, run=None, run_type=None): 
 42          """Function for setting up a run type. 
 43   
 44          Keyword Arguments 
 45          ~~~~~~~~~~~~~~~~~ 
 46   
 47          run:  The name of the run. 
 48   
 49          type:  The type of run. 
 50   
 51   
 52          Description 
 53          ~~~~~~~~~~~ 
 54   
 55          The run name can be any string however the run type can only be one of the following 
 56   
 57              'jw':  Reduced spectral density mapping, 
 58              'mf':  Model-free analysis, 
 59              'noe':  Steady state NOE calculation, 
 60              'relax_fit':  Relaxation curve fitting, 
 61              'srls':  SRLS analysis. 
 62   
 63   
 64          Examples 
 65          ~~~~~~~~ 
 66   
 67          To set up a model-free analysis run with the name 'm5', type: 
 68   
 69          relax> run.create('m5', 'mf') 
 70          """ 
 71   
 72          # Function intro text. 
 73          if self.__relax__.interpreter.intro: 
 74              text = sys.ps3 + "run.create(" 
 75              text = text + "run=" + `run` 
 76              text = text + ", run_type=" + `run_type` + ")" 
 77              print text 
 78   
 79          # The name of the run. 
 80          if type(run) != str: 
 81              raise RelaxStrError, ('run', run) 
 82   
 83          # The run type. 
 84          if type(run_type) != str: 
 85              raise RelaxStrError, ('run_type', run_type) 
 86   
 87          # Execute the functional code. 
 88          self.__relax__.generic.runs.create(run=run, run_type=run_type) 
 89   
 90   
 91 -    def delete(self, run=None): 
 92          """Function for deleting a run. 
 93   
 94          Keyword Arguments 
 95          ~~~~~~~~~~~~~~~~~ 
 96   
 97          run:  The name of the run. 
 98   
 99   
100          Description 
101          ~~~~~~~~~~~ 
102   
103          This function will destroy all data corresponding to the given run. 
104          """ 
105   
106          # Function intro text. 
107          if self.__relax__.interpreter.intro: 
108              text = sys.ps3 + "run.delete(" 
109              text = text + "run=" + `run` + ")" 
110              print text 
111   
112          # The run argument. 
113          if run != None and type(run) != str: 
114              raise RelaxNoneStrError, ('run', run) 
115   
116          # Execute the functional code. 
117          self.__relax__.generic.runs.delete(run=run) 
118