Contributing

Clone the repo and install with the test dependency group. Building from source requires a Rust toolchain for the topozarr-core kernel (in core/):

git clone https://github.com/carbonplan/topozarr
cd topozarr
uv sync --group test

Run tests:

uv run pytest -n auto

Run conformance tests against the GeoZarr spec (requires the conformance group):

uv sync --group conformance
uv run pytest -n auto -m conformance

Lint and format:

uv run pre-commit run --all-files

To regenerate the demo datasets in S3 (requires AWS credentials), install the tutorial extra and run the build script:

uv sync --extra tutorial
uv run python scripts/build_demo_data.py --help

License

This code is licensed under the MIT License — see the LICENSE file for details.

About

CarbonPlan is a nonprofit organization that uses data and science for climate action. Find out more at carbonplan.org or get in touch by opening an issue or emailing us.