Skip to content

Commit 25ef408

Browse files
committed
tweaks
1 parent 065cb0c commit 25ef408

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

docs/v3/codecs/crc32c/v1.0.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44
CRC32C checksum codec (version 1.0)
55
============================
66

7-
**Editor's draft 26 July 2019**
7+
**Editor's draft 17 July 2023**
88

99
Specification URI:
10-
https://zarr-specs.readthedocs.io/en/latest/v3/codecs/endian/v1.0.html
10+
https://zarr-specs.readthedocs.io/en/latest/v3/codecs/crc32c/v1.0.html
1111
Corresponding ZEP:
12-
`ZEP 1Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
12+
`ZEP 2Sharding codec <https://zarr.dev/zeps/draft/ZEP0002.html>`_
1313
Issue tracking:
1414
`GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
1515
Suggest an edit for this spec:
16-
`GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/endian/v1.0.rst>`_
16+
`GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/crc32c/v1.0.rst>`_
1717

18-
Copyright 2020 `Zarr core development team
18+
Copyright 2022-Present `Zarr core development team
1919
<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
2020
is licensed under a `Creative Commons Attribution 3.0 Unported License
2121
<https://creativecommons.org/licenses/by/3.0/>`_.

docs/v3/codecs/sharding-indexed/v1.0.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
==========================================
44
Sharding codec (version 1.0)
55
==========================================
6-
-----------------------------
7-
Editor's draft 23 03 2023
8-
-----------------------------
6+
7+
**Editor's draft 17 July 2023**
98

109
Specification URI:
1110
https://zarr-specs.readthedocs.io/en/latest/v3/codecs/sharding-indexed/v1.0.html
12-
11+
Corresponding ZEP:
12+
`ZEP 2 — Sharding codec <https://zarr.dev/zeps/draft/ZEP0002.html>`_
1313
Issue tracking:
1414
`GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/sharding-indexed-codec-v1.0>`-
15-
1615
Suggest an edit for this spec:
1716
`GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/codecs/sharding-indexed/v1.0.rst>`_
1817

@@ -188,13 +187,13 @@ beyond the array shape.
188187
The index is placed at the end of the file and encoded into binary representations
189188
using the specified index codecs. The byte size of the index is determined by the
190189
number of inner chunks in the shard ``n``, i.e. the product of the sizes specified in
191-
``chunk_shape``, and the choice of index codecs. For a combination of little-endian
192-
codec and crc32c checksum codec, the index has a size of ``16 * n + 4``. For example,
193-
``16 * 4 + 4 = 68 bytes`` for a shard shape of ``[64, 64]`` and inner chunk shape of
194-
``[32, 32]``.
190+
``chunk_shape``, and the choice of index codecs.
195191

196-
Given the example of 2x2 inner chunks in a shard and recommended index codecs, i.e.
197-
little-endian codec followed by crc32c checksum codec, the index would look like::
192+
For an example, consider a shard shape of ``[64, 64]``, an inner chunk shape of
193+
``[32, 32]`` and an index codec combination of a little-endian codec followed by
194+
a crc32c checksum codec. The size of the corresponding index is
195+
``16 (2x uint64) * 4 (chunks per shard) + 4 (crc32c checksum) = 68 bytes``.
196+
The index would look like::
198197

199198
| chunk (0, 0) | chunk (0, 1) | chunk (1, 0) | chunk (1, 1) | |
200199
| offset | nbytes | offset | nbytes | offset | nbytes | offset | nbytes | checksum |

0 commit comments

Comments
 (0)