Author: bugman
Date: Sat Jul 5 13:42:13 2008
New Revision: 6742
URL: http://svn.gna.org/viewcvs/relax?rev=6742&view=rev
Log:
Module docsting updates in the generic_fns package.
All missing module docstrings were created, the current ones modified, and
the copyright notices
updated.
Modified:
1.3/generic_fns/align_tensor.py
1.3/generic_fns/angles.py
1.3/generic_fns/dasha.py
1.3/generic_fns/diffusion_tensor.py
1.3/generic_fns/fix.py
1.3/generic_fns/grace.py
1.3/generic_fns/minimise.py
1.3/generic_fns/model_selection.py
1.3/generic_fns/molmol.py
1.3/generic_fns/palmer.py
1.3/generic_fns/pipes.py
1.3/generic_fns/pymol.py
1.3/generic_fns/results.py
1.3/generic_fns/selection.py
1.3/generic_fns/sequence.py
1.3/generic_fns/state.py
1.3/generic_fns/value.py
1.3/generic_fns/vmd.py
Modified: 1.3/generic_fns/align_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/align_tensor.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/align_tensor.py (original)
+++ 1.3/generic_fns/align_tensor.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module containing functions for the handling of alignment tensors."""
# Python module imports.
from copy import deepcopy
Modified: 1.3/generic_fns/angles.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/angles.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/angles.py (original)
+++ 1.3/generic_fns/angles.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for the manipulation of angular information."""
# Python module imports.
from math import acos, sin
Modified: 1.3/generic_fns/dasha.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/dasha.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/dasha.py (original)
+++ 1.3/generic_fns/dasha.py Sat Jul 5 13:42:13 2008
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2005-2007 Edward d'Auvergne
#
+# Copyright (C) 2005-2008 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for interfacing with Dasha."""
# Python module imports.
from math import pi
Modified: 1.3/generic_fns/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/diffusion_tensor.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/diffusion_tensor.py (original)
+++ 1.3/generic_fns/diffusion_tensor.py Sat Jul 5 13:42:13 2008
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2007 Edward d'Auvergne
#
+# Copyright (C) 2003-2008 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for the support of diffusion tensors."""
# Python module imports.
from copy import deepcopy
Modified: 1.3/generic_fns/fix.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/fix.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/fix.py (original)
+++ 1.3/generic_fns/fix.py Sat Jul 5 13:42:13 2008
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2004, 2007 Edward d'Auvergne
#
+# Copyright (C) 2003-2004, 2007-2008 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for holding certain model components fixed during optimisation."""
# Python module imports.
from re import match
Modified: 1.3/generic_fns/grace.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/grace.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/grace.py (original)
+++ 1.3/generic_fns/grace.py Sat Jul 5 13:42:13 2008
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2007 Edward d'Auvergne
#
+# Copyright (C) 2003-2008 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -20,6 +20,9 @@
#
#
###############################################################################
+# Module docstring.
+"""Module for interfacing with Grace (also known as Xmgrace, Xmgr, and
ace)."""
+
# Python module imports.
from numpy import array
from os import system
Modified: 1.3/generic_fns/minimise.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/minimise.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/minimise.py (original)
+++ 1.3/generic_fns/minimise.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for model minimisation/optimisation."""
# Python module imports.
from re import search
Modified: 1.3/generic_fns/model_selection.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/model_selection.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/model_selection.py (original)
+++ 1.3/generic_fns/model_selection.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for selecting the best model."""
# Python module imports.
from math import log
Modified: 1.3/generic_fns/molmol.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/molmol.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/molmol.py (original)
+++ 1.3/generic_fns/molmol.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for interfacing with Molmol."""
# Python module imports.
from os import popen
Modified: 1.3/generic_fns/palmer.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/palmer.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/palmer.py (original)
+++ 1.3/generic_fns/palmer.py Sat Jul 5 13:42:13 2008
@@ -21,7 +21,7 @@
###############################################################################
# Module docstring.
-"""Module for creating and processing input and output for Art Palmer's
Modelfree 4 program."""
+"""Module for interfacing with Art Palmer's Modelfree 4 program."""
# Python module imports.
Modified: 1.3/generic_fns/pipes.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pipes.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/pipes.py (original)
+++ 1.3/generic_fns/pipes.py Sat Jul 5 13:42:13 2008
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004, 2006-2007 Edward d'Auvergne
#
+# Copyright (C) 2004, 2006-2008 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
Modified: 1.3/generic_fns/pymol.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pymol.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/pymol.py (original)
+++ 1.3/generic_fns/pymol.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for interfacing with PyMOL."""
# Python module imports.
from os import popen
Modified: 1.3/generic_fns/results.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/results.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/results.py (original)
+++ 1.3/generic_fns/results.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for reading/writing/displaying the results in a data pipe."""
# Python module imports.
from re import search
Modified: 1.3/generic_fns/selection.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/selection.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/selection.py (original)
+++ 1.3/generic_fns/selection.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for selecting and deselecting spins."""
# Python module imports
from warnings import warn
Modified: 1.3/generic_fns/sequence.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/sequence.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/sequence.py (original)
+++ 1.3/generic_fns/sequence.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for handling the molecule, residue, and spin sequence."""
# Python module imports.
from copy import deepcopy
Modified: 1.3/generic_fns/state.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/state.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/state.py (original)
+++ 1.3/generic_fns/state.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for reading and writing the relax program state."""
# Python module imports.
from cPickle import dump, load
Modified: 1.3/generic_fns/value.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/value.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/value.py (original)
+++ 1.3/generic_fns/value.py Sat Jul 5 13:42:13 2008
@@ -20,6 +20,9 @@
#
#
###############################################################################
+# Module docstring.
+"""Module for the manipulation of parameter and constant values."""
+
# Python module imports.
from numpy import ndarray, zeros
from re import compile, match
Modified: 1.3/generic_fns/vmd.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/vmd.py?rev=6742&r1=6741&r2=6742&view=diff
==============================================================================
--- 1.3/generic_fns/vmd.py (original)
+++ 1.3/generic_fns/vmd.py Sat Jul 5 13:42:13 2008
@@ -19,6 +19,9 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
#
###############################################################################
+
+# Module docstring.
+"""Module for interfacing with VMD."""
# Python module imports.
module_avail = False
r6742 - /1.3/generic_fns/