From bc88cab2a81f3813e25d96fc9b40034b7de66b45 Mon Sep 17 00:00:00 2001 From: Mathias Hauser Date: Mon, 9 Mar 2020 12:12:08 +0100 Subject: [PATCH 1/4] installing.rst: update instructions --- doc/installing.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index dfc2841a956..6c60c4aca78 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -24,7 +24,7 @@ For netCDF and IO - `h5netcdf `__: an alternative library for reading and writing netCDF4 files that does not use the netCDF-C libraries - `pynio `__: for reading GRIB and other - geoscience specific file formats + geoscience specific file formats. Note that pynio is not available for Windows. - `zarr `__: for chunked, compressed, N-dimensional arrays. - `cftime `__: recommended if you want to encode/decode datetimes for non-standard calendars or dates before @@ -121,16 +121,15 @@ xarray itself is a pure Python package, but its dependencies are not. The easiest way to get everything installed is to use conda_. To install xarray with its recommended dependencies using the conda command line tool:: - $ conda install xarray dask netCDF4 bottleneck + $ conda install -c conda-forge xarray dask netCDF4 bottleneck .. _conda: http://conda.io/ -We recommend using the community maintained `conda-forge `__ channel if you need difficult\-to\-build dependencies such as cartopy, pynio or PseudoNetCDF:: +If you require other `optional dependencies <#Optional dependencies>`_ add them to the line above. - $ conda install -c conda-forge xarray cartopy pynio pseudonetcdf - -New releases may also appear in conda-forge before being updated in the default -channel. +We recommend using the community maintained `conda-forge `__ channel, +as some of the dependencies are difficult to build. New releases may also appear in conda-forge before +being updated in the default channel. If you don't use conda, be sure you have the required dependencies (numpy and pandas) installed first. Then, install xarray with pip:: From c01fdbcdb66716a3d0a56a6090e79336854807eb Mon Sep 17 00:00:00 2001 From: Mathias Hauser Date: Mon, 9 Mar 2020 12:12:30 +0100 Subject: [PATCH 2/4] whats-new --- doc/whats-new.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 00c63b81260..3f04ba4ec57 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -81,6 +81,9 @@ Documentation - Fix documentation of :py:class:`DataArray` removing the deprecated mention that when omitted, `dims` are inferred from a `coords`-dict. (:pull:`3821`) By `Sander van Rijn `_. +- Update the installation instructions: only explicitly list recommended dependencies + (:issue:`3756`). + By `Mathias Hauser `_. Internal Changes ~~~~~~~~~~~~~~~~ From 8181dcf0e441ab5aec8bc043d35a715d72762e57 Mon Sep 17 00:00:00 2001 From: Mathias Hauser Date: Mon, 9 Mar 2020 14:23:19 +0100 Subject: [PATCH 3/4] explicit link and anchor --- doc/installing.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/installing.rst b/doc/installing.rst index 6c60c4aca78..70a28168bb0 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -11,6 +11,8 @@ Required dependencies - `numpy `__ (1.15 or later) - `pandas `__ (0.25 or later) +.. _optional-dependencies: + Optional dependencies --------------------- @@ -125,7 +127,7 @@ with its recommended dependencies using the conda command line tool:: .. _conda: http://conda.io/ -If you require other `optional dependencies <#Optional dependencies>`_ add them to the line above. +If you require other :doc:`optional-dependencies` add them to the line above. We recommend using the community maintained `conda-forge `__ channel, as some of the dependencies are difficult to build. New releases may also appear in conda-forge before From d80e734d43553692d8d5c97ac43581b351d34d92 Mon Sep 17 00:00:00 2001 From: Mathias Hauser Date: Mon, 9 Mar 2020 14:54:38 +0100 Subject: [PATCH 4/4] :doc: -> :ref: --- doc/installing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/installing.rst b/doc/installing.rst index 70a28168bb0..a25bf65e342 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -127,7 +127,7 @@ with its recommended dependencies using the conda command line tool:: .. _conda: http://conda.io/ -If you require other :doc:`optional-dependencies` add them to the line above. +If you require other :ref:`optional-dependencies` add them to the line above. We recommend using the community maintained `conda-forge `__ channel, as some of the dependencies are difficult to build. New releases may also appear in conda-forge before