diff --git a/docs/api/index.rst b/docs/api/index.rst index 8735180cd9..26d7ce0224 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,4 +1,4 @@ -API Reference +API reference ============= .. toctree:: diff --git a/docs/conf.py b/docs/conf.py index 01b7490298..3389c16549 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -107,6 +107,7 @@ def skip_submodules( "getting-started": "quickstart", "release": "developers/release.html", "roadmap": "developers/roadmap.html", + "installation": "user-guide/installation.html", } # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/docs/developers/contributing.rst b/docs/developers/contributing.rst index 7bf37ef1a3..4358230eff 100644 --- a/docs/developers/contributing.rst +++ b/docs/developers/contributing.rst @@ -1,3 +1,5 @@ +.. _dev-guide-contributing: + Contributing to Zarr ==================== diff --git a/docs/index.rst b/docs/index.rst index ffe20e262c..29baf4b94a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,6 @@ Zarr-Python :hidden: quickstart - installation user-guide/index api/index developers/index @@ -18,16 +17,19 @@ Zarr-Python **Version**: |version| -**Download documentation**: `PDF/Zipped HTML `_ - **Useful links**: -`Installation `_ | `Source Repository `_ | `Issue Tracker `_ | `Zulip Chat `_ | `Zarr specifications `_ -Zarr is a file storage format for chunked, compressed, N-dimensional arrays based on an open-source specification. +Zarr-Python is a Python library for reading and writing Zarr groups and arrays. Highlights include: + +* Specification support for both Zarr v2 and v3. +* Create and read from N-dimensional arrays using NumPy-like semantics. +* Flexible storage enables reading and writing from local, cloud and in-memory stores. +* High performance: Enables fast I/O with support for asynchronous I/O and multi-threading. +* Extensible: Customizable with user-defined codecs and stores. .. grid:: 2 @@ -84,7 +86,7 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base :color: dark :click-parent: - To the api reference guide + To the API reference guide .. grid-item-card:: :img-top: _static/index_contribute.svg @@ -104,3 +106,8 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base :click-parent: To the contributor's guide + + +**Download documentation**: `PDF/Zipped HTML `_ + +.. _NumCodecs: https://numcodecs.readthedocs.io 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 a9d1c9fa29..a7bbd12453 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,9 +14,6 @@ User guide config v3_migration -.. Coming soon - installation - 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 `.