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/contributing.rst b/docs/contributing.rst index 0ead6c8267..a41bb4192d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,3 +1,5 @@ +.. _dev-guide-contributing: + Contributing ============ 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/installation.rst b/docs/installation.rst deleted file mode 100644 index b39b54b250..0000000000 --- a/docs/installation.rst +++ /dev/null @@ -1,37 +0,0 @@ -Installation -============ - -pip ---- - -.. code-block:: console - - $ pip install zarr - -There are a number of optional dependency groups you can install for extra functionality. -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 - -conda ------ - -.. code-block:: console - - $ conda install -c conda-forge zarr - -Conda does not support optional dependencies, so you will have to manually install any packages -needed to enable extra functionality. - -Dependency support ------------------- -Zarr has endorsed `Scientific-Python SPEC 0 `_ and now follows the version support window as outlined below: - -- Python: 36 months after initial release -- Core package dependencies (e.g. NumPy): 24 months after initial release - -Development ------------ -To install the latest development version of Zarr, see `the contributing guide `_. 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/user-guide/installation.rst b/docs/user-guide/installation.rst new file mode 100644 index 0000000000..a79f0763cb --- /dev/null +++ b/docs/user-guide/installation.rst @@ -0,0 +1,54 @@ +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 + +There are a number of optional dependency groups you can install for extra functionality. +These can be installed using ``pip install "zarr[]"``, e.g. ``pip install "zarr[gpu]"`` + +- ``gpu``: support for GPUs +- ``remote``: support for reading/writing to remote data stores + +Additional optional 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 + +Conda does not support optional dependencies, so you will have to manually install any packages +needed to enable extra functionality. + +Dependency support +------------------ +Zarr has endorsed `Scientific-Python SPEC 0 `_ and now follows the version support window as outlined below: + +- Python: 36 months after initial release +- Core package dependencies (e.g. NumPy): 24 months after initial release + +Development +----------- +To install the latest development version of Zarr, see the :ref:`contributing guide `.