Author: bugman
Date: Fri Mar 28 10:26:23 2014
New Revision: 22576
URL: http://svn.gna.org/viewcvs/relax?rev=22576&view=rev
Log:
Shifted the NOE analysis specific user function documentation from the API
object to the uf module.
Modified:
trunk/specific_analyses/noe/api.py
trunk/specific_analyses/noe/uf.py
trunk/user_functions/grace.py
trunk/user_functions/value.py
Modified: trunk/specific_analyses/noe/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/noe/api.py?rev=22576&r1=22575&r2=22576&view=diff
==============================================================================
--- trunk/specific_analyses/noe/api.py (original)
+++ trunk/specific_analyses/noe/api.py Fri Mar 28 10:26:23 2014
@@ -33,8 +33,6 @@
from pipe_control.mol_res_spin import exists_mol_res_spin_data, spin_loop
from specific_analyses.api_base import API_base
from specific_analyses.api_common import API_common
-from user_functions.data import Uf_tables; uf_tables = Uf_tables()
-from user_functions.objects import Desc_container
class Noe(API_base, API_common):
@@ -187,15 +185,6 @@
raise RelaxError("All spins have been deselected.")
- return_data_name_doc = Desc_container("NOE calculation data type string
matching patterns")
- _table = uf_tables.add_table(label="table: NOE data type patterns",
caption="NOE data type string matching patterns.")
- _table.add_headings(["Data type", "Object name"])
- _table.add_row(["Reference intensity", "'ref'"])
- _table.add_row(["Saturated intensity", "'sat'"])
- _table.add_row(["NOE", "'noe'"])
- return_data_name_doc.add_table(_table.label)
-
-
def return_units(self, param):
"""Dummy function which returns None as the stats have no units.
Modified: trunk/specific_analyses/noe/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/noe/uf.py?rev=22576&r1=22575&r2=22576&view=diff
==============================================================================
--- trunk/specific_analyses/noe/uf.py (original)
+++ trunk/specific_analyses/noe/uf.py Fri Mar 28 10:26:23 2014
@@ -25,6 +25,18 @@
# relax module imports.
from lib.errors import RelaxError
from pipe_control import pipes
+from user_functions.data import Uf_tables; uf_tables = Uf_tables()
+from user_functions.objects import Desc_container
+
+
+# Default value documentation.
+return_data_name_doc = Desc_container("NOE calculation data type string
matching patterns")
+table = uf_tables.add_table(label="table: NOE data type patterns",
caption="NOE data type string matching patterns.")
+table.add_headings(["Data type", "Object name"])
+table.add_row(["Reference intensity", "'ref'"])
+table.add_row(["Saturated intensity", "'sat'"])
+table.add_row(["NOE", "'noe'"])
+return_data_name_doc.add_table(table.label)
def spectrum_type(spectrum_type=None, spectrum_id=None):
Modified: trunk/user_functions/grace.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/grace.py?rev=22576&r1=22575&r2=22576&view=diff
==============================================================================
--- trunk/user_functions/grace.py (original)
+++ trunk/user_functions/grace.py Fri Mar 28 10:26:23 2014
@@ -37,7 +37,7 @@
from specific_analyses.consistency_tests import uf as consistency_tests_uf
from specific_analyses.jw_mapping import uf as jw_mapping_uf
from specific_analyses.model_free import Model_free
-from specific_analyses.noe.api import Noe
+from specific_analyses.noe import uf as noe_uf
from specific_analyses.relax_disp.api import Relax_disp
from specific_analyses.relax_fit import uf as relax_fit_uf
from user_functions.data import Uf_info; uf_info = Uf_info()
@@ -192,7 +192,7 @@
uf.desc[-1].add_paragraph("Normalisation is only allowed for series type
data, for example the R2 exponential curves, and will be ignored for all
other data types. If the norm flag is set to True then the y-value of the
first point of the series will be set to 1. This normalisation is useful for
highlighting errors in the data sets.")
uf.desc.append(regexp_doc)
uf.desc.append(minimise.return_data_name_doc)
-uf.desc.append(Noe.return_data_name_doc)
+uf.desc.append(noe_uf.return_data_name_doc)
uf.desc.append(Relax_disp.return_data_name_doc)
uf.desc.append(relax_fit_uf.return_data_name_doc)
uf.desc.append(jw_mapping_uf.return_data_name_doc)
Modified: trunk/user_functions/value.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22576&r1=22575&r2=22576&view=diff
==============================================================================
--- trunk/user_functions/value.py (original)
+++ trunk/user_functions/value.py Fri Mar 28 10:26:23 2014
@@ -40,7 +40,7 @@
from specific_analyses.model_free import Model_free
from specific_analyses.relax_fit import uf as relax_fit_uf
from specific_analyses.n_state_model import N_state_model
-from specific_analyses.noe.api import Noe
+from specific_analyses.noe import uf as noe_uf
from specific_analyses.relax_disp.api import Relax_disp
from user_functions.data import Uf_info; uf_info = Uf_info()
from user_functions.data import Uf_tables; uf_tables = Uf_tables()
@@ -142,7 +142,7 @@
uf.desc.append(Model_free.write_doc)
uf.desc.append(jw_mapping_uf.return_data_name_doc)
uf.desc.append(consistency_tests_uf.return_data_name_doc)
-uf.desc.append(Noe.return_data_name_doc)
+uf.desc.append(noe_uf.return_data_name_doc)
uf.desc.append(relax_fit_uf.return_data_name_doc)
uf.desc.append(N_state_model.return_data_name_doc)
uf.desc.append(Relax_disp.return_data_name_doc)
@@ -480,7 +480,7 @@
uf.desc.append(Model_free.write_doc)
uf.desc.append(jw_mapping_uf.return_data_name_doc)
uf.desc.append(consistency_tests_uf.return_data_name_doc)
-uf.desc.append(Noe.return_data_name_doc)
+uf.desc.append(noe_uf.return_data_name_doc)
uf.desc.append(relax_fit_uf.return_data_name_doc)
uf.desc.append(N_state_model.return_data_name_doc)
uf.desc.append(Relax_disp.return_data_name_doc)
r22576 - in /trunk: specific_analyses/noe/api.py specific_analyses/noe/uf.py user_functions/grace.py user_functions/value.py