Author: bugman
Date: Wed Jan 27 13:42:02 2010
New Revision: 10435
URL: http://svn.gna.org/viewcvs/relax?rev=10435&view=rev
Log:
Epydoc fixes throughout the test suite.
Modified:
1.3/test_suite/system_tests/model_free.py
1.3/test_suite/system_tests/n_state_model.py
1.3/test_suite/unit_tests/_data/test_align_tensor.py
1.3/test_suite/unit_tests/_data/test_diff_tensor.py
1.3/test_suite/unit_tests/_maths_fns/test_chi2.py
Modified: 1.3/test_suite/system_tests/model_free.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/system_tests/model_free.py?rev=10435&r1=10434&r2=10435&view=diff
==============================================================================
--- 1.3/test_suite/system_tests/model_free.py (original)
+++ 1.3/test_suite/system_tests/model_free.py Wed Jan 27 13:42:02 2010
@@ -300,14 +300,14 @@
"""Constrained BFGS opt, backtracking line search {S2=0.970,
te=2048, Rex=0.149}
The optimisation options are:
- BFGS optimisation.
- Backtracking line search.
- Constrained.
+ - BFGS optimisation.
+ - Backtracking line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -467,14 +467,14 @@
"""Constrained BFGS opt, More and Thuente line search {S2=0.970,
te=2048, Rex=0.149}
The optimisation options are:
- BFGS optimisation.
- More and Thuente line search.
- Constrained.
+ - BFGS optimisation.
+ - More and Thuente line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -629,14 +629,14 @@
"""Constrained coordinate descent opt, backtracking line search
{S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Coordinate descent optimisation.
- Backtracking line search.
- Constrained.
+ - Coordinate descent optimisation.
+ - Backtracking line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -698,14 +698,14 @@
"""Constrained coordinate descent opt, More and Thuente line search
{S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Coordinate descent optimisation.
- More and Thuente line search.
- Constrained.
+ - Coordinate descent optimisation.
+ - More and Thuente line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -816,15 +816,15 @@
"""Constrained Newton opt, GMW Hessian mod, backtracking line search
{S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Newton optimisation.
- GMW Hessian modification.
- Backtracking line search.
- Constrained.
+ - Newton optimisation.
+ - GMW Hessian modification.
+ - Backtracking line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -935,15 +935,15 @@
"""Constrained Newton opt, GMW Hessian mod, More and Thuente line
search {S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Newton optimisation.
- GMW Hessian modification.
- More and Thuente line search.
- Constrained.
+ - Newton optimisation.
+ - GMW Hessian modification.
+ - More and Thuente line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -1087,14 +1087,14 @@
"""Constrained steepest descent opt, backtracking line search
{S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Steepest descent optimisation.
- Backtracking line search.
- Constrained.
+ - Steepest descent optimisation.
+ - Backtracking line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -1156,14 +1156,14 @@
"""Constrained steepest descent opt, More and Thuente line search
{S2=0.970, te=2048, Rex=0.149}
The optimisation options are:
- Steepest descent optimisation.
- More and Thuente line search.
- Constrained.
+ - Steepest descent optimisation.
+ - More and Thuente line search.
+ - Constrained.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
@@ -1225,12 +1225,12 @@
"""Constrained grid search {S2=0.970, te=2048, Rex=0.149}.
The optimisation options are:
- Constrained grid search.
+ - Constrained grid search.
The true data set is:
- S2 = 0.970
- te = 2048 ps
- Rex = 0.149 s^-1
+ - S2 = 0.970
+ - te = 2048 ps
+ - Rex = 0.149 s^-1
"""
# Setup the data pipe for optimisation.
Modified: 1.3/test_suite/system_tests/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/system_tests/n_state_model.py?rev=10435&r1=10434&r2=10435&view=diff
==============================================================================
--- 1.3/test_suite/system_tests/n_state_model.py (original)
+++ 1.3/test_suite/system_tests/n_state_model.py Wed Jan 27 13:42:02 2010
@@ -43,11 +43,11 @@
"""A 5-state model in the xz-plane (no pivotting of alpha).
The 5 states correspond to the Euler angles (z-y-z notation):
- State 1: {0, pi/4, 0}
- State 2: {0, pi/8, 0}
- State 3: {0, 0, 0}
- State 4: {0, -pi/8, 0}
- State 5: {0, -pi/4, 0}
+ - State 1: {0, pi/4, 0}
+ - State 2: {0, pi/8, 0}
+ - State 3: {0, 0, 0}
+ - State 4: {0, -pi/8, 0}
+ - State 5: {0, -pi/4, 0}
"""
# Execute the script.
Modified: 1.3/test_suite/unit_tests/_data/test_align_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/unit_tests/_data/test_align_tensor.py?rev=10435&r1=10434&r2=10435&view=diff
==============================================================================
--- 1.3/test_suite/unit_tests/_data/test_align_tensor.py (original)
+++ 1.3/test_suite/unit_tests/_data/test_align_tensor.py Wed Jan 27 13:42:02
2010
@@ -59,11 +59,11 @@
"""Test the appending of Monte Carlo simulation alignment tensor
parameters.
The following parameters will be appended to empty lists:
- Axx: -16.6278 Hz
- Ayy: 6.13037 Hz
- Axy: 7.65639 Hz
- Axz: -1.89157 Hz
- Ayz: 19.2561 Hz
+ - Axx: -16.6278 Hz
+ - Ayy: 6.13037 Hz
+ - Axy: 7.65639 Hz
+ - Axz: -1.89157 Hz
+ - Ayz: 19.2561 Hz
"""
# The MC sim parameter values.
@@ -119,11 +119,11 @@
"""Test the setting of spheroidal diffusion tensor parameter errors.
The following parameter errors will be set:
- Axx: 0.3 Hz
- Ayy: 0.5 Hz
- Axy: 0.4 Hz
- Axz: 0.1 Hz
- Ayz: 0.2 Hz
+ - Axx: 0.3 Hz
+ - Ayy: 0.5 Hz
+ - Axy: 0.4 Hz
+ - Axz: 0.1 Hz
+ - Ayz: 0.2 Hz
"""
# The parameter errors.
@@ -162,11 +162,11 @@
"""Test the setting of alignment tensor parameters.
The following parameters will be set:
- Axx: -16.6278 Hz
- Ayy: 6.13037 Hz
- Axy: 7.65639 Hz
- Axz: -1.89157 Hz
- Ayz: 19.2561 Hz
+ - Axx: -16.6278 Hz
+ - Ayy: 6.13037 Hz
+ - Axy: 7.65639 Hz
+ - Axz: -1.89157 Hz
+ - Ayz: 19.2561 Hz
"""
# The parameter values.
@@ -205,19 +205,19 @@
"""Test the setting of Monte Carlo simulation alignment tensor
parameters.
Firstly the following parameters will be appended to empty lists:
- Axx: -16.6278 Hz
- Ayy: 6.13037 Hz
- Axy: 7.65639 Hz
- Axz: -1.89157 Hz
- Ayz: 19.2561 Hz
+ - Axx: -16.6278 Hz
+ - Ayy: 6.13037 Hz
+ - Axy: 7.65639 Hz
+ - Axz: -1.89157 Hz
+ - Ayz: 19.2561 Hz
These MC sim values will then be explicity overwritten by setting
the first elements of the
lists to:
- Axx: 0.3 Hz
- Ayy: 0.5 Hz
- Axy: 0.4 Hz
- Axz: 0.1 Hz
- Ayz: 0.2 Hz
+ - Axx: 0.3 Hz
+ - Ayy: 0.5 Hz
+ - Axy: 0.4 Hz
+ - Axz: 0.1 Hz
+ - Ayz: 0.2 Hz
"""
# Set the MC sim alignment parameter lists.
Modified: 1.3/test_suite/unit_tests/_data/test_diff_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/unit_tests/_data/test_diff_tensor.py?rev=10435&r1=10434&r2=10435&view=diff
==============================================================================
--- 1.3/test_suite/unit_tests/_data/test_diff_tensor.py (original)
+++ 1.3/test_suite/unit_tests/_data/test_diff_tensor.py Wed Jan 27 13:42:02
2010
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007 Edward d'Auvergne
#
+# Copyright (C) 2007, 2010 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -68,10 +68,10 @@
"""Test the appending of Monte Carlo simulation spheroidal diffusion
tensor parameters.
The following parameters will be appended to empty lists:
- tm: 8 ns
- Da: -1e7
- theta: 150 degrees
- phi: 30 degrees
+ - tm: 8 ns
+ - Da: -1e7
+ - theta: 150 degrees
+ - phi: 30 degrees
"""
# The MC sim parameter values.
@@ -140,10 +140,10 @@
"""Test the setting of spheroidal diffusion tensor parameter errors.
The following parameter errors will be set:
- tm: 1 ns
- Da: 1e3
- theta: 3 degrees
- phi: 5 degrees
+ - tm: 1 ns
+ - Da: 1e3
+ - theta: 3 degrees
+ - phi: 5 degrees
"""
# The parameter errors.
@@ -185,10 +185,10 @@
"""Test the setting of spheroidal diffusion tensor parameters.
The following parameters will be set:
- tm: 20 ns
- Da: 2e6
- theta: 60 degrees
- phi: 290 degrees
+ - tm: 20 ns
+ - Da: 2e6
+ - theta: 60 degrees
+ - phi: 290 degrees
"""
# The parameter values.
@@ -235,17 +235,17 @@
"""Test the setting of Monte Carlo simulation spheroidal diffusion
tensor parameters.
Firstly the following parameters will be appended to empty lists:
- tm: 2 ns
- Da: 1e5
- theta: 0 degrees
- phi: 360 degrees
+ - tm: 2 ns
+ - Da: 1e5
+ - theta: 0 degrees
+ - phi: 360 degrees
These MC sim values will then be explicity overwritten by setting
the first elements of the
lists to:
- tm: 0.5 ns
- Da: 3e5
- theta: 2 degrees
- phi: 0 degrees
+ - tm: 0.5 ns
+ - Da: 3e5
+ - theta: 2 degrees
+ - phi: 0 degrees
"""
# Set the diffusion type.
Modified: 1.3/test_suite/unit_tests/_maths_fns/test_chi2.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/unit_tests/_maths_fns/test_chi2.py?rev=10435&r1=10434&r2=10435&view=diff
==============================================================================
--- 1.3/test_suite/unit_tests/_maths_fns/test_chi2.py (original)
+++ 1.3/test_suite/unit_tests/_maths_fns/test_chi2.py Wed Jan 27 13:42:02 2010
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2007 Edward d'Auvergne
#
+# Copyright (C) 2007, 2010 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -68,7 +68,7 @@
def test_chi2(self):
"""Unit test for the value returned by the chi2 function.
- The chi-squared value is 2.5 for the following data
+ The chi-squared value is 2.5 for the following data::
data = | 1.0 1.5 2.0 2.5 3.0 |,
@@ -90,7 +90,7 @@
def test_dchi2(self):
"""Unit test for the chi-squared gradient created by the dchi2
function.
- The chi-squared gradient is [0, 10] for the following data
+ The chi-squared gradient is [0, 10] for the following data::
data = | 1.0 1.5 2.0 2.5 3.0 |,
@@ -117,7 +117,7 @@
def test_dchi2_element(self):
"""Unit test for the chi-squared gradient created by the
dchi2_element function.
- The chi-squared gradient is [0, 10] for the following data
+ The chi-squared gradient is [0, 10] for the following data::
data = | 1.0 1.5 2.0 2.5 3.0 |,
@@ -144,7 +144,7 @@
def test_d2chi2(self):
"""Unit test for the chi-squared Hessian created by the d2chi2
function.
- For the data
+ For the data::
data = | 1.0 1.5 2.0 2.5 3.0 |,
@@ -161,7 +161,7 @@
errors = | 0.1 0.1 0.1 0.1 0.1 |,
- the chi-squared hessian is
+ the chi-squared hessian is::
Hessian = | 38.0 0.0 |
| 0.0 20.0 |.
@@ -184,7 +184,7 @@
def test_d2chi2_element(self):
"""Unit test for the chi-squared Hessian created by the
d2chi2_element function.
- For the data
+ For the data::
data = | 1.0 1.5 2.0 2.5 3.0 |,
@@ -201,7 +201,7 @@
errors = | 0.1 0.1 0.1 0.1 0.1 |,
- the chi-squared hessian is
+ the chi-squared hessian is::
Hessian = | 38.0 0.0 |
| 0.0 20.0 |.
r10435 - in /1.3/test_suite: system_tests/ unit_tests/_data/ unit_tests/_maths_fns/