r19248 - /branches/relax_disp/user_functions/relax_disp.py -- March 27, 2013 - 15:43

Author: bugman
Date: Wed Mar 27 15:43:43 2013
New Revision: 19248

URL: http://svn.gna.org/viewcvs/relax?rev=19248&view=rev
Log:
Manually ported r8721 from the old relax_disp branch from the prompt package 
to the user_functions package.

.....
  r8721 | semor | 2009-02-03 00:10:20 +0100 (Tue, 03 Feb 2009) | 5 lines
  Changed paths:
     M /branches/relax_disp/prompt/relax_disp.py
  
  Added more to the docstring.
  
  This is not complete yet...
.....


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=19248&r1=19247&r2=19248&view=diff
==============================================================================
--- branches/relax_disp/user_functions/relax_disp.py (original)
+++ branches/relax_disp/user_functions/relax_disp.py Wed Mar 27 15:43:43 2013
@@ -83,6 +83,12 @@
     r2eff = - ( 1 / delayT ) * log ( int_cpmg / int_ref )
 """)
 uf.desc[-1].add_paragraph("If 'r1rho' is chosen, nothing happens yet, as the 
code is not implemented.")
+# Prompt examples.
+uf.desc.append(Desc_container("Prompt examples"))
+uf.desc[-1].add_paragraph("To calculate r2eff from a CPMG experiment, for 
experiment named '600', a constant time delay T of 20 ms (0.020 s) and 
intensities of CPMG and reference peak of, respectively, 0.742 and 0.9641, 
type one of:")
+uf.desc[-1].add_prompt("relax> relax_disp.calc_r2eff('cpmg', '600', 0.020, 
0.742, 0.9641)")
+uf.desc[-1].add_prompt("relax> relax_disp.calc_r2eff(exp_type='cpmg', 
id='600', delayT=0.020, int_cpmg=0.742, int_ref=0.9641)")
+uf.desc[-1].add_paragraph("ANOTHER EXAMPLE FOR BATCH USE (FROM PEAK 
INTENSITY LISTS) WILL SOON BE ADDED.")
 uf.backend = relax_disp_obj._calc_r2eff
 uf.menu_text = "&calc_r2eff"
 uf.wizard_size = (800, 500)