Feedback is very welcome on about this framework for Zarr Conventions. Please join the discussion on V1 of the Zarr Conventions Framework.
This organisation contains documentation and tooling to help define and share Zarr Adoption Conventions.
A Zarr Adoption Convention (Zarr convention, for short) is simply a way of using Zarr to store data for a particular domain, application or purpose. For example, a Zarr Convention can define a set of attributes for storing specific metadata that helps downstream applications provide special behaviour and users interpret the data.
To define and share your own convention:
- Create a new GitHub repo using the zarr-conventions template
- Create a UUID to use as a globally-unique identifier for your convention.
- Edit the README.md in your repo to describe your usage convention for developers and users.
- Edit or remove the schema.json file in your repo to define validation constraints on your metadata.
- Commit your changes and make a GitHub release so you have a stable version of your spec and schema to point to.
- Share your convention with the community (see below).
If you have published a Zarr convention, please add it to the list below:
- f17cb550-5864-4468-aeb7-f3180cfb622f — https://github.com/zarr-experimental/geo-proj
- 689b58e2-cf7b-45e0-9fff-9cfc0883d6b4 - https://github.com/zarr-conventions/spatial
- d35379db-88df-4056-af3a-620245f8e347 - https://github.com/zarr-conventions/multiscales