r22885 - /trunk/user_functions/relax_disp.py -- April 30, 2014 - 10:52

Author: bugman
Date: Wed Apr 30 10:52:19 2014
New Revision: 22885

URL: http://svn.gna.org/viewcvs/relax?rev=22885&view=rev
Log:
Fix for the relax_disp.parameter_copy user function description.

The parameters are not averaged but instead the median value from all spins 
is taken.


Modified:
    trunk/user_functions/relax_disp.py

Modified: trunk/user_functions/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/relax_disp.py?rev=22885&r1=22884&r2=22885&view=diff
==============================================================================
--- trunk/user_functions/relax_disp.py  (original)
+++ trunk/user_functions/relax_disp.py  Wed Apr 30 10:52:19 2014
@@ -437,8 +437,8 @@
 )
 # Description.
 uf.desc.append(Desc_container())
-uf.desc[-1].add_paragraph("This is a special function for copying relaxation 
dispersion parameters from one data pipe to another.  It is much more 
advanced than the value.copy user function, in that clustering is taken into 
account.  When the destination data pipe has spin clusters defined, then the 
new parameter values, when required, will be averaged.")
-uf.desc[-1].add_paragraph("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.")
+uf.desc[-1].add_paragraph("This is a special function for copying relaxation 
dispersion parameters from one data pipe to another.  It is much more 
advanced than the value.copy user function, in that clustering is taken into 
account.  When the destination data pipe has spin clusters defined, then the 
new parameter values, when required, will be taken as the median value.")
+uf.desc[-1].add_paragraph("For the cluster specific parameters, i.e. the 
populations of the states and the exchange parameters, a median 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.")
 uf.desc.append(Desc_container("Prompt examples"))
 uf.desc[-1].add_paragraph("To copy the CSA values from the data pipe 'm1' to 
'm2', type:")
 uf.desc[-1].add_prompt("relax> value.parameter_copy('m1', 'm2', 'csa')")