Skip to main content
docs/source/figures/logo_hdmf_zarr.png

hdmf-zarr

The hdmf-zarr library implements a Zarr backend for HDMF as well as convenience classes for integration of Zarr with PyNWB to support writing of NWB files to Zarr.

ZarrIO and NWBZarrIO read and write the Zarr v3 format. Legacy Zarr v2 files are read with ZarrV2IO and NWBZarrV2IO, which also provide helpers to convert those files to Zarr v3.

Status: The Zarr backend is under development and may still change. See the overview page for an overview of the available features and known limitations of hdmf-zarr.

Documentation Status

Latest release:

Documentation status for latest release

Dev branch:

Documentation status for dev branch

CI / Health Status

https://codecov.io/gh/hdmf-dev/hdmf-zarr/branch/dev/graph/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/run_coverage.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/run_tests.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/run_all_tests.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/check_external_links.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/deploy_release.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/ruff.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/codespell.yml/badge.svg https://github.com/hdmf-dev/hdmf-zarr/actions/workflows/HDMF_dev.yaml/badge.svg

If you use HDMF or hdmf_zarr in your research, please use the following citation:

  • A. J. Tritt, O. Ruebel, B. Dichter, R. Ly, D. Kang, E. F. Chang, L. M. Frank, K. Bouchard, “HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards,” 2019 IEEE International Conference on Big Data (Big Data), Los Angeles, CA, USA, 2019, pp. 165-179, doi: 10.1109/BigData47090.2019.9005648.

  • HDMF-Zarr, RRID:SCR_022709

Documentation

See the hdmf-zarr documentation for details: https://hdmf-zarr.readthedocs.io

Usage

The library is intended to be used in conjunction with HDMF. hdmf-zarr mainly provides with the ZarrIO class an alternative to the HDF5IO I/O backend that ships with HDMF. To support customization of I/O settings, hdmf-zarr provides ZarrDataIO (similar to H5DataIO in HDMF). Using ZarrIO and ZarrDataIO works much in the same way as HDF5IO. To ease integration with the NWB data standard and PyNWB, hdmf-zarr provides the NWBZarrIO class as alternative to pynwb.NWBHDF5IO. See the tutorials included with the documentation for more details.

Metadata

Release files for hdmf-zarr 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hdmf-zarr 0.14.0
File Size Uploaded
hdmf_zarr-0.14.0.tar.gz 3.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for hdmf-zarr 0.14.0
File Interpreter ABI Platform
hdmf_zarr-0.14.0-py3-none-any.whl Python 3 none any Details

Total release size: 3.4 MB

Release files / hdmf_zarr-0.14.0.tar.gz

Download URL hdmf_zarr-0.14.0.tar.gz
Size 3.3 MB
Tags Source
SHA-256 checksum
How to use checksums
f0a31dff2fa86689ef664333d56385447a0739470458bb115a9cd787cd5ef8c9
BLAKE2b-256 checksum
How to use checksums
1840a4c4bfb9048a1262f9a88b4ec27c729882d23982743f086369ec278ece67
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

Release files / hdmf_zarr-0.14.0-py3-none-any.whl

Download URL hdmf_zarr-0.14.0-py3-none-any.whl
Size 59.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
240252546e0375bf419440aded23e06697943b3cbfa94ab67f7a701e60e3421e
BLAKE2b-256 checksum
How to use checksums
3038e875b38d9f7c944c0135d396b834a01168343c803690ef3ec00bbf57f1cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 22, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.14.0 This release

2 release files

0.13.0

2 release files

0.11.3

2 release files

0.11.2

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page