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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 37c68790f35700742b1567a6a95c6a2721d48e71b1a3cd46f596f03faa2f4952
MD5 4f1411207b3e8743e28d86b9e5a1e521
BLAKE2b-256 e76670753d851a70d833a29da228af24327b93aadcd55f12806076ce2f4d20ee

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: hdmf_zarr-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2964a7357556800cfe6ec32c8673f4257b857b71253abc99fde83494bfb59e38
MD5 8b5b1b2896ff892c7f2e443563abfffe
BLAKE2b-256 925b1d2133c8a81e0dc0fdc81b299d6837bfea419276bf0bd0909bfc1dde9386

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