Skip to main content

Create virtual Zarr stores from archival data using xarray API

Project description

VirtualiZarr

CI Code coverage Docs Linted and Formatted with Ruff Checked with mypy pre-commit Enabled Apache 2.0 License Python Versions slack Latest Release PyPI - Downloads Conda - Downloads

Cloud-Optimize your Scientific Data as a Virtual Zarr Datacube, using Xarray syntax.

The best way to distribute large scientific datasets is via the Cloud, in Cloud-Optimized formats [^1]. But often this data is stuck in archival pre-Cloud file formats such as netCDF.

VirtualiZarr[^2] makes it easy to create "Virtual" Zarr datacubes, allowing performant access to archival data as if it were in the Cloud-Optimized Zarr format, without duplicating any data.

Please see the documentation.

Features

Inspired by Kerchunk

VirtualiZarr grew out of discussions on the Kerchunk repository, and is an attempt to provide the game-changing power of kerchunk but in a zarr-native way, and with a familiar array-like API.

You now have a choice between using VirtualiZarr and Kerchunk: VirtualiZarr provides almost all the same features as Kerchunk.

Development Status and Roadmap

VirtualiZarr version 1 (mostly) achieved feature parity with kerchunk's logic for combining datasets, providing an easier way to manipulate kerchunk references in memory and generate kerchunk reference files on disk.

VirtualiZarr version 2 brings:

  • Zarr v3 support
  • A pluggable system of "parsers" for virtualizing custom file formats
  • The ManifestStore abstraction, which allows for loading data without serializing to Kerchunk/Icechunk first
  • Integration with obstore
  • Reference parsing that doesn't rely on kerchunk under the hood
  • The ability to use "parsers" to load data directly from archival file formats into Zarr and/or Xarray

Future VirtualiZarr development will focus on generalizing and upstreaming useful concepts into the Zarr specification, the Zarr-Python library, Xarray, and possibly some new packages.

We have a lot of ideas, including:

If you see other opportunities then we would love to hear your ideas!

Talks and Presentations

  • 2025/04/30 - Cloud-Native Geospatial Forum - Tom Nicholas - Slides / Recording
  • 2024/11/21 - MET Office Architecture Guild - Tom Nicholas - Slides
  • 2024/11/13 - Cloud-Native Geospatial conference - Raphael Hagen - Slides
  • 2024/07/24 - ESIP Meeting - Sean Harkins - Event / Recording
  • 2024/05/15 - Pangeo showcase - Tom Nicholas - Event / Recording / Slides
  • 2025/07/22 - ESIP Meeting - Max Jones - Event / Recording / Slides

Credits

This package was originally developed by Tom Nicholas whilst working at [C]Worthy, who deserve credit for allowing him to prioritise a generalizable open-source solution to the dataset virtualization problem. VirtualiZarr is now a community-owned multi-stakeholder project.

Licence

Apache 2.0

References

[^1]: Cloud-Native Repositories for Big Scientific Data, Abernathey et. al., Computing in Science & Engineering.

[^2]: (Pronounced "Virtual-Eye-Zarr" - like "virtualizer" but more piratey 🦜)

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

virtualizarr-2.3.0.tar.gz (229.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

virtualizarr-2.3.0-py3-none-any.whl (200.8 kB view details)

Uploaded Python 3

File details

Details for the file virtualizarr-2.3.0.tar.gz.

File metadata

  • Download URL: virtualizarr-2.3.0.tar.gz
  • Upload date:
  • Size: 229.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for virtualizarr-2.3.0.tar.gz
Algorithm Hash digest
SHA256 2a093e6ddedd9aed9de6ca326f3d1eeb236ce2f7283e208885419f9be72ba9c4
MD5 76ecbf5035c4babb53d8ae5df5490a27
BLAKE2b-256 51519be7ebc416130a3fc520df3fb0a954317e7fb7b3d7d8888bfac1bb467d8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for virtualizarr-2.3.0.tar.gz:

Publisher: release.yml on zarr-developers/VirtualiZarr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file virtualizarr-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: virtualizarr-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 200.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for virtualizarr-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de656f81771edafb4b6d3b67a1560a15fb53e974df1778f17c1036f3137275b9
MD5 cc011c636e42a352e7096ebd4f5c5825
BLAKE2b-256 eed9751d4e1c4eb863e77b51c49b6157c025d5583029653a2bed35ba0e3c202d

See more details on using hashes here.

Provenance

The following attestation bundles were made for virtualizarr-2.3.0-py3-none-any.whl:

Publisher: release.yml on zarr-developers/VirtualiZarr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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