Skip to content

DOC : Fixes the issue #2611 by explicitly mentioning the default values #2891

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
42 changes: 36 additions & 6 deletions docs/user-guide/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,43 @@ For more information, see the

Configuration options include the following:

- Default Zarr format ``default_zarr_version``
- Default array order in memory ``array.order``
- ``default_zarr_version``
Sets the default Zarr format version. The options are ``2`` or ``3``.

- **Default:** ``3``

- **array.order**
Defines the default memory layout for arrays.

- ``'C'`` → Row-major (The default value used for NumPy arrays)
- ``'F'`` → Column-major (like Fortran)
- **Default:** ``'C'``


- Default filters, serializers and compressors, e.g. ``array.v3_default_filters``, ``array.v3_default_serializer``, ``array.v3_default_compressors``, ``array.v2_default_filters`` and ``array.v2_default_compressor``
- Whether empty chunks are written to storage ``array.write_empty_chunks``
- Async and threading options, e.g. ``async.concurrency`` and ``threading.max_workers``
- Selections of implementations of codecs, codec pipelines and buffers
- Enabling GPU support with ``zarr.config.enable_gpu()``. See :ref:`user-guide-gpu` for more.

- ``array.write_empty_chunks``
Determines whether empty chunks (filled with default values) are written to storage. Setting this to ``False`` can reduce the number of write operations and objects created when writing arrays with large empty regions.

- ``False`` → Empty chunks are **not written**.
- ``True`` → Empty chunks are explicitly stored.
- **Default:** ``False``

- ``async.concurrency``
Sets the number of concurrent async operations.

- **Default:** ``10``

- ``threading.max_workers``
Defines the maximum number of worker threads for parallel execution.

- **Default**: ``None`` (uses system default)

- ``codecs`` / ``codec_pipeline`` / ``buffer``
Allows selection of custom implementations for codecs, encoding pipelines, and data buffers.

- GPU Support : Enabling GPU support with ``zarr.config.enable_gpu()``. See :ref:`user-guide-gpu` for more.


For selecting custom implementations of codecs, pipelines, buffers and ndbuffers,
first register the implementations in the registry and then select them in the config.
Expand Down