r19226 - /branches/relax_disp/user_functions/relax_disp.py -- March 27, 2013 - 15:00

Author: bugman
Date: Wed Mar 27 15:00:49 2013
New Revision: 19226

URL: http://svn.gna.org/viewcvs/relax?rev=19226&view=rev
Log:
Manually merged r8473 from the old relax_disp branch.

.....
  r8473 | semor | 2009-01-15 15:27:49 +0100 (Thu, 15 Jan 2009) | 9 lines
  Changed paths:
     M /branches/relax_disp/prompt/relax_disp.py
  
  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/user_functions/relax_disp.py

Modified: branches/relax_disp/user_functions/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/relax_disp/user_functions/relax_disp.py?rev=19226&r1=19225&r2=19226&view=diff
==============================================================================
--- branches/relax_disp/user_functions/relax_disp.py (original)
+++ branches/relax_disp/user_functions/relax_disp.py Wed Mar 27 15:00:49 2013
@@ -160,9 +160,29 @@
 # Description.
 uf.desc.append(Desc_container())
 uf.desc[-1].add_paragraph("The supported equations will include the default 
fast-exchange limit as well as the slow-exchange limit.")
+uf.desc.append(Desc_container("The preset experiments"))
 uf.desc[-1].add_paragraph("The parameters of these two models are")
 uf.desc[-1].add_item_list_element("'fast'", "[R2, Rex, kex],")
 uf.desc[-1].add_item_list_element("'slow'", "[R2A, kA, dw].")
+uf.desc[-1].add_paragraph("The equation for fast exchange is:")
+uf.desc[-1].add_verbatim("""
+                       /              /        kex       \   4 * cpmg_frq \ 
+    R2eff = R2 + Rex * | 1 - 2 * tanh | ---------------- | * ------------ |
+                       \              \ 2 * 4 * cpmg_frq /        kex     /
+""")
+uf.desc[-1].add_paragraph("and the equation for slow exchange is:")
+uf.desc[-1].add_verbatim("""
+                       /     /      dw      \   4 * cpmg_frq \ 
+    R2eff = R2A + kA - | sin | ------------ | * ------------ |
+                       \     \ 4 * cpmg_frq /        dw      /
+""")
+uf.desc[-1].add_paragraph("where:")
+uf.desc[-1].add_verbatim("""
+    cpmg_frq = 1 / ( 4 * cpmg_tau )
+""")
+uf.desc[-1].add_paragraph("The references for these equations are:")
+uf.desc[-1].add_item_list_element("'fast'", "Millet et al., JACS, 2000, 122, 
2867-2877 (equation 19), and Kovrigin et al., J. Mag. Res., 2006, 180, 93-104 
(equation 1).")
+uf.desc[-1].add_item_list_element("'slow'", "Tollinger et al., JACS, 2001, 
123: 11341-11352 (equation 2).")
 # Prompt examples.
 uf.desc.append(Desc_container("Prompt examples"))
 uf.desc[-1].add_paragraph("To pick the model 'fast' for all selected spins, 
type one of:")