r9718 - in /branches/bmrb: data/exp_info.py generic_fns/bmrb.py -- October 09, 2009 - 21:39

Author: bugman
Date: Fri Oct  9 21:39:14 2009
New Revision: 9718

URL: http://svn.gna.org/viewcvs/relax?rev=9718&view=rev
Log:
More info is now being placed into the software containers of the 
experimental info container.


Modified:
    branches/bmrb/data/exp_info.py
    branches/bmrb/generic_fns/bmrb.py

Modified: branches/bmrb/data/exp_info.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/data/exp_info.py?rev=9718&r1=9717&r2=9718&view=diff
==============================================================================
--- branches/bmrb/data/exp_info.py (original)
+++ branches/bmrb/data/exp_info.py Fri Oct  9 21:39:14 2009
@@ -43,22 +43,27 @@
         self.blacklist = ['software']
 
 
-    def software_setup(self, name, url=None, version=None):
-        """Set up the software information."""
+    def software_setup(self, name, version=None, url=None, vendor_name=None, 
cite=None):
+        """Set up the software information.
+
+        @param name:            The name of the software program.
+        @type name:             str
+        @keyword version:       The program version.
+        @type version:          None or str
+        @keyword url:           The program's URL.
+        @type url:              None or str
+        @keyword vendor_name:   The name of the company or person behind the 
program.
+        @type vendor_name:      str
+        @keyword cite:          The literature citation.
+        @type cite:             None or str
+        """
 
         # Initialise the container if needed.
         if not hasattr(self, 'software'):
             self.software = SoftwareList()
 
         # Append a container.
-        self.software.append(Software())
-
-        # Set the attributes.
-        self.software[-1].name = name
-        if url:
-            self.software[-1].url = url
-        if version:
-            self.software[-1].version = version
+        self.software.append(Software(name, version=version, url=url, 
vendor_name=vendor_name, cite=cite))
 
 
 
@@ -79,8 +84,20 @@
 class Software(Element):
     """The individual software data container."""
 
-    def __init__(self):
-        """Initialise the data container."""
+    def __init__(self, name, version=None, url=None, vendor_name=None, 
cite=None):
+        """Initialise the data container.
+
+        @param name:            The name of the software program.
+        @type name:             str
+        @keyword version:       The program version.
+        @type version:          None or str
+        @keyword url:           The program's URL.
+        @type url:              None or str
+        @keyword vendor_name:   The name of the company or person behind the 
program.
+        @type vendor_name:      str
+        @keyword cite:          The literature citation.
+        @type cite:             None or str
+        """
 
         # The name of the container.
         self.element_name = 'software'
@@ -88,5 +105,17 @@
         # The description of the container.
         self.element_desc = 'Software program used in the analysis'
 
+        # Set the attributes.
+        self.name = name
+        if url:
+            self.url = url
+        if version:
+            self.version = version
+        if vendor_name:
+            self.vendor_name = vendor_name
+        if cite:
+            self.cite = cite
 
 
+
+

Modified: branches/bmrb/generic_fns/bmrb.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/generic_fns/bmrb.py?rev=9718&r1=9717&r2=9718&view=diff
==============================================================================
--- branches/bmrb/generic_fns/bmrb.py (original)
+++ branches/bmrb/generic_fns/bmrb.py Fri Oct  9 21:39:14 2009
@@ -79,7 +79,7 @@
     @param name:        The name of the software program.
     @type name:         str
     @keyword version:   The program version.
-    @type version:      str
+    @type version:      None or str
     """
 
     # Unknown program.
@@ -92,7 +92,7 @@
 
     # NMRPipe.
     if name == 'NMRPipe':
-        cdp.exp_info.software_setup('NMRPipe', version=version, 
url='http://spin.niddk.nih.gov/NMRPipe/')
+        cdp.exp_info.software_setup('NMRPipe', version=version, 
url="http://spin.niddk.nih.gov/NMRPipe/";, vendor_name="Delaglio, F.", 
cite="Delaglio, F., Grzesiek, S., Vuister, G. W., Zhu, G., Pfeifer, J., and 
Bax, A. (1995).  NMRPipe: a multidimensional spectral processing system based 
on UNIX pipes.  J. Biomol. NMR. 6, 277-293.")
 
     # Sparky.
     elif name == 'Sparky':
@@ -101,7 +101,8 @@
             raise RelaxError("The Sparky version number has not been 
supplied.")
 
         # Add the data.
-        cdp.exp_info.software_setup('Sparky', version=version, 
url='http://www.cgl.ucsf.edu/home/sparky/')
+        cdp.exp_info.software_setup('Sparky', version=version, 
url="http://www.cgl.ucsf.edu/home/sparky/";, vendor_name="Goddard, T. D.", 
cite="Goddard, T. D. and Kneller, D. G., SPARKY 3, University of California, 
San Francisco."
+)
 
 
 def write(file=None, directory=None, version='3.1', force=False):