Metadata-Version: 2.1
Name: pynrrd
Version: 0.3.2
Summary: Pure python module for reading and writing NRRD files.
Home-page: https://github.com/mhe/pynrrd
Author: Maarten Everts
Author-email: me@nn8.nl
License: MIT License
Project-URL: Tracker, https://github.com/mhe/pynrrd/issues
Description: 
        .. image:: https://travis-ci.org/mhe/pynrrd.svg?branch=master
            :target: https://travis-ci.org/mhe/pynrrd
            :alt: Build Status
        
        .. image:: https://zenodo.org/badge/doi/10.5281/zenodo.62065.svg
            :target: https://doi.org/10.5281/zenodo.62065
            :alt: DOI
        
        .. image:: https://img.shields.io/pypi/pyversions/pynrrd.svg
            :target: https://img.shields.io/pypi/pyversions/pynrrd.svg
            :alt: Python version
        
        .. image:: https://badge.fury.io/py/pynrrd.svg
            :target: https://badge.fury.io/py/pynrrd
            :alt: PyPi version
        
        .. image:: https://readthedocs.org/projects/pynrrd/badge/?version=latest
            :target: https://pynrrd.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://codecov.io/gh/mhe/pynrrd/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/mhe/pynrrd
        
        |
        
        pynrrd
        ======
        pynrrd is a pure-Python module for reading and writing `NRRD <http://teem.sourceforge.net/nrrd/>`_ files into and 
        from numpy arrays.
        
        Dependencies
        ------------
        The module's only dependency is `numpy <http://numpy.scipy.org/>`_.
        
        Installation
        ------------
        
        Install via pip and PyPi repository (recommended)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        .. code-block:: bash
        
            pip install pynrrd
        
        Install via pip and GitHub
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        .. code-block:: bash
        
            pip install git+https://github.com/mhe/pynrrd.git
            
        Install from source (recommended for contributing to pynrrd)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        For developers that want to contribute to pynrrd, you can clone the pynrrd repository and install it using the following commands:
        
        .. code-block:: bash
        
            git clone https://github.com/mhe/pynrrd.git
            cd pynrrd
            pip install .
        
        or, for the last line, instead use:
        
        .. code-block:: bash
        
            pip install -e .
        
        to install in 'develop' or 'editable' mode, where changes can be made to the local working code and Python will use
        the updated pynrrd code.
        
        Example usage
        -------------
        .. code-block:: python
        
            import numpy as np
            import nrrd
            
            # Some sample numpy data
            data = np.zeros((5,4,3,2))
            filename = 'testdata.nrrd'
            
            # Write to a NRRD file
            nrrd.write(filename, data)
            
            # Read the data back from file
            readdata, header = nrrd.read(filename)
            print(readdata.shape)
            print(header)
        
        
        Tests
        -----
        Run the following command in the base directory to run the tests:
        
        .. code-block:: bash
        
            python -m unittest discover -v nrrd/tests
        
        Next Steps
        ----------
        For more information, see the `documentation <http://pynrrd.readthedocs.io/>`_.
        
        License
        -------
        See the `LICENSE <https://github.com/mhe/pynrrd/blob/master/LICENSE>`_ for more information.
        
Keywords: nrrd teem image processing file format
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/x-rst
