carshadi / ome-zarr-py Goto Github PK

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

See Documentation for usage information.

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 can be run locally via tox with:

$ pip install tox
$ tox

To enable pre-commit code validation:

$ pip install pre-commit
$ pre-commit install

This repository uses 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. This will also add the .dev0 suffix.

Remember to git push all commits and tags.

Distributed under the terms of the BSD license, "ome-zarr-py" is free and open source software