Author: bugman
Date: Thu Sep 25 09:14:30 2014
New Revision: 26024
URL: http://svn.gna.org/viewcvs/relax?rev=26024&view=rev
Log:
Additions to the frame order auto-analysis documentation.
Modified:
branches/frame_order_cleanup/auto_analyses/frame_order.py
Modified: branches/frame_order_cleanup/auto_analyses/frame_order.py
URL:
http://svn.gna.org/viewcvs/relax/branches/frame_order_cleanup/auto_analyses/frame_order.py?rev=26024&r1=26023&r2=26024&view=diff
==============================================================================
--- branches/frame_order_cleanup/auto_analyses/frame_order.py (original)
+++ branches/frame_order_cleanup/auto_analyses/frame_order.py Thu Sep 25
09:14:30 2014
@@ -20,7 +20,19 @@
###############################################################################
# Module docstring.
-"""The full frame order analysis.
+"""The automated frame order analysis protocol.
+
+
+Usage
+=====
+
+To use this analysis, you should import the following into your script:
+
+ - Frame_order_analysis: This is a Python class which contains the
automated protocol. Initialising the class will execute the full analysis.
See its documentation for all the options it accepts.
+ - Optimisation_settings: This is a Python class which is used to set up
and store the optimisation settings used in the automated protocol. This
allows for grid searches, zooming grid searches, minimisation settings,
quasi-random Sobol' numerical integration of the PCS, and SciPy quadratic
numerical integration of the PCS to be specified.
+
+See the sample scripts for examples of how these are used.
+
The nested model parameter copying protocol
_______________________________________________
relax (http://www.nmr-relax.com)
This is the relax-commits mailing list
[email protected]
To unsubscribe from this list, get a password
reminder, or change your subscription options,
visit the list information page at
https://mail.gna.org/listinfo/relax-commits
