Author: bugman
Date: Sat Feb 2 15:56:54 2013
New Revision: 18389
URL: http://svn.gna.org/viewcvs/relax?rev=18389&view=rev
Log:
Added and edited a number of module docstrings.
Modified:
trunk/specific_fns/consistency_tests.py
trunk/specific_fns/frame_order.py
trunk/specific_fns/hybrid.py
trunk/specific_fns/jw_mapping.py
trunk/specific_fns/model_free/__init__.py
trunk/specific_fns/n_state_model.py
trunk/specific_fns/noe/__init__.py
trunk/specific_fns/relax_fit.py
trunk/specific_fns/setup.py
trunk/user_functions/reset.py
Modified: trunk/specific_fns/consistency_tests.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/consistency_tests.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/consistency_tests.py (original)
+++ trunk/specific_fns/consistency_tests.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004-2012 Edward d'Auvergne
#
+# Copyright (C) 2004-2013 Edward d'Auvergne
#
# Copyright (C) 2007-2009 Sebastien Morin
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
@@ -19,6 +19,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""The consistency testing analysis of multi-field relaxation data specific
code."""
# Python module imports.
from re import search
Modified: trunk/specific_fns/frame_order.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/frame_order.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/frame_order.py (original)
+++ trunk/specific_fns/frame_order.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2009-2012 Edward d'Auvergne
#
+# Copyright (C) 2009-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""Module for the specific methods of the Frame Order theories."""
+"""The Frame Order analysis of domain dynamics specific code."""
# Python module imports.
from copy import deepcopy
Modified: trunk/specific_fns/hybrid.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/hybrid.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/hybrid.py (original)
+++ trunk/specific_fns/hybrid.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2006-2012 Edward d'Auvergne
#
+# Copyright (C) 2006-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -18,6 +18,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""A specific analysis type allowing analyses of different data pipes to be
hybridised."""
# Python module imports.
from warnings import warn
Modified: trunk/specific_fns/jw_mapping.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/jw_mapping.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/jw_mapping.py (original)
+++ trunk/specific_fns/jw_mapping.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004-2012 Edward d'Auvergne
#
+# Copyright (C) 2004-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -18,6 +18,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""The reduced spectral density mapping analysis specific code."""
# Python module imports.
from re import search
Modified: trunk/specific_fns/model_free/__init__.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/model_free/__init__.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/model_free/__init__.py (original)
+++ trunk/specific_fns/model_free/__init__.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2012 Edward d'Auvergne
#
+# Copyright (C) 2007-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""The model-free specific code."""
+"""The Lipari-Szabo model-free analysis specific code."""
# The available modules.
Modified: trunk/specific_fns/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/n_state_model.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/n_state_model.py (original)
+++ trunk/specific_fns/n_state_model.py Sat Feb 2 15:56:54 2013
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""Module for the specific analysis of the N-state dynamic model."""
+"""The N-state model or ensemble analysis specific code."""
# Python module imports.
from copy import deepcopy
Modified: trunk/specific_fns/noe/__init__.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/noe/__init__.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/noe/__init__.py (original)
+++ trunk/specific_fns/noe/__init__.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007-2012 Edward d'Auvergne
#
+# Copyright (C) 2007-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""The NOE specific code."""
+"""The steady-state heteronuclear NOE analysis specific code."""
# The available modules.
Modified: trunk/specific_fns/relax_fit.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/relax_fit.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/relax_fit.py (original)
+++ trunk/specific_fns/relax_fit.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004-2012 Edward d'Auvergne
#
+# Copyright (C) 2004-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -20,7 +20,7 @@
###############################################################################
# Module docstring.
-"""The relaxation curve fitting specific code."""
+"""The R1 and R2 exponential relaxation curve fitting analysis specific
code."""
# Python module imports.
from minfx.generic import generic_minimise
Modified: trunk/specific_fns/setup.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_fns/setup.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/specific_fns/setup.py (original)
+++ trunk/specific_fns/setup.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004, 2006-2011 Edward d'Auvergne
#
+# Copyright (C) 2004-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -18,6 +18,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for handling the setup of the specific analyses."""
# relax module imports.
from generic_fns import pipes
Modified: trunk/user_functions/reset.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/reset.py?rev=18389&r1=18388&r2=18389&view=diff
==============================================================================
--- trunk/user_functions/reset.py (original)
+++ trunk/user_functions/reset.py Sat Feb 2 15:56:54 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2012 Edward d'Auvergne
#
+# Copyright (C) 2003-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -18,6 +18,9 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
#
###############################################################################
+
+# Module docstring.
+"""The reset user function definitions."""
# relax module imports.
import generic_fns.reset
r18389 - in /trunk: specific_fns/ specific_fns/model_free/ specific_fns/noe/ user_functions/