|
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. |
8 | | - |
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: |
10 | | - |
11 | | -- Python: 36 months after initial release |
12 | | -- Core package dependencies (e.g. NumPy): 24 months after initial release |
13 | | - |
14 | | -Install Zarr from PyPI: |
| 4 | +From PyPI using pip: |
15 | 5 |
|
16 | 6 | .. code-block:: console |
17 | 7 |
|
18 | 8 | $ pip install zarr |
19 | 9 |
|
20 | | -Alternatively, install Zarr via conda: |
| 10 | +From conda-forge using conda: |
21 | 11 |
|
22 | 12 | .. code-block:: console |
23 | 13 |
|
24 | 14 | $ conda install -c conda-forge zarr |
25 | 15 |
|
26 | | -To install the latest development version of Zarr, you can use pip with the |
27 | | -latest GitHub main: |
| 16 | +Optional dependencies |
| 17 | +--------------------- |
| 18 | +There are a number of optional dependency groups you can install for extra functionality. |
| 19 | +These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"`` |
28 | 20 |
|
29 | | -.. code-block:: console |
| 21 | +- ``gpu``: support for GPUs |
| 22 | +- ``fsspec``: support for reading/writing to remote data stores |
| 23 | +- ``tree``: support for pretty printing of directory trees |
| 24 | + |
| 25 | +Dependency support |
| 26 | +------------------ |
| 27 | +Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below: |
30 | 28 |
|
31 | | - $ pip install git+https://github.com/zarr-developers/zarr-python.git |
| 29 | +- Python: 36 months after initial release |
| 30 | +- Core package dependencies (e.g. NumPy): 24 months after initial release |
32 | 31 |
|
33 | | -To work with Zarr source code in development, see `Contributing <contributing.html>`_. |
| 32 | +Development |
| 33 | +----------- |
| 34 | +To install the latest development version of Zarr, see :ref:`contributing`. |
0 commit comments