| 
1 | 1 | Installation  | 
2 | 2 | ============  | 
3 | 3 | 
 
  | 
4 |  | -Zarr depends on NumPy. It is generally best to `install NumPy  | 
5 |  | -<https://numpy.org/doc/stable/user/install.html>`_ first using whatever method is most  | 
6 |  | -appropriate for your operating system and Python distribution. Other dependencies should be  | 
7 |  | -installed automatically if using one of the installation methods below.  | 
 | 4 | +pip  | 
 | 5 | +---  | 
8 | 6 | 
 
  | 
9 |  | -Note: Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below:   | 
 | 7 | +.. code-block:: console  | 
10 | 8 | 
  | 
11 |  | -- Python: 36 months after initial release  | 
12 |  | -- Core package dependencies (e.g. NumPy): 24 months after initial release  | 
 | 9 | +    $ pip install zarr  | 
13 | 10 | 
  | 
14 |  | -Install Zarr from PyPI::  | 
 | 11 | +There are a number of optional dependency groups you can install for extra functionality.  | 
 | 12 | +These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"``  | 
15 | 13 | 
 
  | 
16 |  | -    $ pip install zarr  | 
 | 14 | +- ``gpu``: support for GPUs  | 
 | 15 | +- ``fsspec``: support for reading/writing to remote data stores  | 
 | 16 | +- ``tree``: support for pretty printing of directory trees  | 
17 | 17 | 
 
  | 
18 |  | -Alternatively, install Zarr via conda::  | 
 | 18 | +conda  | 
 | 19 | +-----  | 
 | 20 | + | 
 | 21 | +.. code-block:: console  | 
19 | 22 | 
  | 
20 | 23 |     $ conda install -c conda-forge zarr  | 
21 | 24 | 
  | 
22 |  | -To install the latest development version of Zarr, you can use pip with the  | 
23 |  | -latest GitHub main::  | 
 | 25 | +Conda does not support optional dependencies, so you will have to manually install any packages  | 
 | 26 | +needed to enable extra functionality.  | 
 | 27 | + | 
 | 28 | +Dependency support  | 
 | 29 | +------------------  | 
 | 30 | +Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below:  | 
24 | 31 | 
 
  | 
25 |  | -    $ pip install git+https://github.com/zarr-developers/zarr-python.git  | 
 | 32 | +- Python: 36 months after initial release  | 
 | 33 | +- Core package dependencies (e.g. NumPy): 24 months after initial release  | 
26 | 34 | 
 
  | 
27 |  | -To work with Zarr source code in development, see `Contributing <contributing.html>`_.  | 
 | 35 | +Development  | 
 | 36 | +-----------  | 
 | 37 | +To install the latest development version of Zarr, see `the contributing guide <contributing.html>`_.  | 
0 commit comments