|
1 | 1 | Getting Started |
2 | 2 | =============== |
3 | 3 |
|
4 | | -Zarr is a format for the storage of chunked, compressed, N-dimensional arrays |
5 | | -inspired by `HDF5 <https://www.hdfgroup.org/HDF5/>`_, `h5py |
6 | | -<https://www.h5py.org/>`_ and `bcolz <https://bcolz.readthedocs.io/>`_. |
7 | | - |
8 | | -The project is fiscally sponsored by `NumFOCUS <https://numfocus.org/>`_, a US |
9 | | -501(c)(3) public charity, and development is supported by the |
10 | | -`MRC Centre for Genomics and Global Health <https://www.cggh.org>`_ |
11 | | -and the `Chan Zuckerberg Initiative <https://chanzuckerberg.com/>`_. |
12 | | - |
13 | | -These documents describe the Zarr Python implementation. More information |
14 | | -about the Zarr format can be found on the `main website <https://zarr.dev>`_. |
15 | | - |
16 | | -Highlights |
17 | | ----------- |
18 | | - |
19 | | -* Create N-dimensional arrays with any NumPy dtype. |
20 | | -* Chunk arrays along any dimension. |
21 | | -* Compress and/or filter chunks using any NumCodecs_ codec. |
22 | | -* Store arrays in memory, on disk, inside a Zip file, on S3, ... |
23 | | -* Read an array concurrently from multiple threads or processes. |
24 | | -* Write to an array concurrently from multiple threads or processes. |
25 | | -* Organize arrays into hierarchies via groups. |
26 | | - |
27 | | -Contributing |
| 4 | +Installation |
28 | 5 | ------------ |
29 | 6 |
|
30 | | -Feedback and bug reports are very welcome, please get in touch via |
31 | | -the `GitHub issue tracker <https://github.com/zarr-developers/zarr-python/issues>`_. See |
32 | | -:doc:`contributing` for further information about contributing to Zarr. |
| 7 | +pip |
| 8 | +~~~ |
33 | 9 |
|
34 | | -Projects using Zarr |
35 | | -------------------- |
| 10 | +.. code-block:: console |
36 | 11 |
|
37 | | -If you are using Zarr, we would `love to hear about it |
38 | | -<https://github.com/zarr-developers/community/issues/19>`_. |
| 12 | + $ pip install zarr |
39 | 13 |
|
40 | | -.. toctree:: |
41 | | - :caption: Getting Started |
42 | | - :hidden: |
| 14 | +There are a number of optional dependency groups you can install for extra functionality. |
| 15 | +These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"`` |
43 | 16 |
|
44 | | - installation |
| 17 | +- ``gpu``: support for GPUs |
| 18 | +- ``fsspec``: support for reading/writing to remote data stores |
| 19 | +- ``tree``: support for pretty printing of directory trees |
45 | 20 |
|
46 | | -.. _NumCodecs: https://numcodecs.readthedocs.io/ |
| 21 | +conda |
| 22 | +~~~~~ |
| 23 | + |
| 24 | +.. code-block:: console |
| 25 | +
|
| 26 | + $ conda install -c conda-forge zarr |
| 27 | +
|
| 28 | +Conda does not support optional dependencies, so you will have to manually install any packages |
| 29 | +needed to enable extra functionality. |
| 30 | + |
| 31 | +Dependency support |
| 32 | +~~~~~~~~~~~~~~~~~~ |
| 33 | +Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below: |
| 34 | + |
| 35 | +- Python: 36 months after initial release |
| 36 | +- Core package dependencies (e.g. NumPy): 24 months after initial release |
| 37 | + |
| 38 | +Development |
| 39 | +~~~~~~~~~~~ |
| 40 | +To install the latest development version of Zarr, see `the contributing guide <contributing.html>`_. |
0 commit comments