r8473 - /branches/relax_disp/prompt/relax_disp.py -- January 15, 2009 - 15:27

Author: semor
Date: Thu Jan 15 15:27:49 2009
New Revision: 8473

URL: http://svn.gna.org/viewcvs/relax?rev=8473&view=rev
Log:
Started to put equations and references in the user function docstrings.

Also corrected a small typo.

This was proposed by Ed in a post at:
https://mail.gna.org/public/relax-devel/2009-01/msg00028.html
(Message-id: <7f080ed10901080137i35d21213of5884edb7da59d00@xxxxxxxxxxxxxx>)


Modified:
    branches/relax_disp/prompt/relax_disp.py

Modified: branches/relax_disp/prompt/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/prompt/relax_disp.py?rev=8473&r1=8472&r2=8473&view=diff
==============================================================================
--- branches/relax_disp/prompt/relax_disp.py (original)
+++ branches/relax_disp/prompt/relax_disp.py Thu Jan 15 15:27:49 2009
@@ -153,7 +153,7 @@
         exp:  The type of relaxation dispersion experiment performed.
 
 
-        The preet experiments
+        The preset experiments
         ~~~~~~~~~~~~~~~~~~~~~
 
         The supported experiments will include CPMG ('cpmg') and R1rho 
('r1rho').
@@ -217,6 +217,22 @@
             'fast': [R2, Rex, kex],
             'slow': [R2A, kA, dw].
 
+        The equations for these two models are
+                                       /              /        kex       \   
4 * cpmg_frq \
+            'fast': R2eff = R2 + Rex * | 1 - 2 * Tanh | ---------------- | * 
------------ |
+                                       \              \ 2 * 4 * cpmg_frq /   
     kex     /
+
+                                       /     /      dw      \   4 * cpmg_frq 
\
+            'slow': R2eff = R2A + kA - | Sin | ------------ | * ------------ 
|
+                                       \     \ 4 * cpmg_frq /        dw      
/
+
+            where cpmg_frq = 1 / ( 4 * cpmg_tau )
+
+        The references for these equations are
+            'fast': Millet et al., JACS, 2000, 122 : 2867 - 2877 (equation 
19)
+                    Kovrigin et al., JMagRes, 2006, 180 : 93 - 104 (equation 
1)
+            'slow': Tollinger et al., JACS, 2001, 123: 11341-11352 (equation 
2)
+
 
         Examples
         ~~~~~~~~