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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 0da9a904c34280a2b1dcdae5e2a0a88506f1f24d8d09ac49ec590cfe95b1d001
MD5 d5086859594485fdcdd603145f925717
BLAKE2b-256 dfc03bb05ebbf54fd413a1cf4c52b0707bc0171402f5e32cfa9fd1b26f25f637

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d709b2a8abae6381da3eb439cdf64f7ea6c9be08fbe817f4e414be9e46a1985c
MD5 215abc9b67530e2f1ba53ebbc4b7bfc1
BLAKE2b-256 86a5861de0db4cce6fc176613782b98c1d82888c572a174b2a4bbfdaa73724f1

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