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.

The Zarr backend is currently experimental 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.

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.1.2.tar.gz (59.6 kB view details)

Uploaded Source

Built Distribution

hdmf_zarr-0.1.2-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.2.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for hdmf_zarr-0.1.2.tar.gz
Algorithm Hash digest
SHA256 92a1950be011db14c804351e7665fb25236668de8cf91c1f31261d9f2724c657
MD5 80513c46a9e94deb8206936d5ccd427d
BLAKE2b-256 2e8c634113815924c7da57f352dfcf867020815d276d1b152f47dcc6388b81ff

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for hdmf_zarr-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 46129e8b9867cd891335c4a1068a54078e10dbb4fea7b6c9c977517ad3277ca4
MD5 a921d9b3de88ff6dcabc5fa3d8f2d17e
BLAKE2b-256 675f0b90e35639011bd63f1a91bdeb0d087899865121dc6587b5661f0c336090

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