Skip to content

Commit 64f88fc

Browse files
committed
Add introduction information to the Quickstart page
1 parent 64b9a37 commit 64f88fc

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/quickstart.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,30 @@ Quickstart
1212
Welcome to the Zarr-Python Quickstart guide! This page will help you get up and running with
1313
the Zarr library in Python to efficiently manage and analyze multi-dimensional arrays.
1414

15+
Introduction
16+
------------
17+
1518
Zarr is a powerful library for storage of n-dimensional arrays, supporting chunking,
1619
compression, and various backends, making it a versatile choice for scientific and
1720
large-scale data.
1821

22+
An `ndarray <https://numpy.org/doc/2.2/reference/arrays.ndarray.html>`_ is a (usually fixed-size) multidimensional container of items of the
23+
same type and size. The number of dimensions and items in an array is defined
24+
by its shape, which is a tuple of N non-negative integers that specify the sizes of each dimension.
25+
26+
27+
Main Features are:
28+
29+
- `Create <https://zarr.readthedocs.io/en/stable/tutorial.html#creating-an-array>`_ N-dimensional arrays with any NumPy `dtype`.
30+
- `Chunk arrays <https://zarr.readthedocs.io/en/stable/tutorial.html#chunk-optimizations>`_ along any dimension.
31+
- `Compress <https://zarr.readthedocs.io/en/stable/tutorial.html#compressors>`_ and/or filter chunks using any NumCodecs codec.
32+
- `Store arrays <https://zarr.readthedocs.io/en/stable/tutorial.html#tutorial-storage>`_ in memory, on disk, inside a zip file, on S3, etc...
33+
- `Read <https://zarr.readthedocs.io/en/stable/tutorial.html#reading-and-writing-data>`_ an array `concurrently <https://zarr.readthedocs.io/en/stable/tutorial.html#parallel-computing-and-synchronization>`_ from multiple threads or processes.
34+
- Write to an array concurrently from multiple threads or processes.
35+
- Organize arrays into hierarchies via `groups <https://zarr.readthedocs.io/en/stable/tutorial.html#groups>`_.
36+
37+
38+
1939
Installation
2040
------------
2141

0 commit comments

Comments
 (0)