nctoolkit is a comprehensive Python (3.6 and above) package for analyzing netCDF data on Linux and macOS.
Core abilities include:
- Clipping to spatial regions
- Calculating climatologies
- Subsetting to specific time periods
- Calculating spatial statistics
- Creating new variables using arithmetic operations
- Calculating anomalies
- Calculating rolling and cumulative statistics
- Horizontally and vertically remapping data
- Calculating time averages
- Interactive plotting of data
- Calculating the correlations between variables
- Calculating vertical statistics for the likes of oceanic data
- Calculating ensemble statistics
- Calculating phenological metrics
The easiest way to install the package is using conda. This will install nctoolkit and all system dependencies.
conda install -c conda-forge nctoolkitInstall through PyPI using pip:
pip install nctoolkit Install the development version using using pip:
pip install --force-reinstall git+https://github.com/pmlmodelling/nctoolkit.gitThis 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 Travis (for Linux) and GitHub actions (for Mac OS). It will not work on Windows platforms today or in future, because of system dependency limitations.
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.5A full API reference, in depth tutorials and a how-to guide are available at readthedocs.