r4869 - /branches/N_state_model/specific_fns/n_state_model.py -- January 21, 2008 - 14:56

Author: bugman
Date: Mon Jan 21 14:56:02 2008
New Revision: 4869

URL: http://svn.gna.org/viewcvs/relax?rev=4869&view=rev
Log:
Wrote the N-state model set_doc() method (which is just a docstring for the 
user functions).


Modified:
    branches/N_state_model/specific_fns/n_state_model.py

Modified: branches/N_state_model/specific_fns/n_state_model.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/N_state_model/specific_fns/n_state_model.py?rev=4869&r1=4868&r2=4869&view=diff
==============================================================================
--- branches/N_state_model/specific_fns/n_state_model.py (original)
+++ branches/N_state_model/specific_fns/n_state_model.py Mon Jan 21 14:56:02 
2008
@@ -538,6 +538,20 @@
             return 'csa'
 
 
+    def set_doc(self):
+        """
+        N-state model set details
+        ~~~~~~~~~~~~~~~~~~~~~~~~~
+
+        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 added to the end of the parameter name. 
 So the Euler angle
+        gamma of the third state is specified using the string 'gamma2'.
+        """
+        __docformat__ = "plaintext"
+
+
     def set_domain(self, tensor=None, domain=None):
         """Set the domain label for the given tensor.