Open Data Cube Zarr Prototype Driver

Overview

This provides a Zarr Data Read Plug-in driver. for the Open Data Cube (ODC) project.

For ODC documentation, please see ODC documentation

See https://zarr.readthedocs.io/ for Zarr storage specification and Python library.

User Guides

• zarrify command line tool
• OpenDataCube Index
• ZarrIO usage

Drivers provided

• Zarr 2D/3D driver
  • supports (s3, file) protocols

Requirements

System:

• ODC 1.8.4+
  • For 3D native reads, use this branch
• PostgreSQL 9.5+
• Python 3.8+

Optional:

• EO Datasets
  • Used in prepare scripts for generating EO3 compliant metadata. (Documentation)
• odc-tools
  • Used for indexing datasets on S3
• index_from_s3_bucket
  • Used for indexing datasets on S3. (Documentation)

Developer setup

1. Install ODC with python=3.8 (see ODC developer setup)
2. Clone:

   git clone https://github.com/opendatacube/datacube-zarr.git
   

3. Activate the conda environment you created when installing ODC

   conda activate odc
   

4. Install new drivers from this repository.

   cd datacube-drivers
   pip install --upgrade -e  ".[test]"
   

5. Run (flake8, isort, mypy, black) + unit tests

   ./check-code.sh
   

6. (or) Run all tests, including integration tests.

   ./check-code.sh integration_tests
   

   • Assumes a password-less Postgres database running on localhost called agdcintegration
   • Otherwise copy integration_tests/agdcintegration.conf to ~/.datacube_integration.conf and edit to customise.