Skip to content

Doc: document Zarr compression options for to_zarr#12269

Merged
jacobtomlinson merged 3 commits intodask:mainfrom
abslock128w:patch-1
Feb 5, 2026
Merged

Doc: document Zarr compression options for to_zarr#12269
jacobtomlinson merged 3 commits intodask:mainfrom
abslock128w:patch-1

Conversation

@abslock128w
Copy link
Copy Markdown
Contributor

@abslock128w abslock128w commented Feb 3, 2026

Added a short example showing how to pass compression settings (e.g. Blosc with a
specific compression level) via storage_options when writing Dask arrays to Zarr.

Add a short example showing how to pass compression settings
(e.g. Blosc with a specific compression level) via storage_options
when writing Dask arrays to Zarr.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 3, 2026

Unit Test Results

See test report for an extended history of previous test failures. This is useful for diagnosing flaky tests.

     21 files  +     2       21 suites  +2   5h 14m 26s ⏱️ + 9m 56s
 18 282 tests +     4   17 008 ✅ +     2   1 272 💤 ±    0  2 ❌ +2 
294 715 runs  +13 518  252 409 ✅ +11 935  42 304 💤 +1 581  2 ❌ +2 

For more details on these failures, see this check.

Results for commit 45b311f. ± Comparison against base commit 2cb642e.

♻️ This comment has been updated with latest results.

... storage_options={"compressor": compressor},
... )

The available compressors and compression settings depend on the Zarr
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Would you mind adding a link to the Zar docs that explain this? I think that would be helpful for the users

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure will do!!

@ncclementi
Copy link
Copy Markdown
Member

Thank you @abslock128w this looks pretty good. I left a few comments.

@jacobtomlinson just in case would you give this a pass through in case I'm missing something, beyond what's in the comments.

this is the exact rendering in the docs: https://dask--12269.org.readthedocs.build/en/12269/array-creation.html#zarr

Add a direct link to the Zarr documentation explaining available
compressors and compression levels.
@abslock128w
Copy link
Copy Markdown
Contributor Author

Thanks for the feedback! I’ve made the suggested changes.
Please let me know if there’s anything else you’d like me to tweak.

Copy link
Copy Markdown
Member

@ncclementi ncclementi left a comment

Choose a reason for hiding this comment

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

Small suggestion, if you accept it I think we are good to go.

cleaner render

Co-authored-by: Naty Clementi <natyclementi@gmail.com>
@jacobtomlinson
Copy link
Copy Markdown
Member

Thanks for the review @ncclementi

The CI failure is unrelated. Is this something you've seen before @TomAugspurger?

@jacobtomlinson jacobtomlinson merged commit 262caeb into dask:main Feb 5, 2026
49 of 51 checks passed
@TomAugspurger
Copy link
Copy Markdown
Member

Nope, I don't think I have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to pass compression level to_parquet, to_zarr [docs]

4 participants