nctoolkit is a comprehensive Python (3.8 and above) package for analyzing netCDF data on Linux and macOS.
Core abilities include:
The easiest way to install the package is using conda or mamba. This will install nctoolkit and all system dependencies.
conda install -c conda-forge nctoolkit
mamba install -c conda-forge nctoolkit
If you install using conda, please be aware that conda can install a very old version of nctoolkit. Consider setting it to a more recent version.
Install through PyPI using pip:
pip install nctoolkit
Install the development version using using pip:
pip install git+https://github.com/pmlmodelling/nctoolkit.git
This package requires the installation of Climate Data Operators. The conda installation will handle this for you. Otherwise, you will have to install it. The easiest way is using conda:
conda install -c conda-forge cdo
A couple of methods give users the option of using NetCDF Operators instead of CDO as the computational backend. Again, the easiest way to install is using conda:
conda install -c conda-forge nco
If you want to install CDO from source, bash scripts are available here.
nctoolkit is tested with continuous integration using Circle CI (for Linux) and GitHub actions (for Mac OS). It will not work on Windows platforms today or in future, because of system dependency limitations.
A full API reference, in depth tutorials and a how-to guide are available at readthedocs.
If you are interesting in contributing to nctoolkit feel free to read the Contributing page.