Skip to content

User guide zarr file missing values note #8746

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 2 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
1 change: 1 addition & 0 deletions doc/user-guide/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -898,6 +898,7 @@ where the data should be written (in index space, not label space), e.g.,

Concurrent writes with ``region`` are safe as long as they modify distinct
chunks in the underlying Zarr arrays (or use an appropriate ``lock``).
Note that incorrectly (or omitting) setting the ``chunksizes`` for the initial Zarr file results in a partial update of the chunks when writing to regions, causing missing values in the Zarr file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know enough about writing to regions to comment on the content, so here are some style suggestions:

Suggested change
Note that incorrectly (or omitting) setting the ``chunksizes`` for the initial Zarr file results in a partial update of the chunks when writing to regions, causing missing values in the Zarr file.
Note that incorrectly setting (or omitting) the ``chunksizes`` for the initial
Zarr file results in a partial update of the chunks when writing to regions,
causing missing values in the Zarr file.

We could also use .. note:: for this if we think this is important enough.


As a safety check to make it harder to inadvertently override existing values,
if you set ``region`` then *all* variables included in a Dataset must have
Expand Down