Implementation of images in Zarr files.
Project description
|pypi| |docs| |coverage|
===========
ome-zarr-py
===========
Tools for multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.
See `Documentation <https://ome-zarr.readthedocs.io/>`_ for usage information.
Documentation
-------------
Documentation will be automatically built with `readthedocs`.
It can be built locally with::
$ pip install sphinx
$ sphinx-build -b html docs/source/ docs/build/html
Tests
-----
Tests can be run locally via `tox` with::
$ pip install tox
$ tox
To enable pre-commit code validation::
$ pip install pre-commit
$ pre-commit install
Release process
---------------
This repository uses `bump2version <https://pypi-hypernode.com/project/bump2version/>`_ to manage version numbers.
To tag a release run::
$ bumpversion release
This will remove the ``.dev0`` suffix from the current version, commit, and tag the release.
To switch back to a development version run::
$ bumpversion --no-tag [major|minor|patch]
specifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.
Remember to ``git push`` all commits and tags.
License
-------
Distributed under the terms of the `BSD`_ license,
"ome-zarr-py" is free and open source software
.. _`OME NGFF spec`: https://github.com/ome/ngff
.. _`@napari`: https://github.com/napari
.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`Mozilla Public License 2.0`: https://www.mozilla.org/media/MPL/2.0/index.txt
.. _`napari`: https://github.com/napari/napari
.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr
.. _`ome-zarr`: https://pypi-hypernode.com/project/ome-zarr/
.. |pypi| image:: https://badge.fury.io/py/ome-zarr.svg
:alt: PyPI project
:target: https://badge.fury.io/py/ome-zarr
.. |docs| image:: https://readthedocs.org/projects/ome-zarr/badge/?version=stable
:alt: Documentation Status
:scale: 100%
:target: https://ome-zarr.readthedocs.io/en/stable/?badge=stable
.. |coverage| image:: https://codecov.io/gh/ome/ome-zarr-py/branch/master/graph/badge.svg
:alt: Test coverage
:scale: 100%
:target: https://codecov.io/gh/ome/ome-zarr-py
===========
ome-zarr-py
===========
Tools for multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.
See `Documentation <https://ome-zarr.readthedocs.io/>`_ for usage information.
Documentation
-------------
Documentation will be automatically built with `readthedocs`.
It can be built locally with::
$ pip install sphinx
$ sphinx-build -b html docs/source/ docs/build/html
Tests
-----
Tests can be run locally via `tox` with::
$ pip install tox
$ tox
To enable pre-commit code validation::
$ pip install pre-commit
$ pre-commit install
Release process
---------------
This repository uses `bump2version <https://pypi-hypernode.com/project/bump2version/>`_ to manage version numbers.
To tag a release run::
$ bumpversion release
This will remove the ``.dev0`` suffix from the current version, commit, and tag the release.
To switch back to a development version run::
$ bumpversion --no-tag [major|minor|patch]
specifying ``major``, ``minor`` or ``patch`` depending on whether the development branch will be a `major, minor or patch release <https://semver.org/>`_. This will also add the ``.dev0`` suffix.
Remember to ``git push`` all commits and tags.
License
-------
Distributed under the terms of the `BSD`_ license,
"ome-zarr-py" is free and open source software
.. _`OME NGFF spec`: https://github.com/ome/ngff
.. _`@napari`: https://github.com/napari
.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`Mozilla Public License 2.0`: https://www.mozilla.org/media/MPL/2.0/index.txt
.. _`napari`: https://github.com/napari/napari
.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr
.. _`ome-zarr`: https://pypi-hypernode.com/project/ome-zarr/
.. |pypi| image:: https://badge.fury.io/py/ome-zarr.svg
:alt: PyPI project
:target: https://badge.fury.io/py/ome-zarr
.. |docs| image:: https://readthedocs.org/projects/ome-zarr/badge/?version=stable
:alt: Documentation Status
:scale: 100%
:target: https://ome-zarr.readthedocs.io/en/stable/?badge=stable
.. |coverage| image:: https://codecov.io/gh/ome/ome-zarr-py/branch/master/graph/badge.svg
:alt: Test coverage
:scale: 100%
:target: https://codecov.io/gh/ome/ome-zarr-py
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ome-zarr-0.8.1.tar.gz
(32.9 kB
view details)
Built Distribution
ome_zarr-0.8.1-py3-none-any.whl
(36.3 kB
view details)
File details
Details for the file ome-zarr-0.8.1.tar.gz.
File metadata
- Download URL: ome-zarr-0.8.1.tar.gz
- Upload date:
- Size: 32.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 20782de63fd1650147492ebd94ae0e4f54b3199b202d8747c86b92d1f50be346 |
|
| MD5 | 59b627e634f6a96457ca937af234f7d8 |
|
| BLAKE2b-256 | a8b57d0efaffcdb86439115512515a1f83ea804855aff876181e5ef6ce10738b |
File details
Details for the file ome_zarr-0.8.1-py3-none-any.whl.
File metadata
- Download URL: ome_zarr-0.8.1-py3-none-any.whl
- Upload date:
- Size: 36.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fdd045b97f7c0b29dbf7c961d3cd6fa1bda5dd98d1b4524199d24ac0aab00cb1 |
|
| MD5 | 13c79fbae7fb27cc413519b1b4a084e7 |
|
| BLAKE2b-256 | 463959ed03637c30dbf10c397bcb35c17b4cd6998d49a6897957a25266703feb |
