r18010 - /branches/frame_order_testing/auto_analyses/frame_order.py -- November 20, 2012 - 11:10

Author: bugman
Date: Tue Nov 20 11:10:56 2012
New Revision: 18010

URL: http://svn.gna.org/viewcvs/relax?rev=18010&view=rev
Log:
Added a basic class docstring for the frame order auto-analysis.


Modified:
    branches/frame_order_testing/auto_analyses/frame_order.py

Modified: branches/frame_order_testing/auto_analyses/frame_order.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/frame_order_testing/auto_analyses/frame_order.py?rev=18010&r1=18009&r2=18010&view=diff
==============================================================================
--- branches/frame_order_testing/auto_analyses/frame_order.py (original)
+++ branches/frame_order_testing/auto_analyses/frame_order.py Tue Nov 20 
11:10:56 2012
@@ -42,6 +42,8 @@
 
 
 class Frame_order_analysis:
+    """The frame order auto-analysis protocol."""
+
     def __init__(self, data_pipe_full=None, data_pipe_subset=None, 
pipe_bundle=None, results_dir=None, grid_inc=11, grid_inc_rigid=21, 
min_algor='simplex', num_int_pts_grid=50, num_int_pts_subset=[20, 100], 
func_tol_subset=[1e-2, 1e-2], num_int_pts_full=[100, 1000, 200000], 
func_tol_full=[1e-2, 1e-3, 1e-4], mc_sim_num=500, mc_int_pts=1000, 
mc_func_tol=1e-3):
         """Perform the full frame order analysis.