Metadata-Version: 1.1
Name: netcdf
Version: 0.0.28
Summary: A python library that allow to use one or multiple NetCDF files in a transparent way through polimorphic methods.
Home-page: https://github.com/ecolell/netcdf
Author: Eloy Adonis Colell
Author-email: eloy.colell@gmail.com
License: MIT
Description: netcdf
        ======
        
        |License| |Downloads| |Build Status| |Coverage Status| |Code Health|
        |PyPI version| |Supported Python versions|
        
        A python library that allow to use one or multiple NetCDF files in a
        transparent way through polimorphic methods.
        
        Requirements
        ------------
        
        If you want to use this library on any GNU/Linux or OSX system you just
        need to execute:
        
        ::
        
            $ pip install netcdf
        
        If you want to improve this library, you should download the `github
        repository <https://github.com/ecolell/netcdf>`__ and execute:
        
        ::
        
            $ make deploy
        
        This library is builded over two **C libraries** (named **libhdf5** and
        **libnetcdf** in *aptitude*). To provide a cross-platform installation,
        the
        `setup.py <https://github.com/ecolell/netcdf/blob/master/setup.py>`__ is
        going to require the **sudo** password to automate the installation of
        these two libraries.
        
        On Ubuntu Desktop there are some other libraries not installed by
        default (zlibc curl libssl0.9.8 libbz2-dev libxslt\ *-dev libxml*-dev)
        which may need to be installed to use these library. Use the next
        command to automate the installation of the additional C libraries:
        
        ::
        
            $ make ubuntu deploy
        
        Testing
        -------
        
        To test all the project you should use the command:
        
        ::
        
            $ make test
        
        If you want to help us or report an issue join to us through the `GitHub
        issue tracker <https://github.com/ecolell/netcdf/issues>`__.
        
        Example
        -------
        
        It can open one or multiple files with the same statement. You can use a
        **pattern**:
        
        .. code:: python
        
            from netcdf import netcdf as nc
            root, is_new = nc.open('file_*.nc')
            print root.files
        
            data = nc.getvar(root, 'data')
            print "Matrix shape: ", data.shape
            print "Matrix values: ", data[:]
        
            nc.close(root)
        
        Or you can open a **list of files**:
        
        .. code:: python
        
            from netcdf import netcdf as nc
            root, is_new = nc.open(['file01.nc', 'file02.nc', 'file03.nc'])
            nc.close(root)
        
        Or you can use a **with** statement:
        
        .. code:: python
        
            from netcdf import netcdf as nc
            with nc.loader(['file01.nc', 'file02.nc', 'file03.nc']) as root:
                # here you should write al the needed operations
                pass
        
        Also, it is compatible with **numpy**:
        
        .. code:: python
        
            from netcdf import netcdf as nc
            import numpy as np
            root, is_new = nc.open('file_*.nc')
            data = nc.getvar(root, 'data')
        
            data[:] = data[:] + 3.
            print "Matrix values: ", data[:]
            # Bulk the data variable into the files.
            nc.sync(root)
        
            # Set to zero all the values of the matrix.
            data[:] = np.zeros(data.shape)
            print data[:]
        
            nc.close(root)
        
        It also can **join a variable distributed in multiple files** and save
        it in a single file:
        
        .. code:: python
        
            from netcdf import netcdf as nc
            root, is_new = nc.open('file_*.nc')
            print root.files
            data = nc.getvar(root, 'data')
            print "Matrix shape: ", data.shape
        
            joined_root, is_new = nc.open('new_file.nc')
            print joined_root.files
            joined_data = nc.getvar(joined_root, 'copied_data', source=data)
            print "Matrix shape: ", joined_data.shape
        
            nc.close(joined_root)
            nc.close(root)
        
        About
        -----
        
        This software is developed by
        `GERSolar <http://www.gersol.unlu.edu.ar/>`__. You can contact us to
        gersolar.dev@gmail.com.
        
        .. |License| image:: https://pypip.in/license/netcdf/badge.svg
           :target: https://pypi.python.org/pypi/netcdf/
        .. |Downloads| image:: https://pypip.in/download/netcdf/badge.svg
           :target: https://pypi.python.org/pypi/netcdf/
        .. |Build Status| image:: https://travis-ci.org/ecolell/netcdf.svg?branch=master
           :target: https://travis-ci.org/ecolell/netcdf
        .. |Coverage Status| image:: https://coveralls.io/repos/ecolell/netcdf/badge.png
           :target: https://coveralls.io/r/ecolell/netcdf
        .. |Code Health| image:: https://landscape.io/github/ecolell/netcdf/master/landscape.png
           :target: https://landscape.io/github/ecolell/netcdf/master
        .. |PyPI version| image:: https://badge.fury.io/py/netcdf.svg
           :target: http://badge.fury.io/py/netcdf
        .. |Supported Python versions| image:: https://pypip.in/py_versions/netcdf/badge.svg
           :target: https://pypi.python.org/pypi/netcdf/
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Physics
