r18817 - in /trunk: specific_fns/model_free/main.py user_functions/value.py -- March 13, 2013 - 15:51

Author: bugman
Date: Wed Mar 13 15:51:47 2013
New Revision: 18817

URL: http://svn.gna.org/viewcvs/relax?rev=18817&view=rev
Log:
Created the model-free write_doc class variable talking about the field 
strength independent Rex value.

This has been added to the value.display and value.write user functions to 
explain that Rex values
are very small and that the user needs to scale them up.


Modified:
    trunk/specific_fns/model_free/main.py
    trunk/user_functions/value.py

Modified: trunk/specific_fns/model_free/main.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/model_free/main.py?rev=18817&r1=18816&r2=18817&view=diff
==============================================================================
--- trunk/specific_fns/model_free/main.py (original)
+++ trunk/specific_fns/model_free/main.py Wed Mar 13 15:51:47 2013
@@ -79,6 +79,11 @@
     set_doc.add_list_element("rex is the chemical exchange value for the 
current frequency.")
     set_doc.add_list_element("pi is in the namespace of relax, ie just type 
'pi'.")
     set_doc.add_list_element("frequency is the proton frequency 
corresponding to the data.")
+
+    write_doc = Desc_container("Model-free parameter writing details")
+    write_doc.add_paragraph("For the model-free theory, it is assumed that 
Rex values are scaled quadratically with field strength.  The values will 
seem quite small as they will be written out as a field strength independent 
value.  Hence please use the following formula to convert the value to that 
expected for a given magnetic field strength:")
+    write_doc.add_verbatim("    Rex = value * (2.0 * pi * frequency) ** 2")
+    write_doc.add_paragraph("The frequency is that of the proton in Hertz.")
 
 
     def _are_mf_params_set(self, spin):

Modified: trunk/user_functions/value.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=18817&r1=18816&r2=18817&view=diff
==============================================================================
--- trunk/user_functions/value.py (original)
+++ trunk/user_functions/value.py Wed Mar 13 15:51:47 2013
@@ -127,6 +127,7 @@
 )
 uf.desc.append(regexp_doc)
 uf.desc.append(Model_free.return_data_name_doc)
+uf.desc.append(Model_free.write_doc)
 uf.desc.append(Jw_mapping.return_data_name_doc)
 uf.desc.append(Consistency_tests.return_data_name_doc)
 uf.desc.append(Noe.return_data_name_doc)
@@ -434,6 +435,7 @@
 uf.desc[-1].add_paragraph("The values corresponding to the given parameter 
will be written to file.")
 uf.desc.append(regexp_doc)
 uf.desc.append(Model_free.return_data_name_doc)
+uf.desc.append(Model_free.write_doc)
 uf.desc.append(Jw_mapping.return_data_name_doc)
 uf.desc.append(Consistency_tests.return_data_name_doc)
 uf.desc.append(Noe.return_data_name_doc)