|
| 1 | +Installation |
| 2 | +============ |
| 3 | + |
| 4 | +Required dependencies |
| 5 | +--------------------- |
| 6 | + |
| 7 | +Required dependencies include: |
| 8 | + |
| 9 | +- `Python <https://docs.python.org/3/>`_ (3.11 or later) |
| 10 | +- `packaging <https://packaging.pypa.io>`_ (22.0 or later) |
| 11 | +- `numpy <https://numpy.org>`_ (1.25 or later) |
| 12 | +- `numcodecs[crc32c] <https://numcodecs.readthedocs.io>`_ (0.14 or later) |
| 13 | +- `typing_extensions <https://typing-extensions.readthedocs.io>`_ (4.9 or later) |
| 14 | +- `donfig <https://donfig.readthedocs.io>`_ (0.8 or later) |
| 15 | + |
| 16 | +pip |
| 17 | +--- |
| 18 | + |
| 19 | +Zarr is available on `PyPI <https://pypi.org/project/zarr/>`_. Install it using ``pip``: |
| 20 | + |
| 21 | +.. code-block:: console |
| 22 | +
|
| 23 | + $ pip install zarr |
| 24 | +
|
| 25 | +There are a number of optional dependency groups you can install for extra functionality. |
| 26 | +These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"`` |
| 27 | + |
| 28 | +- ``gpu``: support for GPUs |
| 29 | +- ``remote``: support for reading/writing to remote data stores |
| 30 | + |
| 31 | +Additional optional dependencies include ``rich``, ``universal_pathlib``. These must be installed separately. |
| 32 | + |
| 33 | +conda |
| 34 | +----- |
| 35 | + |
| 36 | +Zarr is also published to `conda-forge <https://conda-forge.org>`_. Install it using ``conda``: |
| 37 | + |
| 38 | +.. code-block:: console |
| 39 | +
|
| 40 | + $ conda install -c conda-forge zarr |
| 41 | +
|
| 42 | +Conda does not support optional dependencies, so you will have to manually install any packages |
| 43 | +needed to enable extra functionality. |
| 44 | + |
| 45 | +Dependency support |
| 46 | +------------------ |
| 47 | +Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below: |
| 48 | + |
| 49 | +- Python: 36 months after initial release |
| 50 | +- Core package dependencies (e.g. NumPy): 24 months after initial release |
| 51 | + |
| 52 | +Development |
| 53 | +----------- |
| 54 | +To install the latest development version of Zarr, see the :ref:`contributing guide <dev-guide-contributing>`. |
0 commit comments