Skip to content

Commit ebbb67a

Browse files
committed
config and zarr_format
1 parent 607777c commit ebbb67a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/user-guide/v3_migration.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ The Array class
9393
1. Disallow direct construction - use :func:`zarr.open_array` or :func:`zarr.create_array`
9494
instead of directly constructing the :class:`zarr.Array` class.
9595

96+
2. Defaulting to ``zarr_format=3`` - newly created arrays will use the version 3 of the
97+
Zarr specification. To continue using version 2, set ``zarr_format=2`` when creating arrays.
98+
9699
The Group class
97100
~~~~~~~~~~~~~~~
98101

@@ -131,6 +134,30 @@ Dependencies Changes
131134
- The ``jupyter`` optional dependency group has been removed, since v3 contains no
132135
jupyter specific functionality.
133136

137+
Configuration
138+
~~~~~~~~~~~~~
139+
140+
There is a new configuration system based on `donfig <https://github.com/pytroll/donfig>`_,
141+
which can be accessed via :data:`zarr.config`.
142+
Configuration values can be set using code like the following:
143+
144+
.. code-block:: python
145+
146+
import zarr
147+
zarr.config.set({"array.order": "F"})
148+
149+
Alternatively, configuration values can be set using environment variables,
150+
e.g. ``ZARR_ARRAY__ORDER=F``.
151+
152+
Configuration options include the following:
153+
154+
- Default Zarr format ``default_zarr_version``
155+
- Default array order in memory ``array.order``
156+
- Async and threading options, e.g. ``async.concurrency`` and ``threading.max_workers``
157+
- Selections of implementations of codecs, codec pipelines and buffers
158+
- TODO: write_empty_chunks PR 2429
159+
- TODO: default codecs PR 2470
160+
134161
Miscellaneous
135162
~~~~~~~~~~~~~
136163

0 commit comments

Comments
 (0)