Skip to main content

A package defining a Zarr I/O backend for HDMF

Project description

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.

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

Latest Release

Documentation Status

CI / Health Status

https://codecov.io/gh/hdmf-dev/hdmf-zarr/branch/dev/graph/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Run%20code%20coverage/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Run%20tests/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Run%20all%20tests/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Check%20Sphinx%20external%20links/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Deploy%20release/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/black/badge.svg https://github.com/hdmf-dev/hdmf-zarr/workflows/Run%20style%20check/badge.svg

Citing hdmf-zarr

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/en/latest/

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdmf_zarr-0.7.0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

hdmf_zarr-0.7.0-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file hdmf_zarr-0.7.0.tar.gz.

File metadata

  • Download URL: hdmf_zarr-0.7.0.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hdmf_zarr-0.7.0.tar.gz
Algorithm Hash digest
SHA256 a3801d60d9f82ffd07cb3d25a9a5ec8b87dc5f23270bd8dac5ab075dd28f4d9b
MD5 5101bfc585b58bd31dcc3cf58050a1c5
BLAKE2b-256 edb91c432526aa608d35bf35bd95b5fa35382fedd4dff40f914ead6baffede07

See more details on using hashes here.

Provenance

File details

Details for the file hdmf_zarr-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: hdmf_zarr-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for hdmf_zarr-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 068c499aa275a395039a90084948d2658d7729405fc5cc501f81caf602681103
MD5 d9041795ab86861b47b2c54a9b4ac526
BLAKE2b-256 c8f21b77c4dba4c1378294ae251dd6251229ad1699530020fedf28fca24918c3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page