Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document xarray optional dependencies #8

Merged
merged 1 commit into from
Sep 10, 2024
Merged

Document xarray optional dependencies #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions doc/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
===========

Expand Down Expand Up @@ -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/
Loading