Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add dimension_names array metadata field #162

Merged
merged 7 commits into from
Jan 23, 2023
Merged

Add dimension_names array metadata field #162

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3cd7691
Add `dimension_names` array metadata field
jbms Nov 2, 2022
61cf77c
Change restriction on duplicate dimension names to recommendation
jbms Nov 28, 2022
62700ed
Merge branch 'main' into dimension-names
jstriebel Dec 19, 2022
c6e6b45
add changelog entry
jstriebel Dec 19, 2022
71b92bb
changelog formatting
jstriebel Dec 19, 2022
acde618
Merge branch 'main' into dimension-names
jstriebel Jan 20, 2023
3d2799f
Use null object for unnamed dimensions
jstriebel Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions docs/core/v3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,6 @@ We solicit feedback on the following area during the review period:
solicit feedback on whether store implementation should support full unicode.
https://github.com/zarr-developers/zarr-specs/issues/56

- Should named dimensions be part of the core metadata spec?
https://github.com/zarr-developers/zarr-specs/issues/73
https://github.com/zarr-developers/zarr-specs/pull/162


Document conventions
====================
Expand Down Expand Up @@ -1092,6 +1088,22 @@ The following members are optional:
specification. When the ``storage_transformers`` name is absent no storage
transformer is used, same for an empty list.

``dimension_names``
^^^^^^^^^^^^^^^^^^^

Specifies dimension names, e.g. ``["x", "y", "z"]``. If specified, must be
an array of strings or null objects with the same length as ``shape``. An
unnamed dimension is indicated by the null object. If ``dimension_names`` is
not specified, all dimensions are unnamed.

For compatibility with zarr implementations and applications that support
using dimension names to uniquely identify dimensions, it is recommended but
not required that all non-null dimension names are distinct (no two
dimensions have the same non-empty name).

This specification also does not place any restrictions on the use of the
same dimension name across multiple arrays within the same zarr hierarchy,
but extensions or specific applications may do so.

The array metadata object must not contain any other names.
Those are reserved for future versions of this specification.
Expand All @@ -1108,6 +1120,7 @@ compressed using gzip compression prior to storage::

{
"shape": [10000, 1000],
"dimension_names": ["rows", "columns"],
"data_type": "<f8",
"chunk_grid": {
"type": "regular",
Expand Down Expand Up @@ -1758,6 +1771,8 @@ by time.
Draft Changes
--------------------------

- Added the ``dimension_names`` array metadata field. `PR #162
<https://github.com/zarr-developers/zarr-specs/pull/162>`_
- Replaced ``chunk_memory_layout`` with transpose codec. `PR #189
<https://github.com/zarr-developers/zarr-specs/pull/189>`_
- Allowed to have a list of fallback data types. `PR #167
Expand Down