r16134 - /branches/uf_redesign/user_functions/relax_data.py -- May 09, 2012 - 10:09

Author: bugman
Date: Wed May  9 10:09:48 2012
New Revision: 16134

URL: http://svn.gna.org/viewcvs/relax?rev=16134&view=rev
Log:
Improved the relax_data.read user function docs to stress the importance of 
frequency!


Modified:
    branches/uf_redesign/user_functions/relax_data.py

Modified: branches/uf_redesign/user_functions/relax_data.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/user_functions/relax_data.py?rev=16134&r1=16133&r2=16134&view=diff
==============================================================================
--- branches/uf_redesign/user_functions/relax_data.py (original)
+++ branches/uf_redesign/user_functions/relax_data.py Wed May  9 10:09:48 2012
@@ -342,6 +342,8 @@
     can_be_none = True
 )
 uf.desc = """
+This will load the relaxation data into the relax data store.  The data is 
associated with the spectrometer frequency in Hertz.  For subsequent 
analysis, this frequency must be set to the exact field strength.  This value 
is stored in the 'sfrq' parameter in the Varian procpar file or the 'SFO1' 
parameter in the Bruker acqus file.
+
 The spin system can be identified in the file using two different formats.  
The first is the spin ID string column which can include the molecule name, 
the residue name and number, and the spin name and number.  Alternatively the 
molecule name, residue number, residue name, spin number and/or spin name 
columns can be supplied allowing this information to be in separate columns.  
Note that the numbering of columns starts at one.  The spin ID string can be 
used to restrict the reading to certain spin types, for example only 15N 
spins when only residue information is in the file.
 """
 uf.prompt_examples = """