From 930fa5683dab73d5e8d02cb6edfe24b7bc6ba014 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 22 Oct 2025 19:33:31 +0000 Subject: [PATCH 1/4] compile release notes --- changes/3118.doc.md | 1 - changes/3303.doc.md | 1 - changes/3366.feature.md | 1 - changes/3483.bugfix.md | 1 - changes/3490.feature.md | 1 - changes/3502.doc.md | 1 - changes/3515.misc.md | 1 - changes/3526.feature.md | 1 - changes/3535.bugfix.md | 2 -- docs/release-notes.md | 25 +++++++++++++++++++++++++ 10 files changed, 25 insertions(+), 10 deletions(-) delete mode 100644 changes/3118.doc.md delete mode 100644 changes/3303.doc.md delete mode 100644 changes/3366.feature.md delete mode 100644 changes/3483.bugfix.md delete mode 100644 changes/3490.feature.md delete mode 100644 changes/3502.doc.md delete mode 100644 changes/3515.misc.md delete mode 100644 changes/3526.feature.md delete mode 100644 changes/3535.bugfix.md diff --git a/changes/3118.doc.md b/changes/3118.doc.md deleted file mode 100644 index 58adb1db76..0000000000 --- a/changes/3118.doc.md +++ /dev/null @@ -1 +0,0 @@ -Use mkdocs-material for Zarr-Python documentation \ No newline at end of file diff --git a/changes/3303.doc.md b/changes/3303.doc.md deleted file mode 100644 index ebae05f7e4..0000000000 --- a/changes/3303.doc.md +++ /dev/null @@ -1 +0,0 @@ -Document different values of StoreLike with examples in the user guide. \ No newline at end of file diff --git a/changes/3366.feature.md b/changes/3366.feature.md deleted file mode 100644 index 550c9f4436..0000000000 --- a/changes/3366.feature.md +++ /dev/null @@ -1 +0,0 @@ -Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. \ No newline at end of file diff --git a/changes/3483.bugfix.md b/changes/3483.bugfix.md deleted file mode 100644 index b6672d348a..0000000000 --- a/changes/3483.bugfix.md +++ /dev/null @@ -1 +0,0 @@ -Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. \ No newline at end of file diff --git a/changes/3490.feature.md b/changes/3490.feature.md deleted file mode 100644 index 899cdcf75d..0000000000 --- a/changes/3490.feature.md +++ /dev/null @@ -1 +0,0 @@ -Adds a `zarr.experimental` module for unstable user-facing features. \ No newline at end of file diff --git a/changes/3502.doc.md b/changes/3502.doc.md deleted file mode 100644 index 031c046bf4..0000000000 --- a/changes/3502.doc.md +++ /dev/null @@ -1 +0,0 @@ -Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. \ No newline at end of file diff --git a/changes/3515.misc.md b/changes/3515.misc.md deleted file mode 100644 index 06a94c98a0..0000000000 --- a/changes/3515.misc.md +++ /dev/null @@ -1 +0,0 @@ -Replace `crc32c` dependency with `google-crc32c` to resolve licensing concerns. The `crc32c` library uses LGPL license, while `google-crc32c` uses the more permissive Apache 2.0 license. This change maintains full backward compatibility with existing CRC32C-encoded data. diff --git a/changes/3526.feature.md b/changes/3526.feature.md deleted file mode 100644 index 7746611855..0000000000 --- a/changes/3526.feature.md +++ /dev/null @@ -1 +0,0 @@ -Increased the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. diff --git a/changes/3535.bugfix.md b/changes/3535.bugfix.md deleted file mode 100644 index 7e1ce8f834..0000000000 --- a/changes/3535.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when -consolidated metadata was not used, resulting in invalid metadata documents. \ No newline at end of file diff --git a/docs/release-notes.md b/docs/release-notes.md index 9e809f194e..963df06056 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,6 +2,31 @@ +# zarr 3.1.4 (2025-10-22) + +## Features + +- Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/issues3366)) +- Adds a `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) +- Increased the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. ([#3526](https://github.com/zarr-developers/zarr-python/issues3526)) + +## Bugfixes + +- Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) +- Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when + consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/issues3535)) + +## Improved Documentation + +- Use mkdocs-material for Zarr-Python documentation ([#3118](https://github.com/zarr-developers/zarr-python/issues3118)) +- Document different values of StoreLike with examples in the user guide. ([#3303](https://github.com/zarr-developers/zarr-python/issues3303)) +- Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. ([#3502](https://github.com/zarr-developers/zarr-python/issues3502)) + +## Misc + +- [#3515](https://github.com/zarr-developers/zarr-python/issues3515) + + # zarr 3.1.3 (2025-09-18) ## Features From a0c52b6e995f3d44a3c19c422d6a133da5cd9f58 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 22 Oct 2025 19:36:52 +0000 Subject: [PATCH 2/4] add latest release notes --- changes/3530.bugfix.md | 2 -- changes/3532.misc.md | 2 -- changes/3536.doc.md | 1 - docs/release-notes.md | 13 ++++++++----- 4 files changed, 8 insertions(+), 10 deletions(-) delete mode 100644 changes/3530.bugfix.md delete mode 100644 changes/3532.misc.md delete mode 100644 changes/3536.doc.md diff --git a/changes/3530.bugfix.md b/changes/3530.bugfix.md deleted file mode 100644 index 36a1787a3a..0000000000 --- a/changes/3530.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained - extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). \ No newline at end of file diff --git a/changes/3532.misc.md b/changes/3532.misc.md deleted file mode 100644 index 0249aa899c..0000000000 --- a/changes/3532.misc.md +++ /dev/null @@ -1,2 +0,0 @@ -Accept `"bytes"` as an alias for `"variable_length_bytes"` when parsing `JSON`-encoded Zarr V3 -data types. \ No newline at end of file diff --git a/changes/3536.doc.md b/changes/3536.doc.md deleted file mode 100644 index 742a0cc3db..0000000000 --- a/changes/3536.doc.md +++ /dev/null @@ -1 +0,0 @@ -Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. diff --git a/docs/release-notes.md b/docs/release-notes.md index 963df06056..09608a0d13 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,26 +6,29 @@ ## Features +- Adds the `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) - Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/issues3366)) -- Adds a `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) -- Increased the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. ([#3526](https://github.com/zarr-developers/zarr-python/issues3526)) +- Increases the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. ([#3526](https://github.com/zarr-developers/zarr-python/issues3526)) ## Bugfixes -- Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) -- Fixed a bug where the `"consolidated_metadata"` key was written to metadata documents even when +- Fixes a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) +- Fixes a bug where the `"consolidated_metadata"` key was written to metadata documents even when consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/issues3535)) +- Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained + extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). ([#3530](https://github.com/zarr-developers/zarr-python/issues3530)) ## Improved Documentation - Use mkdocs-material for Zarr-Python documentation ([#3118](https://github.com/zarr-developers/zarr-python/issues3118)) - Document different values of StoreLike with examples in the user guide. ([#3303](https://github.com/zarr-developers/zarr-python/issues3303)) - Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. ([#3502](https://github.com/zarr-developers/zarr-python/issues3502)) +- Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. ([#3536](https://github.com/zarr-developers/zarr-python/issues3536)) ## Misc - [#3515](https://github.com/zarr-developers/zarr-python/issues3515) - +- [#3532](https://github.com/zarr-developers/zarr-python/issues3532) # zarr 3.1.3 (2025-09-18) From 6b18b760d27a47e9e78bb66ef7772af0f61ed618 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 22 Oct 2025 19:38:17 +0000 Subject: [PATCH 3/4] prose --- docs/release-notes.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index 09608a0d13..271e2d6e6d 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,16 +6,16 @@ ## Features -- Adds the `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) -- Adds `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/issues3366)) -- Increases the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. ([#3526](https://github.com/zarr-developers/zarr-python/issues3526)) +- Add the `zarr.experimental` module for unstable user-facing features. ([#3490](https://github.com/zarr-developers/zarr-python/issues3490)) +- Add `zarr.experimental.cache_store.CacheStore`, a `Store` that implements caching by combining two other `Store` instances. See the [docs page](https://zarr.readthedocs.io/en/latest/user-guide/experimental#cachestore) for more information about this feature. ([#3366](https://github.com/zarr-developers/zarr-python/issues3366)) +- Increase the default value of `async.concurrency` from 10 to 64 to improve parallelism and throughput for concurrent I/O operations. This change enables better performance out-of-the-box for most workloads. Users with specific resource constraints or when using many Dask threads may want to lower this value via the `ZARR_ASYNC_CONCURRENCY` environment variable or by setting `zarr.config.set({'async.concurrency': N})`. ([#3526](https://github.com/zarr-developers/zarr-python/issues3526)) ## Bugfixes -- Fixes a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) -- Fixes a bug where the `"consolidated_metadata"` key was written to metadata documents even when +- Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) +- Fix a bug where the `"consolidated_metadata"` key was written to metadata documents even when consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/issues3535)) -- Fixed a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained +- Fixe a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). ([#3530](https://github.com/zarr-developers/zarr-python/issues3530)) ## Improved Documentation @@ -23,7 +23,7 @@ - Use mkdocs-material for Zarr-Python documentation ([#3118](https://github.com/zarr-developers/zarr-python/issues3118)) - Document different values of StoreLike with examples in the user guide. ([#3303](https://github.com/zarr-developers/zarr-python/issues3303)) - Reorganize the top-level `examples` directory to give each example its own sub-directory. Adds content to the docs for each example. ([#3502](https://github.com/zarr-developers/zarr-python/issues3502)) -- Updated 3.0 Migration Guide to include function signature change to zarr.Array.resize function. ([#3536](https://github.com/zarr-developers/zarr-python/issues3536)) +- Update 3.0 Migration Guide to include function signature change to zarr.Array.resize function. ([#3536](https://github.com/zarr-developers/zarr-python/issues3536)) ## Misc From 28ab159b0cdd61555222b63c159dcea033b862c3 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 22 Oct 2025 19:41:39 +0000 Subject: [PATCH 4/4] typo --- docs/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index 271e2d6e6d..b6157d30b8 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -15,7 +15,7 @@ - Fix a bug that prevented `PCodec` from being properly resolved when loading arrays using that compressor. ([#3483](https://github.com/zarr-developers/zarr-python/issues3483)) - Fix a bug where the `"consolidated_metadata"` key was written to metadata documents even when consolidated metadata was not used, resulting in invalid metadata documents. ([#3535](https://github.com/zarr-developers/zarr-python/issues3535)) -- Fixe a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained +- Fix a bug that prevented Zarr Python from opening Zarr V3 array metadata documents that contained extra keys with permissible values (dicts with a `"must_understand"` key set to `"false"`). ([#3530](https://github.com/zarr-developers/zarr-python/issues3530)) ## Improved Documentation