Skip to content

Commit e8b6ad6

Browse files
committed
docs: update installation docs
1 parent d2bdb64 commit e8b6ad6

File tree

4 files changed

+22
-5
lines changed

4 files changed

+22
-5
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
"spec/v3": "https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html",
9292
"license": "https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt",
9393
"tutorial": "user-guide",
94+
"installation": "user-guide/installation.html",
9495
}
9596

9697
# The language for content autogenerated by Sphinx. Refer to documentation

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Zarr-Python
1414
release
1515
contributing
1616
roadmap
17-
installation
1817

1918
**Version**: |version|
2019

docs/user-guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ User Guide
66
.. toctree::
77
:maxdepth: 1
88

9+
installation
910
arrays
1011
groups
1112
attributes
1213
storage
1314
config
1415

1516
.. Coming soon
16-
installation
1717
v3_migration
1818
1919
Advanced Topics

docs/installation.rst renamed to docs/user-guide/installation.rst

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
Installation
22
============
33

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+
416
pip
517
---
618

19+
Zarr is available on `PyPI <https://pypi.org/project/zarr/>`_. Install it using ``pip``:
20+
721
.. code-block:: console
822
923
$ pip install zarr
@@ -12,12 +26,15 @@ There are a number of optional dependency groups you can install for extra funct
1226
These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"``
1327

1428
- ``gpu``: support for GPUs
15-
- ``fsspec``: support for reading/writing to remote data stores
16-
- ``tree``: support for pretty printing of directory trees
29+
- ``remote``: support for reading/writing to remote data stores
30+
31+
Additional option dependencies include ``rich``, ``universal_pathlib``. These must be installed separately.
1732

1833
conda
1934
-----
2035

36+
Zarr is also published to `conda-forge <https://conda-forge.org>`_. Install it using ``conda``:
37+
2138
.. code-block:: console
2239
2340
$ conda install -c conda-forge zarr
@@ -34,4 +51,4 @@ Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs
3451

3552
Development
3653
-----------
37-
To install the latest development version of Zarr, see `the contributing guide <contributing.html>`_.
54+
To install the latest development version of Zarr, see `the contributing guide <../developers/contributing.html>`_.

0 commit comments

Comments
 (0)