Skip to content

Commit 633aa11

Browse files
authored
Update "Installation" docs page (#944)
- List all optional dependencies - Clarify when conda-forge is recommended CC ocefpaf jhamman
1 parent b072741 commit 633aa11

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

doc/installing.rst

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Installation
66
Required dependencies
77
---------------------
88

9-
- Python 2.7, 3.3, 3.4 or 3.5.
9+
- Python 2.7, 3.3, 3.4 or 3.5
1010
- `numpy <http://www.numpy.org/>`__ (1.7 or later)
1111
- `pandas <http://pandas.pydata.org/>`__ (0.15.0 or later)
1212

@@ -22,6 +22,8 @@ For netCDF and IO
2222
- `pydap <http://www.pydap.org/>`__: used as a fallback for accessing OPeNDAP
2323
- `h5netcdf <https://github.com/shoyer/h5netcdf>`__: an alternative library for
2424
reading and writing netCDF4 files that does not use the netCDF-C libraries
25+
- `pynio <https://www.pyngl.ucar.edu/Nio.shtml>`__`: for reading GRIB and other
26+
geoscience specific file formats
2527

2628
For accelerating xarray
2729
~~~~~~~~~~~~~~~~~~~~~~~
@@ -39,31 +41,38 @@ For parallel computing
3941
For plotting
4042
~~~~~~~~~~~~
4143

42-
- `matplotlib <http://matplotlib.org/>`__: required for :ref:`plotting`.
44+
- `matplotlib <http://matplotlib.org/>`__: required for :ref:`plotting`
4345
- `cartopy <http://scitools.org.uk/cartopy/>`__: recommended for
44-
:ref:`plot-maps`.
46+
:ref:`plot-maps`
47+
- `seaborn <https://stanford.edu/~mwaskom/software/seaborn/>`__: for better
48+
color palettes
4549

4650

4751
Instructions
4852
------------
4953

5054
xarray itself is a pure Python package, but its dependencies are not. The
51-
easiest way to get them installed is to use conda_. You can then install xarray
52-
with its recommended dependencies with the conda command line tool::
55+
easiest way to get everything installed is to use conda_. To install xarray
56+
with its recommended dependencies using the conda command line tool::
5357

5458
$ conda install xarray dask netCDF4 bottleneck
5559

5660
.. _conda: http://conda.io/
5761

58-
.. note::
59-
You might consider using the
60-
`conda-forge <https://conda-forge.github.io/>`__ channel, as it has been
61-
shown to be more up-to-date and to better handle package dependencies.
62+
We recommend using the community maintained
63+
`conda-forge <https://conda-forge.github.io/>`__ channel if you need difficult
64+
to build dependencies such as cartopy or pynio:
65+
66+
$ conda install -c conda-forge xarray cartopy pynio
67+
68+
New releases may also appear in conda-forge before being updated in the default
69+
channel.
6270

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

6674
$ pip install xarray
6775

6876
To run the test suite after installing xarray, install
69-
`py.test <https://pytest.org>`__ and run ``py.test xarray``.
77+
`py.test <https://pytest.org>`__ (``pip install pytest``) and run
78+
``py.test xarray``.

0 commit comments

Comments
 (0)