Author: bugman
Date: Sat Feb 2 15:16:43 2013
New Revision: 18387
URL: http://svn.gna.org/viewcvs/relax?rev=18387&view=rev
Log:
Merged revisions 18383-18386 via svnmerge from
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/trunk
........
r18383 | bugman | 2013-02-02 11:08:19 +0100 (Sat, 02 Feb 2013) | 5 lines
Epydoc documentation fix - a circular import in the GUI code paths has been
broken.
This affects the API documentation at http://www.nmr-relax.com/api/.
........
r18384 | bugman | 2013-02-02 11:34:15 +0100 (Sat, 02 Feb 2013) | 3 lines
Docstring fix for the maths_fns.vectors.random_unit_vector() function.
........
r18385 | bugman | 2013-02-02 11:44:10 +0100 (Sat, 02 Feb 2013) | 5 lines
Epydoc docstring fix for the dfunc_standard() N-state model target function.
This is for the API documentation (http://www.nmr-relax.com/api/).
........
r18386 | bugman | 2013-02-02 11:58:42 +0100 (Sat, 02 Feb 2013) | 3 lines
Epydoc docstring fixes for the diffusion tensor objects of the relax data
store.
........
Modified:
branches/frame_order_testing/ (props changed)
branches/frame_order_testing/data/diff_tensor.py
branches/frame_order_testing/gui/__init__.py
branches/frame_order_testing/maths_fns/n_state_model.py
branches/frame_order_testing/maths_fns/vectors.py
Propchange: branches/frame_order_testing/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Sat Feb 2 15:16:43 2013
@@ -1,1 +1,1 @@
-/trunk:1-18377
+/trunk:1-18386
Modified: branches/frame_order_testing/data/diff_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/branches/frame_order_testing/data/diff_tensor.py?rev=18387&r1=18386&r2=18387&view=diff
==============================================================================
--- branches/frame_order_testing/data/diff_tensor.py (original)
+++ branches/frame_order_testing/data/diff_tensor.py Sat Feb 2 15:16:43 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).
#
#
#
@@ -320,18 +320,8 @@
= | Dx_unit[1] Dy_unit[1] Dz_unit[1] |.
| Dx_unit[2] Dy_unit[2] Dz_unit[2] |
- @param args: All the function arguments.
+ @param args: All the function arguments. For the spheroid, this
includes the spheroid_type (str), the azimuthal angle theta in radians
(float), and the polar angle phi in radians (float). For the ellipsoid, this
includes the Dx unit vector (numpy 3D, rank-1 array), the Dy unit vector
(numpy 3D, rank-1 array), and the Dz unit vector (numpy 3D, rank-1 array).
@type args: tuple
- @param theta: The azimuthal angle in radians.
- @type theta: float
- @param phi: The polar angle in radians.
- @type phi: float
- @param Dx_unit: The Dx unit vector.
- @type Dx_unit: numpy array
- @param Dy_unit: The Dy unit vector.
- @type Dy_unit: numpy array
- @param Dz_unit: The Dz unit vector.
- @type Dz_unit: numpy array
@return: The rotation matrix.
@rtype: numpy 3x3 array
"""
@@ -457,20 +447,8 @@
tensor = | 0 Dy 0 |.
| 0 0 Dz |
- @param args: All the arguments.
+ @param args: All the arguments. For the sphere, this includes the
Diso parameter (float). For the spheroid, this includes Dpar and Dper
parameters (floats). For the ellipsoid, this includes the Dx, Dy, and Dz
parameters (floats).
@type args: tuple
- @param Diso: The Diso parameter of the sphere.
- @type Diso: float
- @param Dpar: The Dpar parameter of the spheroid.
- @type Dpar: float
- @param Dper: The Dper parameter of the spheroid.
- @type Dper: float
- @param Dx: The Dx parameter of the ellipsoid.
- @type Dx: float
- @param Dy: The Dy parameter of the ellipsoid.
- @type Dy: float
- @param Dz: The Dz parameter of the ellipsoid.
- @type Dz: float
@return: The diagonalised diffusion tensor.
@rtype: numpy 3x3 array
"""
Modified: branches/frame_order_testing/gui/__init__.py
URL:
http://svn.gna.org/viewcvs/relax/branches/frame_order_testing/gui/__init__.py?rev=18387&r1=18386&r2=18387&view=diff
==============================================================================
--- branches/frame_order_testing/gui/__init__.py (original)
+++ branches/frame_order_testing/gui/__init__.py Sat Feb 2 15:16:43 2013
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2009-2011 Edward d'Auvergne
#
+# Copyright (C) 2009-2013 Edward d'Auvergne
#
#
#
# This file is part of the program relax (http://www.nmr-relax.com).
#
#
#
@@ -41,7 +41,6 @@
from status import Status; status = Status()
# relax GUI module imports.
-from gui import relax_gui
from gui.uf_objects import Uf_storage; uf_store = Uf_storage()
@@ -99,6 +98,9 @@
# Show the splash screen.
self.show_splash()
+ # Import here to break a circular import which is killing Epydoc!
+ from gui import relax_gui
+
# Build the GUI.
self.gui = relax_gui.Main(parent=None, id=-1, title="")
Modified: branches/frame_order_testing/maths_fns/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/branches/frame_order_testing/maths_fns/n_state_model.py?rev=18387&r1=18386&r2=18387&view=diff
==============================================================================
--- branches/frame_order_testing/maths_fns/n_state_model.py (original)
+++ branches/frame_order_testing/maths_fns/n_state_model.py Sat Feb 2
15:16:43 2013
@@ -833,7 +833,7 @@
dxi /__ \ dxi dxi
dxi /
c=1
- where xi are the paramagnetic position coordinates {x0, x1, x2} and
the last two terms in the sum are equal due to the symmetry of the alignment
tensor, and:
+ where xi are the paramagnetic position coordinates {x0, x1, x2} and
the last two terms in the sum are equal due to the symmetry of the alignment
tensor, and::
ddjc mu0 15kT 5 (si - xi)
---- = --- ----- ---------------------------------------------
,
Modified: branches/frame_order_testing/maths_fns/vectors.py
URL:
http://svn.gna.org/viewcvs/relax/branches/frame_order_testing/maths_fns/vectors.py?rev=18387&r1=18386&r2=18387&view=diff
==============================================================================
--- branches/frame_order_testing/maths_fns/vectors.py (original)
+++ branches/frame_order_testing/maths_fns/vectors.py Sat Feb 2 15:16:43 2013
@@ -32,8 +32,8 @@
Uniform point sampling on a unit sphere is used to generate a random
axis orientation.
- @param axis: The 3D rotation axis.
- @type axis: numpy array, len 3
+ @param vector: The 3D rotation axis.
+ @type vector: numpy 3D, rank-1 array
"""
# Random azimuthal angle.
r18387 - in /branches/frame_order_testing: ./ data/ gui/ maths_fns/