Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.7 KB

installing.rst

File metadata and controls

84 lines (59 loc) · 2.7 KB

Installation

Required dependencies

  • Python 2.7, 3.4, 3.5, or 3.6
  • numpy (1.11 or later)
  • pandas (0.18.0 or later)

Optional dependencies

For netCDF and IO

  • netCDF4: recommended if you want to use xarray for reading or writing netCDF files
  • scipy: used as a fallback for reading/writing netCDF3
  • pydap: used as a fallback for accessing OPeNDAP
  • 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

For accelerating xarray

  • bottleneck: speeds up NaN-skipping and rolling window aggregations by a large factor (1.1 or later)
  • cyordereddict: speeds up most internal operations with xarray data structures (for python versions < 3.5)

For parallel computing

For plotting

Instructions

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

We recommend using the community maintained conda-forge channel if you need difficult-to-build dependencies such as cartopy or pynio:

$ conda install -c conda-forge xarray cartopy pynio

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:

$ pip install xarray

Testing

To run the test suite after installing xarray, first install (via pypi or conda) - py.test: Simple unit testing library - mock: additional testing library required for python version 2

and run py.test --pyargs xarray.