https://github.com/mhe/pynrrd
Simple pure-python module for reading and writing nrrd files.
https://github.com/mhe/pynrrd
nrrd numpy python
Last synced: 7 months ago
JSON representation
Simple pure-python module for reading and writing nrrd files.
- Host: GitHub
- URL: https://github.com/mhe/pynrrd
- Owner: mhe
- License: mit
- Created: 2010-07-12T07:46:35.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2025-01-23T05:13:22.000Z (12 months ago)
- Last Synced: 2025-06-03T04:05:52.267Z (8 months ago)
- Topics: nrrd, numpy, python
- Language: Python
- Homepage: https://pynrrd.readthedocs.io/
- Size: 362 KB
- Stars: 122
- Watchers: 8
- Forks: 53
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
.. 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.592532.svg
:target: https://doi.org/10.5281/zenodo.592532
: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=stable
:target: https://pynrrd.readthedocs.io/en/stable/?badge=stable
: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 `_ files into and
from numpy arrays.
Requirements
------------
* `numpy `_
* typing_extensions
v1.0+ requires Python 3.7 or above. If you have an older Python version, please install a v0.x release instead.
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.
**Tests**
The tests can be run via the following command from the base directory:
.. code-block:: bash
python -m unittest discover -v nrrd/tests
**Format and Lint code**
This repository uses pre-commit hooks to run format and lint the code and they are enforced in CI. See [pre-commit](https://pre-commit.com)
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)
Next Steps
----------
For more information, see the `documentation `_.
License
-------
See the `LICENSE `_ for more information.