Skip to content

Commit 1db010b

Browse files
authored
update installation instruction (#3849)
* installing.rst: update instructions * whats-new * explicit link and anchor * :doc: -> :ref:
1 parent 9f97c43 commit 1db010b

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

doc/installing.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Required dependencies
1111
- `numpy <http://www.numpy.org/>`__ (1.15 or later)
1212
- `pandas <http://pandas.pydata.org/>`__ (0.25 or later)
1313

14+
.. _optional-dependencies:
15+
1416
Optional dependencies
1517
---------------------
1618

@@ -24,7 +26,7 @@ For netCDF and IO
2426
- `h5netcdf <https://github.com/shoyer/h5netcdf>`__: an alternative library for
2527
reading and writing netCDF4 files that does not use the netCDF-C libraries
2628
- `pynio <https://www.pyngl.ucar.edu/Nio.shtml>`__: for reading GRIB and other
27-
geoscience specific file formats
29+
geoscience specific file formats. Note that pynio is not available for Windows.
2830
- `zarr <http://zarr.readthedocs.io/>`__: for chunked, compressed, N-dimensional arrays.
2931
- `cftime <https://unidata.github.io/cftime>`__: recommended if you
3032
want to encode/decode datetimes for non-standard calendars or dates before
@@ -121,16 +123,15 @@ xarray itself is a pure Python package, but its dependencies are not. The
121123
easiest way to get everything installed is to use conda_. To install xarray
122124
with its recommended dependencies using the conda command line tool::
123125

124-
$ conda install xarray dask netCDF4 bottleneck
126+
$ conda install -c conda-forge xarray dask netCDF4 bottleneck
125127

126128
.. _conda: http://conda.io/
127129

128-
We recommend using the community maintained `conda-forge <https://conda-forge.github.io/>`__ channel if you need difficult\-to\-build dependencies such as cartopy, pynio or PseudoNetCDF::
129-
130-
$ conda install -c conda-forge xarray cartopy pynio pseudonetcdf
130+
If you require other :ref:`optional-dependencies` add them to the line above.
131131

132-
New releases may also appear in conda-forge before being updated in the default
133-
channel.
132+
We recommend using the community maintained `conda-forge <https://conda-forge.github.io/>`__ channel,
133+
as some of the dependencies are difficult to build. New releases may also appear in conda-forge before
134+
being updated in the default channel.
134135

135136
If you don't use conda, be sure you have the required dependencies (numpy and
136137
pandas) installed first. Then, install xarray with pip::

doc/whats-new.rst

+3
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ Documentation
8181
- Fix documentation of :py:class:`DataArray` removing the deprecated mention
8282
that when omitted, `dims` are inferred from a `coords`-dict. (:pull:`3821`)
8383
By `Sander van Rijn <https://github.com/sjvrijn>`_.
84+
- Update the installation instructions: only explicitly list recommended dependencies
85+
(:issue:`3756`).
86+
By `Mathias Hauser <https://github.com/mathause>`_.
8487

8588
Internal Changes
8689
~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)