r8568 - in /branches/bmrb: bmrb/__init__.py generic_fns/bmrb.py -- January 21, 2009 - 21:03

Author: bugman
Date: Wed Jan 21 21:03:14 2009
New Revision: 8568

URL: http://svn.gna.org/viewcvs/relax?rev=8568&view=rev
Log:
Converted generic_fns.bmrb into the bmrb package initialisation module.


Added:
    branches/bmrb/bmrb/__init__.py
      - copied unchanged from r8563, branches/bmrb/generic_fns/bmrb.py
Removed:
    branches/bmrb/generic_fns/bmrb.py

Removed: branches/bmrb/generic_fns/bmrb.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/bmrb/generic_fns/bmrb.py?rev=8567&view=auto
==============================================================================
--- branches/bmrb/generic_fns/bmrb.py (original)
+++ branches/bmrb/generic_fns/bmrb.py (removed)
@@ -1,103 +1,0 @@
-###############################################################################
-#                                                                            
 #
-# Copyright (C) 2008 Edward d'Auvergne                                       
 #
-#                                                                            
 #
-# This file is part of the program relax.                                    
 #
-#                                                                            
 #
-# relax is free software; you can redistribute it and/or modify              
 #
-# it under the terms of the GNU General Public License as published by       
 #
-# the Free Software Foundation; either version 2 of the License, or          
 #
-# (at your option) any later version.                                        
 #
-#                                                                            
 #
-# relax is distributed in the hope that it will be useful,                   
 #
-# but WITHOUT ANY WARRANTY; without even the implied warranty of             
 #
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              
 #
-# GNU General Public License for more details.                               
 #
-#                                                                            
 #
-# You should have received a copy of the GNU General Public License          
 #
-# along with relax; if not, write to the Free Software                       
 #
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA  
 #
-#                                                                            
 #
-###############################################################################
-
-# Module docstring.
-"""Module for interfacing with the BMRB (http://www.bmrb.wisc.edu/) by 
handling NMR-STAR v3.1 files."""
-
-# Python module imports.
-from os import F_OK, access
-
-# relax module imports.
-from data import Relax_data_store; ds = Relax_data_store()
-from relax_errors import RelaxError, RelaxFileError, 
RelaxFileOverwriteError, RelaxNoPipeError
-from relax_io import get_file_path, mkdir_nofail
-from specific_fns.setup import get_specific_fn
-
-
-def display():
-    """Display the results in the BMRB NMR-STAR v3.1 format."""
-
-    # Test if the current data pipe exists.
-    if not ds.current_pipe:
-        raise RelaxNoPipeError
-
-    # Specific results writing function.
-    write_function = get_specific_fn('bmrb_write', 
ds[ds.current_pipe].pipe_type, raise_error=False)
-
-    # Write the results.
-    write_function(sys.stdout)
-
-
-def read(file=None, directory=None):
-    """Read the contents of a BMRB NMR-STAR v3.1 formatted file."""
-
-    # Test if the current data pipe exists.
-    if not ds.current_pipe:
-        raise RelaxNoPipeError
-
-    # Make sure that the data pipe is empty.
-    if not ds[ds.current_pipe].is_empty():
-        raise RelaxError, "The current data pipe is not empty."
-
-    # Get the full file path.
-    file_path = get_file_path(file_name=file, dir=directory)
-
-    # Fail if the file does not exist.
-    if not access(file_path, F_OK):
-        raise RelaxFileError, file_path
-
-    # Specific results reading function.
-    read_function = get_specific_fn('bmrb_read', 
ds[ds.current_pipe].pipe_type)
-
-    # Read the results.
-    read_function(file_path)
-
-
-def write(file=None, directory=None, force=False):
-    """Create a BMRB NMR-STAR v3.1 formatted file."""
-
-    # Test if the current data pipe exists.
-    if not ds.current_pipe:
-        raise RelaxNoPipeError
-
-    # The special data pipe name directory.
-    if directory == 'pipe_name':
-        directory = ds.current_pipe
-
-    # Specific results writing function.
-    write_function = get_specific_fn('bmrb_write', 
ds[ds.current_pipe].pipe_type)
-
-    # Get the full file path.
-    file_path = get_file_path(file, directory)
-
-    # Fail if the file already exists and the force flag is False.
-    if access(file_path, F_OK) and not force:
-        raise RelaxFileOverwriteError, (file_path, 'force flag')
-
-    # Print out.
-    print "Opening the file '%s' for writing." % file_path
-
-    # Create the directories.
-    mkdir_nofail(directory, verbosity=0)
-
-    # Execute the specific BMRB writing code.
-    write_function(file_path)