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 spinx
sphinx-build -b html docs/source/ docs/build/html
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 spinx
sphinx-build -b html docs/source/ docs/build/html
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.4.1.tar.gz
(29.7 kB
view details)
Built Distribution
ome_zarr-0.4.1-py3-none-any.whl
(32.8 kB
view details)
File details
Details for the file ome-zarr-0.4.1.tar.gz.
File metadata
- Download URL: ome-zarr-0.4.1.tar.gz
- Upload date:
- Size: 29.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c9e79b5067e7d56941e3decfafba1b293e9fdbd8a0736b3dad9fd23d392419bc |
|
| MD5 | 55270ac266a4816cfd6f1dc54c3e693e |
|
| BLAKE2b-256 | 3affc24e0a698ca95d664989827a2cb76f3cde396cbb51e3377673a3c29e12b2 |
File details
Details for the file ome_zarr-0.4.1-py3-none-any.whl.
File metadata
- Download URL: ome_zarr-0.4.1-py3-none-any.whl
- Upload date:
- Size: 32.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0515cdd7076d099e0c4238b8b2afa65396ba3d6fe7659766b5e7d83e1df59390 |
|
| MD5 | ae53eb30456d91915dbd50ae2dbe5844 |
|
| BLAKE2b-256 | f0e84149c10b6a05ddcd77d87f92c87e4ce047da05eaf4abc891b515d069b9e7 |
