Author: bugman
Date: Mon Apr 14 18:04:43 2014
New Revision: 22743
URL: http://svn.gna.org/viewcvs/relax?rev=22743&view=rev
Log:
The relaxation dispersion parameter setting documentation has been shifted
into the parameter list object.
The documentation has also been rewritten as it originates from Sebastien
Morin back in 2009 and is
now very much out of date.
Modified:
trunk/specific_analyses/relax_disp/parameter_object.py
trunk/specific_analyses/relax_disp/uf.py
trunk/user_functions/value.py
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=22743&r1=22742&r2=22743&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/parameter_object.py (original)
+++ trunk/specific_analyses/relax_disp/parameter_object.py Mon Apr 14
18:04:43 2014
@@ -1,6 +1,7 @@
###############################################################################
#
#
# Copyright (C) 2014 Edward d'Auvergne
#
+# Copyright (C) 2009 Sebastien Morin
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -92,6 +93,10 @@
# 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",
caption="Relaxation dispersion parameters.", type=True)
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)
+ self._uf_param_table(label="table: dispersion parameter value
setting", caption="Relaxation dispersion parameter value setting.",
default=True, type=True)
+
+ # Value setting documentation.
+ for doc in self._uf_doc_loop(["table: dispersion parameters",
"table: dispersion parameter value setting"]):
+ doc.add_paragraph("Any of the relaxation dispersion parameters
which are of the 'float' type can be set. Note that setting values for
parameters which are not part of the model will have no effect.")
Modified: trunk/specific_analyses/relax_disp/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_disp/uf.py?rev=22743&r1=22742&r2=22743&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/uf.py (original)
+++ trunk/specific_analyses/relax_disp/uf.py Mon Apr 14 18:04:43 2014
@@ -40,11 +40,6 @@
api_relax_disp = Relax_disp()
-# Value setting documentation.
-set_doc = Desc_container("Relaxation dispersion curve fitting set details")
-set_doc.add_paragraph("Only three parameters can be set for either the slow-
or the fast-exchange regime. For the slow-exchange regime, these parameters
include the transversal relaxation rate for state A (R2A), the exchange rate
from state A to state (k_AB) and the chemical shift difference between states
A and B (dw). For the fast-exchange regime, these include the transversal
relaxation rate (R2), the chemical exchange contribution to R2 (Rex) and the
exchange rate (kex). Setting parameters for a non selected model has no
effect.")
-
-
def cluster(cluster_id=None, spin_id=None):
"""Define spin clustering.
Modified: trunk/user_functions/value.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22743&r1=22742&r2=22743&view=diff
==============================================================================
--- trunk/user_functions/value.py (original)
+++ trunk/user_functions/value.py Mon Apr 14 18:04:43 2014
@@ -104,7 +104,6 @@
uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(n_state_model_uf.set_doc)
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameters"))
-uf.desc.append(relax_disp_uf.set_doc)
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
uf.desc.append(Desc_container("Prompt examples"))
uf.desc[-1].add_paragraph("To copy the CSA values from the data pipe 'm1' to
'm2', type:")
@@ -292,7 +291,6 @@
uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
uf.desc.append(n_state_model_uf.set_doc)
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameters"))
-uf.desc.append(relax_disp_uf.set_doc)
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion
parameters"))
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
@@ -381,7 +379,6 @@
uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameter
value setting"))
uf.desc.append(n_state_model_uf.set_doc)
uf.desc.append(n_state_params.uf_doc(label="table: N-state parameter value
setting"))
-uf.desc.append(relax_disp_uf.set_doc)
uf.desc.append(relax_disp_params.uf_doc(label="table: dispersion parameter
value setting"))
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
r22743 - in /trunk: specific_analyses/relax_disp/parameter_object.py specific_analyses/relax_disp/uf.py user_functions/value.py