Author: bugman
Date: Thu Jan 3 13:59:44 2008
New Revision: 4267
URL: http://svn.gna.org/viewcvs/relax?rev=4267&view=rev
Log:
Fixed some docstring indentation.
8 spaces of indentation were used in a few functions to make these line up
with the user function
docstrings when appended to them.
Modified:
1.3/generic_fns/diffusion_tensor.py
Modified: 1.3/generic_fns/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/diffusion_tensor.py?rev=4267&r1=4266&r2=4267&view=diff
==============================================================================
--- 1.3/generic_fns/diffusion_tensor.py (original)
+++ 1.3/generic_fns/diffusion_tensor.py Thu Jan 3 13:59:44 2008
@@ -79,46 +79,46 @@
def default_value(param):
"""
- Diffusion tensor parameter default values
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- ________________________________________________________________________
- | | | |
- | Data type | Object name | Value |
- |________________________|____________________|________________________|
- | | | |
- | tm | 'tm' | 10 * 1e-9 |
- | | | |
- | Diso | 'Diso' | 1.666 * 1e7 |
- | | | |
- | Da | 'Da' | 0.0 |
- | | | |
- | Dr | 'Dr' | 0.0 |
- | | | |
- | Dx | 'Dx' | 1.666 * 1e7 |
- | | | |
- | Dy | 'Dy' | 1.666 * 1e7 |
- | | | |
- | Dz | 'Dz' | 1.666 * 1e7 |
- | | | |
- | Dpar | 'Dpar' | 1.666 * 1e7 |
- | | | |
- | Dper | 'Dper' | 1.666 * 1e7 |
- | | | |
- | Dratio | 'Dratio' | 1.0 |
- | | | |
- | alpha | 'alpha' | 0.0 |
- | | | |
- | beta | 'beta' | 0.0 |
- | | | |
- | gamma | 'gamma' | 0.0 |
- | | | |
- | theta | 'theta' | 0.0 |
- | | | |
- | phi | 'phi' | 0.0 |
- |________________________|____________________|________________________|
-
- """
+ Diffusion tensor parameter default values
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
________________________________________________________________________
+ | | |
|
+ | Data type | Object name | Value
|
+
|________________________|____________________|________________________|
+ | | |
|
+ | tm | 'tm' | 10 * 1e-9
|
+ | | |
|
+ | Diso | 'Diso' | 1.666 * 1e7
|
+ | | |
|
+ | Da | 'Da' | 0.0
|
+ | | |
|
+ | Dr | 'Dr' | 0.0
|
+ | | |
|
+ | Dx | 'Dx' | 1.666 * 1e7
|
+ | | |
|
+ | Dy | 'Dy' | 1.666 * 1e7
|
+ | | |
|
+ | Dz | 'Dz' | 1.666 * 1e7
|
+ | | |
|
+ | Dpar | 'Dpar' | 1.666 * 1e7
|
+ | | |
|
+ | Dper | 'Dper' | 1.666 * 1e7
|
+ | | |
|
+ | Dratio | 'Dratio' | 1.0
|
+ | | |
|
+ | alpha | 'alpha' | 0.0
|
+ | | |
|
+ | beta | 'beta' | 0.0
|
+ | | |
|
+ | gamma | 'gamma' | 0.0
|
+ | | |
|
+ | theta | 'theta' | 0.0
|
+ | | |
|
+ | phi | 'phi' | 0.0
|
+
|________________________|____________________|________________________|
+
+ """ # This docstring is to be joined onto those of the user
functions, hence the 8 whitespace characters.
# tm.
if param == 'tm':
@@ -864,46 +864,46 @@
def set(value=None, param=None):
"""
- Diffusion tensor set details
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- If the diffusion tensor has not been setup, use the more powerful
function
- 'diffusion_tensor.init' to initialise the tensor parameters. This
function cannot be used to
- initialise a diffusion tensor.
-
- The units of the parameters are:
-
- Inverse seconds for tm.
- Seconds for Diso, Da, Dx, Dy, Dz, Dpar, Dper.
- Unitless for Dratio and Dr.
- Radians for all angles (alpha, beta, gamma, theta, phi).
-
- When setting a diffusion tensor parameter, the residue number has no
effect. As the
- internal parameters of spherical diffusion are {tm}, spheroidal
diffusion are {tm, Da,
- theta, phi}, and ellipsoidal diffusion are {tm, Da, Dr, alpha, beta,
gamma}, supplying
- geometric parameters must be done in the following way. If a single
geometric parameter is
- supplied, it must be one of tm, Diso, Da, Dr, or Dratio. For the
parameters Dpar, Dper, Dx,
- Dy, and Dx, it is not possible to determine how to use the currently set
values together
- with the supplied value to calculate the new internal parameters. For
spheroidal diffusion,
- when supplying multiple geometric parameters, the set must belong to one
of
-
- {tm, Da},
- {Diso, Da},
- {tm, Dratio},
- {Dpar, Dper},
- {Diso, Dratio},
-
- where either theta, phi, or both orientational parameters can be
additionally supplied. For
- ellipsoidal diffusion, again when supplying multiple geometric
parameters, the set must
- belong to one of
-
- {tm, Da, Dr},
- {Diso, Da, Dr},
- {Dx, Dy, Dz},
-
- where any number of the orientational parameters, alpha, beta, or gamma
can be additionally
- supplied.
- """
+ Diffusion tensor set details
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ If the diffusion tensor has not been setup, use the more powerful
function
+ 'diffusion_tensor.init' to initialise the tensor parameters. This
function cannot be used
+ to initialise a diffusion tensor.
+
+ The units of the parameters are:
+
+ Inverse seconds for tm.
+ Seconds for Diso, Da, Dx, Dy, Dz, Dpar, Dper.
+ Unitless for Dratio and Dr.
+ Radians for all angles (alpha, beta, gamma, theta, phi).
+
+ When setting a diffusion tensor parameter, the residue number has no
effect. As the
+ internal parameters of spherical diffusion are {tm}, spheroidal
diffusion are {tm, Da,
+ theta, phi}, and ellipsoidal diffusion are {tm, Da, Dr, alpha, beta,
gamma}, supplying
+ geometric parameters must be done in the following way. If a single
geometric parameter is
+ supplied, it must be one of tm, Diso, Da, Dr, or Dratio. For the
parameters Dpar, Dper, Dx,
+ Dy, and Dx, it is not possible to determine how to use the currently
set values together
+ with the supplied value to calculate the new internal parameters.
For spheroidal diffusion,
+ when supplying multiple geometric parameters, the set must belong to
one of
+
+ {tm, Da},
+ {Diso, Da},
+ {tm, Dratio},
+ {Dpar, Dper},
+ {Diso, Dratio},
+
+ where either theta, phi, or both orientational parameters can be
additionally supplied. For
+ ellipsoidal diffusion, again when supplying multiple geometric
parameters, the set must
+ belong to one of
+
+ {tm, Da, Dr},
+ {Diso, Da, Dr},
+ {Dx, Dy, Dz},
+
+ where any number of the orientational parameters, alpha, beta, or
gamma can be additionally
+ supplied.
+ """ # This docstring is to be joined onto those of the user
functions, hence the 8 whitespace characters.
# Alias the current data pipe.
cdp = relax_data_store[relax_data_store.current_pipe]
r4267 - /1.3/generic_fns/diffusion_tensor.py