Skip to content

Commit 56ad09c

Browse files
committed
Clean up installation page
1 parent 08d1631 commit 56ad09c

File tree

2 files changed

+20
-17
lines changed

2 files changed

+20
-17
lines changed

docs/contributing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _contributing:
2+
13
Contributing to Zarr
24
====================
35

docs/installation.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
11
Installation
22
============
33

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:
155

166
.. code-block:: console
177
188
$ pip install zarr
199
20-
Alternatively, install Zarr via conda:
10+
From conda-forge using conda:
2111

2212
.. code-block:: console
2313
2414
$ conda install -c conda-forge zarr
2515
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]"``
2820

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:
3028

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
3231

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

Comments
 (0)