r21291 - /branches/relax_disp/auto_analyses/relax_disp.py -- October 28, 2013 - 17:33

Author: bugman
Date: Mon Oct 28 17:33:49 2013
New Revision: 21291

URL: http://svn.gna.org/viewcvs/relax?rev=21291&view=rev
Log:
Updated the insignificance argument docstring for the dispersion 
auto-analysis.


Modified:
    branches/relax_disp/auto_analyses/relax_disp.py

Modified: branches/relax_disp/auto_analyses/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/auto_analyses/relax_disp.py?rev=21291&r1=21290&r2=21291&view=diff
==============================================================================
--- branches/relax_disp/auto_analyses/relax_disp.py (original)
+++ branches/relax_disp/auto_analyses/relax_disp.py Mon Oct 28 17:33:49 2013
@@ -66,7 +66,7 @@
         @type modsel:               str
         @keyword pre_run_dir:       The optional directory containing the 
dispersion auto-analysis results from a previous run.  The optimised 
parameters from these previous results will be used as the starting point for 
optimisation rather than performing a grid search.  This is essential for 
when large spin clusters are specified, as a grid search becomes 
prohibitively expensive with clusters of three or more spins.  At some point 
a RelaxError will occur because the grid search is impossibly large.  For the 
cluster specific parameters, i.e. the populations of the states and the 
exchange parameters, an average value will be used as the starting point.  
For all other parameters, the R20 values for each spin and magnetic field, as 
well as the parameters related to the chemical shift difference dw, the 
optimised values of the previous run will be directly copied.
         @type pre_run_dir:          None or str
-        @keyword insignificance:    The R2eff/R1rho value in rad/s by which 
to judge insignificance.  If the maximum difference between two points on all 
dispersion curves for a spin is less than this value, that spin will be 
deselected.
+        @keyword insignificance:    The R2eff/R1rho value in rad/s by which 
to judge insignificance.  If the maximum difference between two points on all 
dispersion curves for a spin is less than this value, that spin will be 
deselected.  This does not affect the 'No Rex' model.  Set this value to 0.0 
to use all data.  The value will be passed on to the 
relax_disp.insignificance user function.
         @type insignificance:       float
         @keyword numeric_only:      The class of models to use in the model 
selection.  The default of False allows all dispersion models to be used in 
the analysis (no exchange, the analytic models and the numeric models).  The 
value of True will activate a pure numeric solution - the analytic models 
will be optimised, as they are very useful for replacing the grid search for 
the numeric models, but the final model selection will not include them.
         @type numeric_only:         bool