From e8b6ad645e72a329069225c6f30e5f69931b560b Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Sun, 29 Dec 2024 15:02:07 -0700 Subject: [PATCH 1/3] docs: update installation docs --- docs/conf.py | 1 + docs/index.rst | 1 - docs/user-guide/index.rst | 2 +- docs/{ => user-guide}/installation.rst | 23 ++++++++++++++++++++--- 4 files changed, 22 insertions(+), 5 deletions(-) rename docs/{ => user-guide}/installation.rst (51%) diff --git a/docs/conf.py b/docs/conf.py index e66a8a8560..cc10390b49 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,6 +91,7 @@ "spec/v3": "https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html", "license": "https://github.com/zarr-developers/zarr-python/blob/main/LICENSE.txt", "tutorial": "user-guide", + "installation": "user-guide/installation.html", } # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/docs/index.rst b/docs/index.rst index 02424d9977..e81be406e9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,6 @@ Zarr-Python release contributing roadmap - installation **Version**: |version| diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst index d9d79a7f98..61da35e904 100644 --- a/docs/user-guide/index.rst +++ b/docs/user-guide/index.rst @@ -6,6 +6,7 @@ User Guide .. toctree:: :maxdepth: 1 + installation arrays groups attributes @@ -13,7 +14,6 @@ User Guide config .. Coming soon - installation v3_migration Advanced Topics diff --git a/docs/installation.rst b/docs/user-guide/installation.rst similarity index 51% rename from docs/installation.rst rename to docs/user-guide/installation.rst index b39b54b250..d43147643f 100644 --- a/docs/installation.rst +++ b/docs/user-guide/installation.rst @@ -1,9 +1,23 @@ Installation ============ +Required dependencies +--------------------- + +Required dependencies include: + +- `Python `_ (3.11 or later) +- `packaging `_ (22.0 or later) +- `numpy `_ (1.25 or later) +- `numcodecs[crc32c] `_ (0.14 or later) +- `typing_extensions `_ (4.9 or later) +- `donfig `_ (0.8 or later) + pip --- +Zarr is available on `PyPI `_. Install it using ``pip``: + .. code-block:: console $ pip install zarr @@ -12,12 +26,15 @@ There are a number of optional dependency groups you can install for extra funct These can be installed using ``pip install "zarr[]"``, e.g. ``pip install "zarr[gpu]"`` - ``gpu``: support for GPUs -- ``fsspec``: support for reading/writing to remote data stores -- ``tree``: support for pretty printing of directory trees +- ``remote``: support for reading/writing to remote data stores + +Additional option dependencies include ``rich``, ``universal_pathlib``. These must be installed separately. conda ----- +Zarr is also published to `conda-forge `_. Install it using ``conda``: + .. code-block:: console $ conda install -c conda-forge zarr @@ -34,4 +51,4 @@ Zarr has endorsed `Scientific-Python SPEC 0 `_. +To install the latest development version of Zarr, see `the contributing guide <../developers/contributing.html>`_. From 8d46e588229e4c0a67fef0dda9ee30d7a5e2b750 Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Wed, 1 Jan 2025 13:34:20 -0800 Subject: [PATCH 2/3] fixups --- docs/contributing.rst | 2 ++ docs/user-guide/installation.rst | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 0ead6c8267..6dd7923f8d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,3 +1,5 @@ +.. _contributing: + Contributing ============ diff --git a/docs/user-guide/installation.rst b/docs/user-guide/installation.rst index d43147643f..1619c5646f 100644 --- a/docs/user-guide/installation.rst +++ b/docs/user-guide/installation.rst @@ -28,7 +28,7 @@ These can be installed using ``pip install "zarr[]"``, e.g. ``pip install - ``gpu``: support for GPUs - ``remote``: support for reading/writing to remote data stores -Additional option dependencies include ``rich``, ``universal_pathlib``. These must be installed separately. +Additional optional dependencies include ``rich``, ``universal_pathlib``. These must be installed separately. conda ----- @@ -51,4 +51,4 @@ Zarr has endorsed `Scientific-Python SPEC 0 `_. +To install the latest development version of Zarr, see the :ref:`contributing guide `. From bd4a40804e717e6f46a94024e6cd8afe430f5cba Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Wed, 1 Jan 2025 14:56:32 -0800 Subject: [PATCH 3/3] fix ref to contributing guide --- docs/contributing.rst | 2 +- docs/user-guide/installation.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 6dd7923f8d..a41bb4192d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,4 +1,4 @@ -.. _contributing: +.. _dev-guide-contributing: Contributing ============ diff --git a/docs/user-guide/installation.rst b/docs/user-guide/installation.rst index 1619c5646f..a79f0763cb 100644 --- a/docs/user-guide/installation.rst +++ b/docs/user-guide/installation.rst @@ -51,4 +51,4 @@ Zarr has endorsed `Scientific-Python SPEC 0 `. +To install the latest development version of Zarr, see the :ref:`contributing guide `.