Zarr protocol v3 2019-12 to 2020-12 - Githubissues

sci-rs / zarr

Rust implementation of the Zarr N-dimensional array format.

Apache License 2.0

55 stars 5 forks source link

Zarr protocol v3 2019-12 to 2020-12 #1

Open clbarnes opened 3 years ago

clbarnes commented 3 years ago

Questions (in spec)

[ ] node name character set (currently ASCII, potentially UTF-8)
[ ] node name case sensitivity (currently sensitive, potentially insensitive)

Misc

[x] Paths start with /
[x] Zero-D arrays
[x] Groups' metadata document is optional
[x] Node names are case-sensitive
[x] No complex numbers
[x] Raw bits dtype
[x] Chunk IDs are prefixed with c, and default dimension separator is / (i.e."c1/2/3" not "1.2.3")
- [x] Zero-D array chunk ID is "c"

Metadata

Entry point metadata (formerly "bootstrap metadata")

[x] zarr.json (entry point metadata document in hierarchy root, formerly "bootstrap metadata") is the only definite JSON
[x] metadata_encoding is now a URL, not a MIME type (e.g. "https://purl.org/zarr/spec/protocol/core/3.0" instead of "application/json")
[x] metadata_key_suffix is new, e.g. ".json"

Array metadata

"{node_name}.array{metadata_key_suffix}"

[x] dtype -> data_type
[x] chunk_grid object now contains separator = "/"
[ ] compressor is optional
[x] (some stuff about extensions)

Group metadata

"{node_name}.group{metadata_key_suffix}"

[x] no extensions

Stores

[ ] "prefix" operations are group names with a trailing /

Writable:

[x] delete is now erase
[x] erase_prefix now exists