Installing NCToolkit

Linux operating systems are supported and tested daily

Install with conda

This is the recommended route: it installs NCToolkit and all of its system dependencies in one go, and it just works out of the box.

shell
conda install -c conda-forge nctoolkit

Don't have conda? Install Miniforge, a minimal conda installer preconfigured to use the conda-forge channel.

Install with pip

NCToolkit is also on the Python Package Index. This installs the core dependencies only — you'll then need to install the system dependencies yourself.

shell
pip install nctoolkit

For slightly better default plots, install with the complete extra, which pulls in optional plotting dependencies:

shell
pip install nctoolkit[complete]

NCToolkit relies on two command-line tools to do its heavy lifting:

The easiest way to install either is with conda:

shell
conda install -c conda-forge cdo
conda install -c conda-forge nco

On Ubuntu, CDO is also available through apt:

shell
sudo apt install cdo

If you installed the non-complete version from PyPI, install cartopy for nicer map plots. Cartopy has some extra system dependencies, so prefer installing it with conda — it resolves the environment far more reliably here than pip:

shell
conda install -c conda-forge cartopy

See cartopy's own installation guide for platform-specific notes.

Installed? Start with the quickstart

See NCToolkit's core features in action with a real sea-surface temperature dataset.