https://github.com/zarr-developers/zarr-extensions
This repository contains the specifications for Zarr extensions for Zarr version 3.
https://github.com/zarr-developers/zarr-extensions
Last synced: 6 months ago
JSON representation
This repository contains the specifications for Zarr extensions for Zarr version 3.
- Host: GitHub
- URL: https://github.com/zarr-developers/zarr-extensions
- Owner: zarr-developers
- Created: 2025-02-14T10:56:40.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-25T09:34:01.000Z (7 months ago)
- Last Synced: 2025-07-08T08:43:48.715Z (7 months ago)
- Homepage:
- Size: 104 KB
- Stars: 7
- Watchers: 9
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# zarr-extensions
This repository contains the specifications for Zarr extensions for [Zarr version 3](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).
It is the normative source for registering names of Zarr v3 extensions.
## Registering an extension
To register an extension, open a new PR with a new extension directory under the relevant extension point:
* [Codecs](./codecs/README.md)
* [Data Types](./data-types/README.md)
* [Chunk Key Encoding](./chunk-key-encodings/README.md)
* [Chunk Grid](./chunk-grids/README.md)
* [Storage Transformers](./storage-transformers/README.md)
Each extension MUST have a `README.md` file that describes the extension and its metadata specification.
Extensions SHOULD have a `schema.json` file that contains the JSON schema for the metadata, if the README.md does not provide a link to an external schema.
The JSON schema should be formatted with `npx prettier -w **/schema.json`.
Please note that all extensions documents will be licensed under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/).
Only open a PR if you are willing to license your extension under this license.
The PR will be reviewed by the [Zarr steering council](https://github.com/orgs/zarr-developers/teams/steering-council).
We aim to be very open about registering extensions.
The review will be done largely based on avoiding confusing extension names and preventing malicious activity as well as maintaining the formal requirements of the extensions.
We recommend opening a "draft PR" first, if you still want to solicit feedback from others in the community. As soon as you turn your PR into a regular PR, the review will be processed.
Extension maintainers are responsible for their extensions.
Updates to the extensions will also be reviewed by the steering council.
The steering council reserves the right to reassign extensions to other maintainers in case of prolonged inactivity or other reasons at its own discretion.
## Document conventions
These conventions are used for all extension specification documents in this repository.
Conformance requirements are expressed with a combination of descriptive
assertions and [RFC2119] terminology. The key words "MUST", "MUST NOT",
"REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" in the normative parts of specification documents are to be interpreted as
described in [RFC2119]. However, for readability, these words do not appear in
all uppercase letters in specification documents.
All of the text of specification documents are normative except sections explicitly
marked as non-normative, examples, and notes. Examples in specification documents are
introduced with the words "for example".
[RFC2119] S. Bradner. Key words for use in RFCs to Indicate
Requirement Levels. March 1997. Best Current Practice. URL:
https://tools.ietf.org/html/rfc2119
[RFC2119]: https://tools.ietf.org/html/rfc2119
## License
All extensions are licensed under the [Creative Commons Attribution 3.0 Unported License](https://creativecommons.org/licenses/by/3.0/).