Author: bugman
Date: Mon Apr 14 15:51:32 2014
New Revision: 22737
URL: http://svn.gna.org/viewcvs/relax?rev=22737&view=rev
Log:
Clean up of the grace.write user function documentation.
The minimisation statistics table has been removed and instead the
minimisation statistics are
included in the parameter tables of the specific analyses, when appropriate.
Modified:
trunk/specific_analyses/model_free/parameter_object.py
trunk/specific_analyses/relax_disp/parameter_object.py
trunk/specific_analyses/relax_fit/parameter_object.py
trunk/user_functions/grace.py
Modified: trunk/specific_analyses/model_free/parameter_object.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/model_free/parameter_object.py?rev=22737&r1=22736&r2=22737&view=diff
==============================================================================
--- trunk/specific_analyses/model_free/parameter_object.py (original)
+++ trunk/specific_analyses/model_free/parameter_object.py Mon Apr 14
15:51:32 2014
@@ -71,5 +71,6 @@
# Set up the user function documentation.
self._set_uf_title("Model-free parameters")
self._uf_param_table(label="table: model-free parameters",
caption="Model-free parameters.")
+ self._uf_param_table(label="table: model-free parameters and min
stats", caption="Model-free parameters and minimisation statistics.",
sets=['params', 'fixed', 'min'])
self._uf_param_table(label="table: all model-free parameters",
caption="Model-free parameters.", scope=None)
self._uf_param_table(label="table: mf parameter value setting",
caption="Model-free parameter value setting.", default=True)
Modified: trunk/specific_analyses/relax_disp/parameter_object.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_disp/parameter_object.py?rev=22737&r1=22736&r2=22737&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/parameter_object.py (original)
+++ trunk/specific_analyses/relax_disp/parameter_object.py Mon Apr 14
15:51:32 2014
@@ -93,4 +93,5 @@
# Set up the user function documentation.
self._set_uf_title("Relaxation dispersion parameters")
self._uf_param_table(label="table: dispersion parameters",
caption="Relaxation dispersion parameters.")
+ self._uf_param_table(label="table: dispersion parameters and min
stats", caption="Relaxation dispersion parameters and minimisation
statistics.", sets=['params', 'fixed', 'min'])
self._uf_param_table(label="table: dispersion parameter value
setting", caption="Relaxation dispersion parameter value setting.",
default=True)
Modified: trunk/specific_analyses/relax_fit/parameter_object.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_fit/parameter_object.py?rev=22737&r1=22736&r2=22737&view=diff
==============================================================================
--- trunk/specific_analyses/relax_fit/parameter_object.py (original)
+++ trunk/specific_analyses/relax_fit/parameter_object.py Mon Apr 14
15:51:32 2014
@@ -61,4 +61,5 @@
# Set up the user function documentation.
self._set_uf_title("Relaxation curve fitting parameters")
self._uf_param_table(label="table: curve-fit parameters",
caption="Relaxation curve fitting parameters.")
+ self._uf_param_table(label="table: curve-fit parameters and min
stats", caption="Relaxation curve fitting parameters and minimisation
statistics.", sets=['params', 'fixed', 'min'])
self._uf_param_table(label="table: curve-fit parameter value
setting", caption="Relaxation curve fitting parameter value setting.",
default=True)
Modified: trunk/user_functions/grace.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/grace.py?rev=22737&r1=22736&r2=22737&view=diff
==============================================================================
--- trunk/user_functions/grace.py (original)
+++ trunk/user_functions/grace.py Mon Apr 14 15:51:32 2014
@@ -32,7 +32,7 @@
# relax module imports.
from graphics import WIZARD_IMAGE_PATH
-from pipe_control import grace, minimise
+from pipe_control import grace
from prompt.doc_string import regexp_doc
from specific_analyses.consistency_tests.parameter_object import
Consistency_tests_params; consistency_test_params = Consistency_tests_params()
from specific_analyses.jw_mapping.parameter_object import Jw_mapping_params;
jw_mapping_params = Jw_mapping_params()
@@ -191,13 +191,12 @@
uf.desc[-1].add_item_list_element("'sims'", "Plot the simulation values.")
uf.desc[-1].add_paragraph("Normalisation is only allowed for series type
data, for example the R2 exponential curves, and will be ignored for all
other data types. If the norm flag is set to True then the y-value of the
first point of the series will be set to 1. This normalisation is useful for
highlighting errors in the data sets.")
uf.desc.append(regexp_doc)
-uf.desc.append(minimise.return_data_name_doc)
-uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
+uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters
and min stats"))
uf.desc.append(noe_params.uf_doc(label="table: NOE parameters"))
-uf.desc.append(model_free_params.uf_doc(label="table: model-free
parameters"))
+uf.desc.append(model_free_params.uf_doc(label="table: model-free parameters
and min stats"))
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_disp_params.uf_doc(label="table: dispersion
parameters"))
+uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion parameters
and min stats"))
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
uf.desc[-1].add_paragraph("To write the NOE values for all spins to the
Grace file 'noe.agr', type one of:")
r22737 - in /trunk: specific_analyses/model_free/ specific_analyses/relax_disp/ specific_analyses/relax_fit/ user_functions/