https://github.com/ome/ome-zarr-py
Implementation of next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
https://github.com/ome/ome-zarr-py
ngff ome ome-zarr zarr
Last synced: 5 months ago
JSON representation
Implementation of next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
- Host: GitHub
- URL: https://github.com/ome/ome-zarr-py
- Owner: ome
- License: other
- Created: 2020-05-06T09:40:59.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T22:55:58.000Z (6 months ago)
- Last Synced: 2024-10-29T14:23:02.996Z (6 months ago)
- Topics: ngff, ome, ome-zarr, zarr
- Language: Python
- Homepage: https://pypi.org/project/ome-zarr
- Size: 745 KB
- Stars: 151
- Watchers: 21
- Forks: 53
- Open Issues: 69
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- top-life-sciences - **ome/ome-zarr-py** - generation file format (NGFF) specifications for storing bioimaging data in the cloud.<br>`ngff`, `ome`, `ome-zarr`, `zarr`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 143 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 51 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> Python <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> Other <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2024-06-06 12:51:57 | (Ranked by starred repositories)
README
|pypi| |docs| |coverage|
===========
ome-zarr-py
===========
Tools for multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_.
See `Documentation `_ 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 `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.
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.org/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