From e25c23fee590d998a2e110ec546bfb4e5b38e974 Mon Sep 17 00:00:00 2001 From: Simon Perkins Date: Tue, 10 Sep 2024 21:11:52 +0200 Subject: [PATCH] Document xarray optional dependencies --- doc/source/install.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/source/install.rst b/doc/source/install.rst index 673b00e..ff33e11 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -5,6 +5,14 @@ Installation $ pip install xarray-ms +xarray-ms has a minimal set of dependencies. +If cubed_, dask_ or zarr_ support is required for use with xarray, +they must be installed separately. + +.. code-block:: bash + + pip install cubed dask[array] distributed zarr + Development =========== @@ -57,3 +65,7 @@ build the Sphinx documentation $ poetry shell $ cd doc $ make html + +.. _cubed: https://cubed-dev.github.io/cubed/ +.. _dask: https://www.dask.org/ +.. _zarr: https://zarr.dev/