Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _contributing:

Contributing
============

Expand Down
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Zarr-Python
release
contributing
roadmap
installation

**Version**: |version|

Expand Down
37 changes: 0 additions & 37 deletions docs/installation.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/user-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ User Guide
.. toctree::
:maxdepth: 1

installation
arrays
groups
attributes
storage
config

.. Coming soon
installation
v3_migration

Advanced Topics
Expand Down
54 changes: 54 additions & 0 deletions docs/user-guide/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Installation
============

Required dependencies
---------------------

Required dependencies include:

- `Python <https://docs.python.org/3/>`_ (3.11 or later)
- `packaging <https://packaging.pypa.io>`_ (22.0 or later)
- `numpy <https://numpy.org>`_ (1.25 or later)
- `numcodecs[crc32c] <https://numcodecs.readthedocs.io>`_ (0.14 or later)
- `typing_extensions <https://typing-extensions.readthedocs.io>`_ (4.9 or later)
- `donfig <https://donfig.readthedocs.io>`_ (0.8 or later)

pip
---

Zarr is available on `PyPI <https://pypi.org/project/zarr/>`_. 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[<extra>]"``, 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 <https://conda-forge.org>`_. 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 <https://scientific-python.org/specs/spec-0000/>`_ 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 <contributing>`.
Loading