{"id":23846,"library":"hdmf-zarr","title":"hdmf-zarr","description":"A package defining a Zarr I/O backend for HDMF (Hierarchical Data Modeling Framework). Version 0.12.0 supports Python >=3.9 and provides Zarr-based reading/writing of HDMF files, including NWB (Neurodata Without Borders) files. Release cadence is irregular, with several minor releases per year.","status":"active","version":"0.12.0","language":"python","source_language":"en","source_url":"https://github.com/hdmf-dev/hdmf-zarr","tags":["neuroscience","NWB","Zarr","HDMF","I/O"],"install":[{"cmd":"pip install hdmf-zarr","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core framework; hdmf-zarr provides a Zarr backend for HDMF.","package":"hdmf","optional":false},{"reason":"Zarr storage backend for arrays and groups.","package":"zarr","optional":false},{"reason":"Required for HDF5 compatibility in some conversion utilities.","package":"h5py","optional":true}],"imports":[{"note":"","wrong":"","symbol":"ZarrIO","correct":"from hdmf_zarr import ZarrIO"}],"quickstart":{"code":"from hdmf_zarr import ZarrIO\nfrom hdmf.common import NWBContainer\n# Create an NWBFile (requires pynwb) or a simple HDMF container\n# For demonstration, assume 'container' is an HDMF object\n# container = NWBContainer('test')\n# Write with ZarrIO\n# ZarrIO(container).export('output.zarr')\nprint(ZarrIO.__name__)","lang":"python","description":"Minimal import example. Full usage requires an HDMF container object (e.g., from pynwb)."},"warnings":[{"fix":"Re-export files using hdmf-zarr >=0.10.0 or keep older files only for reading.","message":"In version 0.10.0, the export functionality was refactored, breaking existing exported files by changing the default file source. Files exported with earlier versions may be invalid.","severity":"breaking","affected_versions":">=0.10.0,<0.12.0"},{"fix":"Use `ZarrIO._file` instead of `ZarrIO.file` for direct Zarr group access, or rely on public methods like `read()`.","message":"The `ZarrIO.file` property was renamed to `ZarrIO._file` in version 0.12.0. Direct access to the underlying Zarr group is now private.","severity":"gotcha","affected_versions":">=0.12.0"},{"fix":"Set environment variable `ZARR_DEPRECATED_NESTED_DIRECTORY_STORE` or switch to default Zarr store (e.g., `zarr.DirectoryStore`).","message":"`NestedDirectoryStore` is deprecated in Zarr and may be removed. hdmf-zarr >=0.8.0 added a warning for its usage.","severity":"deprecated","affected_versions":">=0.8.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install hdmf-zarr` or include it in your requirements.","cause":"Missing installation of hdmf-zarr. Often occurs when using pynwb without explicit hdmf-zarr install.","error":"ModuleNotFoundError: No module named 'hdmf_zarr'"},{"fix":"Verify installation: `pip show hdmf-zarr`. Correct import: `from hdmf_zarr import ZarrIO`.","cause":"Incorrect import path or outdated version. HDMF-Zarr may not be installed correctly.","error":"ImportError: cannot import name 'ZarrIO' from 'hdmf_zarr'"},{"fix":"Pass a string path (e.g., 'output.zarr') instead of an open file object.","cause":"Using an uninitialized file-like object instead of a path string. ZarrIO expects a path, not a file handle.","error":"TypeError: '_io.BufferedWriter' object has no attribute 'name'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}