r22745 - in /trunk: specific_analyses/n_state_model/ user_functions/ -- April 14, 2014 - 18:15

Author: bugman
Date: Mon Apr 14 18:15:25 2014
New Revision: 22745

URL: http://svn.gna.org/viewcvs/relax?rev=22745&view=rev
Log:
The N-state model parameter setting documentation has been shifted into the 
parameter list object.


Modified:
    trunk/specific_analyses/n_state_model/parameter_object.py
    trunk/specific_analyses/n_state_model/uf.py
    trunk/user_functions/value.py

Modified: trunk/specific_analyses/n_state_model/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/parameter_object.py?rev=22745&r1=22744&r2=22745&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/parameter_object.py   (original)
+++ trunk/specific_analyses/n_state_model/parameter_object.py   Mon Apr 14 
18:15:25 2014
@@ -58,3 +58,7 @@
         self._set_uf_title("N-state model parameters")
         self._uf_param_table(label="table: N-state parameters", 
caption="N-state model parameters.", scope='global', type=True)
         self._uf_param_table(label="table: N-state parameter value setting", 
caption="N-state model parameter value setting.", scope='global', 
default=True, type=True)
+
+        # Value setting documentation.
+        for doc in self._uf_doc_loop(["table: N-state parameters", "table: 
N-state parameter value setting"]):
+            doc.add_paragraph("Setting parameters for the N-state model is a 
little different from the other type of analyses as each state has a set of 
parameters with the same names as the other states.  To set the parameters 
for a specific state c (ranging from 0 for the first to N-1 for the last, the 
number c should be given as the index argument.  So the Euler angle gamma of 
the third state is specified using the parameter name 'gamma' and index of 
2.")

Modified: trunk/specific_analyses/n_state_model/uf.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/uf.py?rev=22745&r1=22744&r2=22745&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/uf.py (original)
+++ trunk/specific_analyses/n_state_model/uf.py Mon Apr 14 18:15:25 2014
@@ -39,11 +39,6 @@
 from pipe_control.structure.mass import centre_of_mass
 from user_functions.data import Uf_tables; uf_tables = Uf_tables()
 from user_functions.objects import Desc_container
-
-
-# Value setting documentation.
-set_doc = Desc_container("N-state model set details")
-set_doc.add_paragraph("Setting parameters for the N-state model is a little 
different from the other type of analyses as each state has a set of 
parameters with the same names as the other states.  To set the parameters 
for a specific state c (ranging from 0 for the first to N-1 for the last, the 
number c should be given as the index argument.  So the Euler angle gamma of 
the third state is specified using the parameter name 'gamma' and index of 
2.")
 
 
 def CoM(pivot_point=None, centre=None):

Modified: trunk/user_functions/value.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22745&r1=22744&r2=22745&view=diff
==============================================================================
--- trunk/user_functions/value.py       (original)
+++ trunk/user_functions/value.py       Mon Apr 14 18:15:25 2014
@@ -101,7 +101,6 @@
 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_model_uf.set_doc)
 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"))
@@ -287,7 +286,6 @@
 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_model_uf.set_doc)
 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.
@@ -374,7 +372,6 @@
 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_model_uf.set_doc)
 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.