You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: update readme
* Update README.md
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
* Update README.md
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
* Update README.md
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
* Update README.md
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
---------
Co-authored-by: Max Jones <14077947+maxrjones@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,13 @@
15
15
16
16
## What is it?
17
17
18
-
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.
18
+
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.
19
19
20
20
## Main Features
21
21
22
-
-[**Create**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#creating-an-array) N-dimensional arrays with any NumPy `dtype`.
22
+
-[**Create**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#creating-an-array) N-dimensional arrays with NumPy-compatible`dtype`s.
23
23
-[**Chunk arrays**](https://zarr.readthedocs.io/en/stable/user-guide/performance/#chunk-optimizations) along any dimension.
24
-
-[**Compress**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#compressors)and/or filter chunks using any NumCodecs codec.
24
+
-[**Encode**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#compressors) chunks using a variety of useful encodings (e.g., compression).
25
25
-[**Store arrays**](https://zarr.readthedocs.io/en/stable/user-guide/storage/) in memory, on disk, inside a zip file, on S3, etc...
26
26
-[**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.
27
27
-[**Write**](https://zarr.readthedocs.io/en/stable/user-guide/arrays/#reading-and-writing-data) to an array concurrently from multiple threads or processes.
For more details, including how to install from source, see the [installation documentation](https://zarr.readthedocs.io/en/stable/#installation).
45
+
46
+
## Repository sub-packages
47
+
48
+
In addition to the primary `zarr` implementation, this repository contains other packages that provide specialized functionality with minimal dependencies:
49
+
50
+
-[`zarr-metadata`](https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata): Tools for Zarr metadata. Install with `pip install zarr-metadata`.
51
+
-[`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`.
52
+
-[`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`.
0 commit comments