Installation¶

Python dependencies¶

Python (3.6 or later)
numpy (1.14 or later)
pandas (0.24 or later)
xarray (0.14 or later)
hvplot (0.5 or later)
NetCDF4 (1.53 or later)
panel (0.9.1 or later)

How to install nctoolkit¶

The easiest way to install the package is using conda, which will install nctoolkit and all system dependencies:

$ conda install -c conda-forge nctoolkit

nctoolkit is available from the Python Packaging Index. To install nctoolkit using pip:

$ pip install nctoolkit

If you install nctoolkit from pypi, you will need to install the system dependencies listed below.

To install the development version from GitHub:

$ pip install git+https://github.com/r4ecology/nctoolkit.git

Fixing plotting problem due to xarray bug¶

There is currently a bug in xarray caused by the update of pandas to version 1.1. As a result some plots will fail in nctoolkit. To fix this ensure pandas version 1.0.5 is installed. Do this after installing nctoolkit. This can be done as follows:

$ conda install -c conda-forge pandas=1.0.5

or:

$ pip install pandas==1.0.5

System dependencies¶

There are two main system dependencies: Climate Data Operators, and NCO. The easiest way to install them is using conda:

$ conda install -c conda-forge cdo

$ conda install -c conda-forge nco

CDO is necessary for the package to work. NCO is an optional dependency and does not have to be installed.

If you want to install CDO from source, you can use one of the bash scripts available here.