Author: bugman
Date: Mon Apr 14 19:07:54 2014
New Revision: 22751
URL: http://svn.gna.org/viewcvs/relax?rev=22751&view=rev
Log:
Shifted the model-free parameter writing documentation to the parameter list
object.
Modified:
trunk/specific_analyses/model_free/parameter_object.py
trunk/specific_analyses/model_free/uf.py
trunk/user_functions/value.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=22751&r1=22750&r2=22751&view=diff
==============================================================================
--- trunk/specific_analyses/model_free/parameter_object.py (original)
+++ trunk/specific_analyses/model_free/parameter_object.py Mon Apr 14
19:07:54 2014
@@ -71,6 +71,7 @@
# 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 parameter writing",
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)
@@ -83,3 +84,9 @@
doc.add_paragraph("where:")
doc.add_list_element("rex is the chemical exchange value for the
current frequency.")
doc.add_list_element("frequency is the proton frequency
corresponding to the data.")
+
+ # Parameter writing documentation.
+ for doc in self._uf_doc_loop(["table: model-free parameter
writing"]):
+ doc.add_paragraph("For model-free theory it is assumed that Rex
values are scaled quadratically with field strength. The values will be very
small as they will be written out as a field strength independent value.
Hence use the following formula to convert the value to that expected for a
given magnetic field strength:")
+ doc.add_verbatim(" Rex = value * (2.0 * pi * frequency) ** 2")
+ doc.add_paragraph("The frequency is that of the proton in
Hertz.")
Modified: trunk/specific_analyses/model_free/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/model_free/uf.py?rev=22751&r1=22750&r2=22751&view=diff
==============================================================================
--- trunk/specific_analyses/model_free/uf.py (original)
+++ trunk/specific_analyses/model_free/uf.py Mon Apr 14 19:07:54 2014
@@ -73,12 +73,6 @@
eliminate_doc.append(Desc_container("Arguments"))
eliminate_doc[-1].add_paragraph("The 'args' argument must be a tuple of
length 2, the elements of which must be numbers. For example, to eliminate
models which have a local tm value greater than 25 ns and models with
internal correlation times greater than 1.5 times tm, set 'args' to (25 *
1e-9, 1.5).")
-# Parameter writing documentation.
-write_doc = Desc_container("Model-free parameter writing details")
-write_doc.add_paragraph("For the model-free theory, it is assumed that Rex
values are scaled quadratically with field strength. The values will seem
quite small as they will be written out as a field strength independent
value. Hence please use the following formula to convert the value to that
expected for a given magnetic field strength:")
-write_doc.add_verbatim(" Rex = value * (2.0 * pi * frequency) ** 2")
-write_doc.add_paragraph("The frequency is that of the proton in Hertz.")
-
def create_model(model=None, equation=None, params=None, spin_id=None):
"""Function for creating a custom model-free model.
Modified: trunk/user_functions/value.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22751&r1=22750&r2=22751&view=diff
==============================================================================
--- trunk/user_functions/value.py (original)
+++ trunk/user_functions/value.py Mon Apr 14 19:07:54 2014
@@ -132,8 +132,7 @@
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(model_free_params.uf_doc(label="table: model-free
parameters"))
-uf.desc.append(model_free_uf.write_doc)
+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"))
@@ -458,8 +457,7 @@
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(model_free_params.uf_doc(label="table: model-free
parameters"))
-uf.desc.append(model_free_uf.write_doc)
+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"))
r22751 - in /trunk: specific_analyses/model_free/parameter_object.py specific_analyses/model_free/uf.py user_functions/value.py