Author: bugman
Date: Mon Apr 14 19:10:20 2014
New Revision: 22752
URL: http://svn.gna.org/viewcvs/relax?rev=22752&view=rev
Log:
Rearranged the parameter table ordering in the value user functions.
The order now better matches that of the chapters of the user manual and is
consistent between the
functions.
Modified:
trunk/user_functions/value.py
Modified: trunk/user_functions/value.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22752&r1=22751&r2=22752&view=diff
==============================================================================
--- trunk/user_functions/value.py (original)
+++ trunk/user_functions/value.py Mon Apr 14 19:10:20 2014
@@ -90,10 +90,10 @@
uf.desc[-1].add_paragraph("If this is used to change values of previously
minimised parameters, then the minimisation statistics (chi-squared value,
iteration count, function count, gradient count, and Hessian count) will be
reset.")
# Prompt examples.
uf.desc.append(regexp_doc)
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(model_free_params.uf_doc(label="table: model-free
parameters"))
uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
uf.desc.append(consistency_test_params.uf_doc(label="table: consistency
testing parameters"))
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameters"))
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
uf.desc.append(Desc_container("Prompt examples"))
@@ -132,11 +132,11 @@
uf.desc.append(Desc_container())
uf.desc[-1].add_paragraph("The values corresponding to the given parameter
will be displayed. The scaling argument can be used to scale the parameter
values. This can be useful for example in the case of the model-free Rex
parameter to obtain the spectrometer dependent value from the omega_ex field
strength independent internal value. Or to scale correlation times from
seconds down to nanosecond or picosecond timescales.")
uf.desc.append(regexp_doc)
+uf.desc.append(noe_params.uf_doc(label="table: NOE parameters"))
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(model_free_params.uf_doc(label="table: model-free parameter
writing"))
uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
uf.desc.append(consistency_test_params.uf_doc(label="table: consistency
testing parameters"))
-uf.desc.append(noe_params.uf_doc(label="table: NOE parameters"))
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameters"))
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
# Prompt examples.
@@ -274,10 +274,10 @@
uf.desc[-1].add_paragraph("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.desc[-1].add_paragraph("If this is used to change values of previously
minimised parameters, then the minimisation statistics (chi-squared value,
iteration count, function count, gradient count, and Hessian count) will be
reset.")
uf.desc.append(regexp_doc)
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(model_free_params.uf_doc(label="table: model-free
parameters"))
uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
uf.desc.append(consistency_test_params.uf_doc(label="table: consistency
testing parameters"))
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameters"))
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
# Prompt examples.
@@ -359,10 +359,10 @@
uf.desc.append(Desc_container("Spin identification"))
uf.desc[-1].add_paragraph("If the spin ID is left unset, then this will be
applied to all spins. If the data is global non-spin specific data, such as
diffusion tensor parameters, supplying the spin identifier will terminate the
program with an error.")
uf.desc.append(regexp_doc)
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameter
value setting"))
uf.desc.append(model_free_params.uf_doc(label="table: mf parameter value
setting"))
uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameter value
setting"))
uf.desc.append(consistency_test_params.uf_doc(label="table: consistency
testing parameter value setting"))
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameter
value setting"))
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameter value
setting"))
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion parameter
value setting"))
# Prompt examples.
@@ -457,11 +457,11 @@
uf.desc.append(Desc_container())
uf.desc[-1].add_paragraph("The values corresponding to the given parameter
will be written to file. The scaling argument can be used to scale the
parameter values. This can be useful for example in the case of the
model-free Rex parameter to obtain the spectrometer dependent value from the
omega_ex field strength independent internal value. Or to scale correlation
times from seconds down to nanosecond or picosecond timescales.")
uf.desc.append(regexp_doc)
+uf.desc.append(noe_params.uf_doc(label="table: NOE parameters"))
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(model_free_params.uf_doc(label="table: model-free parameter
writing"))
uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
uf.desc.append(consistency_test_params.uf_doc(label="table: consistency
testing parameters"))
-uf.desc.append(noe_params.uf_doc(label="table: NOE parameters"))
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
r22752 - /trunk/user_functions/value.py