Installation¶

Required dependencies¶

Python (3.6 or later)
geopandas (0.6 or later)
numpy (1.17 or later)
pooch (1.0 or later)
rasterio (1.0 or later)
shapely (1.6 or later)
xarray (0.15 or later)

Optional dependencies¶

For plotting¶

matplotlib is required to create any plots.
cartopy for plotting on geographical maps and for downloading natural earth data.

Instructions¶

regionmask itself is a pure Python package, but its dependencies are not. The easiest way to get them installed is to use conda. The package is available on the conda-forge channel.

conda install -c conda-forge regionmask cartopy

All required dependencies can be installed with pip. You can thus install regionmask regionmask directly:

pip install regionmask

Note, however, that the optional dependency cartopy can be very difficult to install with pip.

Testing¶

To run the test suite after installing regionmask, install py.test and run pytest in the root directory of regionmask.

To install the development version (master), do:

pip install git+https://github.com/regionmask/regionmask