From b278f1849690beb676f56a059c5ce4000bf80362 Mon Sep 17 00:00:00 2001 From: Davis Vann Bennett Date: Wed, 12 Aug 2026 14:54:59 +0200 Subject: [PATCH 1/5] docs: update readme --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7557936b6f..e8860b8cc7 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ ## What is it? -Zarr is a Python package providing an implementation of compressed, chunked, N-dimensional arrays, designed for use in parallel computing. See the [documentation](https://zarr.readthedocs.io/en/stable/) for more information. +The `zarr` package is a Python implementation of the [Zarr storage format](https://zarr.dev/). `zarr` delivers compressed, chunked, N-dimensional arrays that work well for parallel computing and object storage. See the [documentation](https://zarr.readthedocs.io/en/stable/) for more information. ## Main Features -- [**Create**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#creating-an-array) N-dimensional arrays with any NumPy `dtype`. +- [**Create**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#creating-an-array) N-dimensional arrays with NumPy-compatible `dtype`s. - [**Chunk arrays**](https://zarr.readthedocs.io/en/stable/user-guide/performance/#chunk-optimizations) along any dimension. -- [**Compress**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#compressors) and/or filter chunks using any NumCodecs codec. +- [**Encode**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#compressors) chunks using a variety of useful encodings (e.g., compression). - [**Store arrays**](https://zarr.readthedocs.io/en/stable/user-guide/storage/) in memory, on disk, inside a zip file, on S3, etc... - [**Read**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#reading-and-writing-data) an array [**concurrently**](https://zarr.readthedocs.io/en/stable/user-guide/performance/#parallel-computing-and-synchronization) from multiple threads or processes. - [**Write**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#reading-and-writing-data) to an array concurrently from multiple threads or processes. @@ -42,3 +42,14 @@ conda install -c conda-forge zarr ``` For more details, including how to install from source, see the [installation documentation](https://zarr.readthedocs.io/en/stable/#installation). + +## Ecosystem + +This repository contains several packages: + +- [`zarr`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): The Python implementation of the Zarr storage format. +- [`zarr-metadata`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): Tools for Zarr metadata. +- [`zarr-indexing`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-indexing): Tools for lazily indexing chunked arrays. +- [`zarr-http-server`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-http-server): An HTTP server implementation targeting Zarr data. + +For data saved in the Zarr V2 format, many chunk encoding implementations are defined in the [`numcodecs`](https://github.com/zarr-developers/numcodecs/) library. \ No newline at end of file From 5966ecd53b6a405c8f31beae1c4bd26ccad154b0 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 12 Aug 2026 15:13:19 +0200 Subject: [PATCH 2/5] Update README.md Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index e8860b8cc7..3248c8094d 100644 --- a/README.md +++ b/README.md @@ -51,5 +51,3 @@ This repository contains several packages: - [`zarr-metadata`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): Tools for Zarr metadata. - [`zarr-indexing`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-indexing): Tools for lazily indexing chunked arrays. - [`zarr-http-server`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-http-server): An HTTP server implementation targeting Zarr data. - -For data saved in the Zarr V2 format, many chunk encoding implementations are defined in the [`numcodecs`](https://github.com/zarr-developers/numcodecs/) library. \ No newline at end of file From 174ed6d8e08f21652d20d669d7598959e32bc08a Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 12 Aug 2026 15:13:31 +0200 Subject: [PATCH 3/5] Update README.md Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3248c8094d..9c5dd75bfb 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,8 @@ For more details, including how to install from source, see the [installation do ## Ecosystem -This repository contains several packages: +In addition to the primary `zarr` implementation, this repository contains other packages that provide specialized functionality with minimal dependencies: -- [`zarr`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): The Python implementation of the Zarr storage format. -- [`zarr-metadata`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): Tools for Zarr metadata. -- [`zarr-indexing`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-indexing): Tools for lazily indexing chunked arrays. -- [`zarr-http-server`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-http-server): An HTTP server implementation targeting Zarr data. +- [`zarr-metadata`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): Tools for Zarr metadata. Install with `pip install zarr-metadata`. +- [`zarr-indexing`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-indexing): Tools for lazily indexing chunked arrays. Install with `pip install zarr-indexing`. +- [`zarr-http-server`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-http-server): An HTTP server implementation targeting Zarr data. Install with `pip install zarr-http-server`. From 0e70df79ce48375a2d7254b665f5bced23d89f65 Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 12 Aug 2026 15:13:43 +0200 Subject: [PATCH 4/5] Update README.md Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c5dd75bfb..d698770a4b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## What is it? -The `zarr` package is a Python implementation of the [Zarr storage format](https://zarr.dev/). `zarr` delivers compressed, chunked, N-dimensional arrays that work well for parallel computing and object storage. See the [documentation](https://zarr.readthedocs.io/en/stable/) for more information. +The `zarr` library is a Python implementation of the [Zarr storage format](https://zarr.dev/). `zarr` delivers compressed, chunked, N-dimensional arrays that work well for parallel computing and object storage. See the [documentation](https://zarr.readthedocs.io/en/stable/) for more information. ## Main Features From 52c5137f747b06c5743d501ac3113c93a263fd4f Mon Sep 17 00:00:00 2001 From: Davis Bennett Date: Wed, 12 Aug 2026 15:13:59 +0200 Subject: [PATCH 5/5] Update README.md Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d698770a4b..330c1da5ea 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ conda install -c conda-forge zarr For more details, including how to install from source, see the [installation documentation](https://zarr.readthedocs.io/en/stable/#installation). -## Ecosystem +## Repository sub-packages In addition to the primary `zarr` implementation, this repository contains other packages that provide specialized functionality with minimal dependencies: