Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions docs/codecs.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
======
Codecs
======
------------------------------
Editor's Draft 21 October 2020
------------------------------

**Editor's Draft 21 October 2020**

Specification URI:
https://purl.org/zarr/specs/codec
Expand All @@ -29,9 +28,10 @@ This document defines codecs for Zarr implementations.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
50 changes: 34 additions & 16 deletions docs/core/v3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
======================================
Zarr core specification (version 3.0)
======================================
-------------------------------
Editor's draft 25 May 2022
-------------------------------

**Editor's draft 25 May 2022**

Specification URI:
https://purl.org/zarr/spec/core/3.0
Expand All @@ -15,11 +14,17 @@ Editors:
* Alistair Miles (`@alimanfoo <https://github.com/alimanfoo>`_), Wellcome Sanger Institute
* Jonathan Striebel (`@jstriebel <https://github.com/jstriebel>`_), Scalable Minds

Issue tracking:
`GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/core-spec-v3.0>`_
Corresponding ZEP:
`ZEP 1 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_

Issue tracking and discussion overview:
`GitHub project board <https://github.com/orgs/zarr-developers/projects/2>`_

Suggest an edit for this spec:
`GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/core-protocol-v3.0-dev/docs/core/v3.0.rst>`_
`GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/core/v3.0.rst>`_

Suggest extensions or other changes as a Zarr Enhancement Proposal (ZEP):
`ZEP 0 — Purpose and process <https://zarr.dev/zeps/active/ZEP0000.html>`_

Copyright 2019-Present `Zarr core development team
<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
Expand All @@ -38,14 +43,10 @@ This specification defines the Zarr format for N-dimensional typed arrays.
Status of this document
=======================

This document is a draft for review. See `ZEP0001 <https://zarr.dev/zeps/draft/ZEP0001.html>`_ for further information.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
<https://github.com/zarr-developers/zarr-specs/labels/core-spec-v3.0>`_.

This document was produced by the `Zarr core development team
<https://github.com/orgs/zarr-developers/teams/core-devs>`_.
.. warning::
This document is a draft for review and subject to changes.
It will become final when the `Zarr Enhancement Proposal (ZEP) 1 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
is approved via the `ZEP process <https://zarr.dev/zeps/active/ZEP0000.html>`_.


Introduction
Expand Down Expand Up @@ -1810,8 +1811,25 @@ References
Change log
==========

This section is a placeholder for keeping a log of the snapshots of
this document that are tagged in GitHub and what changed between them.
All notable and possibly implementation-affecting changes to this specification
are documented in this section, grouped by the specification status and ordered
by time.

Draft Changes
--------------------------

- Changed data type names and changed endianness to be handled by a codec.
`PR #155 <https://github.com/zarr-developers/zarr-specs/pull/155>`_
- Replaced the ``compressor`` field in the array metadata with a ``codecs``
field that can specify a list of codecs. `PR #153
<https://github.com/zarr-developers/zarr-specs/pull/153>`_
- Required ``fill_value`` in the array metadata to be defined.
`PR #145 <https://github.com/zarr-developers/zarr-specs/pull/145>`_
- Added array storage transformers which can be configured per array via the
storage_transformers name in the array metadata.
`PR #134 <https://github.com/zarr-developers/zarr-specs/pull/134>`_
- The changelog is incomplete before 2022, please refer to the commits on
GitHub.

@@tag@@
-------
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions/array-extensions/filters/v1.0.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
=======================
Filters (version 1.0)
=======================
-----------------------------
Editor's draft 11 June 2019
-----------------------------

**Editor's draft 11 June 2019**

Specification URI:
http://purl.org/zarr/spec/extensions/filters/1.0
Expand Down Expand Up @@ -32,9 +31,10 @@ during chunk encoding prior to compression.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions/data-types/complex/v1.0.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
=========================================
Complex number data types (version 1.0)
=========================================
-----------------------------
Editor's draft 11 June 2019
-----------------------------

**Editor's draft 11 June 2019**

Specification URI:
http://purl.org/zarr/spec/extensions/complex-dtypes/1.0
Expand Down Expand Up @@ -31,9 +30,10 @@ for complex numbers.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions/data-types/datetime/v1.0.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
===================================
Datetime data types (version 1.0)
===================================
-----------------------------
Editor's draft 11 June 2019
-----------------------------

**Editor's draft 11 June 2019**

Specification URI:
http://purl.org/zarr/spec/protocol/extensions/datetime-dtypes/1.0
Expand Down Expand Up @@ -32,9 +31,10 @@ datetimes).
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions/data-types/string/v1.0.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
===================================
String data types (version 1.0)
===================================
-----------------------------
Editor's draft 2 March 2022
-----------------------------

**Editor's draft 2 March 2022**

Specification URI:
http://purl.org/zarr/spec/extensions/string-dtypes/1.0
Expand Down Expand Up @@ -33,9 +32,10 @@ part of the core v3 spec.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
12 changes: 6 additions & 6 deletions docs/extensions/data-types/struct/v1.0.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
===================================
Struct data types (version 1.0)
===================================
-----------------------------
Editor's draft 2 March 2022
-----------------------------

**Editor's draft 2 March 2022**

Specification URI:
http://purl.org/zarr/spec/extensions/struct-dtypes/1.0
Expand Down Expand Up @@ -32,9 +31,10 @@ zarr-python, but are not part of the core Zarr v3 spec.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down
14 changes: 11 additions & 3 deletions docs/extensions/storage-transformers/sharding/v1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
==========================================
Sharding storage transformer (version 1.0)
==========================================
-----------------------------
Editor's draft 18 02 2022
-----------------------------

**Editor's draft 18 02 2022**

Specification URI:
@@TODO
Expand Down Expand Up @@ -35,6 +34,15 @@ Sharding co-locates multiple chunks within a storage object, bundling them in
shards.


Status of this document
=======================

.. warning::
This document is a draft for review and subject to changes.
It will become final when the `Zarr Enhancement Proposal (ZEP) 2 <https://zarr.dev/zeps/draft/ZEP0002.html>`_
is approved via the `ZEP process <https://zarr.dev/zeps/active/ZEP0000.html>`_.


Motivation
==========

Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
sphinx==2.0.1
sphinx
pydata-sphinx-theme
sphinxcontrib-mermaid
12 changes: 6 additions & 6 deletions docs/stores/filesystem/v1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
=================================
File system store (version 1.0)
=================================
-----------------------------
Editor's draft 26 July 2019
-----------------------------

**Editor's draft 26 July 2019**

Specification URI:
http://purl.org/zarr/spec/stores/filesystem/1.0
Expand Down Expand Up @@ -33,9 +32,10 @@ store API using a file system.
Status of this document
=======================

This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.
.. warning::
This document is a **Work in Progress**. It may be updated, replaced
or obsoleted by other documents at any time. It is inappapropriate to
cite this document as other than work in progress.

Comments, questions or contributions to this document are very
welcome. Comments and questions should be raised via `GitHub issues
Expand Down