===========
ome-zarr-py

Tools for multi-resolution images stored in Zarr filesets, according to the OME NGFF spec_.

See Readthedocs <https://ome-zarr.readthedocs.io/>_ for usage information.

Documentation

Documentation will be automatically built with readthedocs.

It can be built locally with::

$ pip install -r docs/requirements.txt
$ 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 setuptools_scm to manage version numbers.

Go to https://github.com/ome/ome-zarr-py/releases and click on Draft a new release.

Under Choose a tag, type the new version number (e.g. 0.1.0) and choose
Create a new tag on publish from the dropdown.

Click on Generate release notes to create a changelog and Publish release to publish the release.

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
.. _BSD: https://opensource.org/licenses/BSD-2-Clause

.. |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
: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
:target: https://codecov.io/gh/ome/ome-zarr-py

Dependency	Optional
aiohttp	false
dask	false
fsspec	false
numpy	false
requests	false
scikit-image	false
toolz	false
zarr	false
pytest	true

Package profile

ome-zarr

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description