r12509 - /branches/bmrb/generic_fns/bmrb.py -- February 02, 2011 - 18:25

Author: bugman
Date: Wed Feb  2 18:25:45 2011
New Revision: 12509

URL: http://svn.gna.org/viewcvs/relax?rev=12509&view=rev
Log:
The back-end of the bmrb.read() user function is now recognising the 
sample_conditions arg.


Modified:
    branches/bmrb/generic_fns/bmrb.py

Modified: branches/bmrb/generic_fns/bmrb.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/generic_fns/bmrb.py?rev=12509&r1=12508&r2=12509&view=diff
==============================================================================
--- branches/bmrb/generic_fns/bmrb.py (original)
+++ branches/bmrb/generic_fns/bmrb.py Wed Feb  2 18:25:45 2011
@@ -189,8 +189,18 @@
     return N
 
 
-def read(file=None, directory=None, version='3.1'):
-    """Read the contents of a BMRB NMR-STAR formatted file."""
+def read(file=None, directory=None, version=None, sample_conditions=None):
+    """Read the contents of a BMRB NMR-STAR formatted file.
+
+    @keyword file:              The name of the BMRB STAR formatted file.
+    @type file:                 str
+    @keyword directory:         The directory where the file is located.
+    @type directory:            None or str
+    @keyword version:           The BMRB version to force the reading.
+    @type version:              None or str
+    @keyword sample_conditions: The sample condition label to read.  Only 
one sample condition can be read per data pipe.
+    @type sample_conditions:    None or str
+    """
 
     # Test if bmrblib is installed.
     if not dep_check.bmrblib_module:
@@ -215,7 +225,7 @@
     read_function = specific_fns.setup.get_specific_fn('bmrb_read', 
ds[ds.current_pipe].pipe_type)
 
     # Read the results.
-    read_function(file_path, version=version)
+    read_function(file_path, version=version, 
sample_conditions=sample_conditions)
 
 
 def write(file=None, directory=None, version='3.1', force=False):