| Name | pynrrd JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | Pure python module for reading and writing NRRD files. |
| upload_time | 2024-11-07 03:17:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright (c) 2012 Maarten H. Everts and contributors. See AUTHORS for more details. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
nrrd
teem
image
processing
file
format
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
typing_extensions
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. 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 <http://teem.sourceforge.net/nrrd/>`_ files into and
from numpy arrays.
Requirements
------------
* `numpy <https://numpy.org/>`_
* 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 <http://pynrrd.readthedocs.io/>`_.
License
-------
See the `LICENSE <https://github.com/mhe/pynrrd/blob/master/LICENSE>`_ for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "pynrrd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nrrd, teem, image, processing, file, format",
"author": null,
"author_email": "Maarten Everts <me@nn8.nl>, Addison Elliott <addison.elliott@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5b/20/b4e76ebc1fe2e0652f1cce8f3fa2e8887c0d57c55229ea93ebf555ae5108/pynrrd-1.1.1.tar.gz",
"platform": null,
"description": ".. image:: https://travis-ci.org/mhe/pynrrd.svg?branch=master\n :target: https://travis-ci.org/mhe/pynrrd\n :alt: Build Status\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.592532.svg\n :target: https://doi.org/10.5281/zenodo.592532\n :alt: DOI\n\n.. image:: https://img.shields.io/pypi/pyversions/pynrrd.svg\n :target: https://img.shields.io/pypi/pyversions/pynrrd.svg\n :alt: Python version\n\n.. image:: https://badge.fury.io/py/pynrrd.svg\n :target: https://badge.fury.io/py/pynrrd\n :alt: PyPi version\n\n.. image:: https://readthedocs.org/projects/pynrrd/badge/?version=stable\n :target: https://pynrrd.readthedocs.io/en/stable/?badge=stable\n :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/mhe/pynrrd/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/mhe/pynrrd\n\n|\n\npynrrd\n======\npynrrd is a pure-Python module for reading and writing `NRRD <http://teem.sourceforge.net/nrrd/>`_ files into and\nfrom numpy arrays.\n\nRequirements\n------------\n\n* `numpy <https://numpy.org/>`_\n* typing_extensions\n\nv1.0+ requires Python 3.7 or above. If you have an older Python version, please install a v0.x release instead.\n\nInstallation\n------------\n\nInstall via pip and PyPi repository (recommended)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. code-block:: bash\n\n pip install pynrrd\n\nInstall via pip and GitHub\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n.. code-block:: bash\n\n pip install git+https://github.com/mhe/pynrrd.git\n\nInstall from source (recommended for contributing to pynrrd)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nFor developers that want to contribute to pynrrd, you can clone the pynrrd repository and install it using the following commands:\n\n.. code-block:: bash\n\n git clone https://github.com/mhe/pynrrd.git\n cd pynrrd\n pip install .\n\nor, for the last line, instead use:\n\n.. code-block:: bash\n\n pip install -e .\n\nto install in 'develop' or 'editable' mode, where changes can be made to the local working code and Python will use\nthe updated pynrrd code.\n\n**Tests**\n\nThe tests can be run via the following command from the base directory:\n\n.. code-block:: bash\n\n python -m unittest discover -v nrrd/tests\n\n**Format and Lint code**\n\n 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)\n\nExample usage\n-------------\n.. code-block:: python\n\n import numpy as np\n import nrrd\n\n # Some sample numpy data\n data = np.zeros((5,4,3,2))\n filename = 'testdata.nrrd'\n\n # Write to a NRRD file\n nrrd.write(filename, data)\n\n # Read the data back from file\n readdata, header = nrrd.read(filename)\n print(readdata.shape)\n print(header)\n\n\nNext Steps\n----------\nFor more information, see the `documentation <http://pynrrd.readthedocs.io/>`_.\n\nLicense\n-------\nSee the `LICENSE <https://github.com/mhe/pynrrd/blob/master/LICENSE>`_ for more information.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2012 Maarten H. Everts and contributors. See AUTHORS for more details. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Pure python module for reading and writing NRRD files.",
"version": "1.1.1",
"project_urls": {
"Documentation": "https://pynrrd.readthedocs.io/en/stable",
"Homepage": "https://github.com/mhe/pynrrd",
"Tracker": "https://github.com/mhe/pynrrd/issues"
},
"split_keywords": [
"nrrd",
" teem",
" image",
" processing",
" file",
" format"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7bfe532e4899c5a19d51e4aae7fe2e8689380a27b8fb3b53560541f84c283445",
"md5": "c501be80f65c44f48d76979d14ea4006",
"sha256": "e65ae7ac53583ad5d71a03845c9247ff2238415b91980f1fd9486d4ec3d62c43"
},
"downloads": -1,
"filename": "pynrrd-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c501be80f65c44f48d76979d14ea4006",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23482,
"upload_time": "2024-11-07T03:17:02",
"upload_time_iso_8601": "2024-11-07T03:17:02.606295Z",
"url": "https://files.pythonhosted.org/packages/7b/fe/532e4899c5a19d51e4aae7fe2e8689380a27b8fb3b53560541f84c283445/pynrrd-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b20b4e76ebc1fe2e0652f1cce8f3fa2e8887c0d57c55229ea93ebf555ae5108",
"md5": "d67e3682c703397e34056bfd9e883db8",
"sha256": "dafd98d778263b1c90eac1d42779886153daa97a4577dea9590f74dab18b4ca2"
},
"downloads": -1,
"filename": "pynrrd-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d67e3682c703397e34056bfd9e883db8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21642,
"upload_time": "2024-11-07T03:17:04",
"upload_time_iso_8601": "2024-11-07T03:17:04.426446Z",
"url": "https://files.pythonhosted.org/packages/5b/20/b4e76ebc1fe2e0652f1cce8f3fa2e8887c0d57c55229ea93ebf555ae5108/pynrrd-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 03:17:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mhe",
"github_project": "pynrrd",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.21"
]
]
},
{
"name": "typing_extensions",
"specs": []
}
],
"lcname": "pynrrd"
}
