eddytools

Python package to detect, track, sample, cluster, and average eddies and their properties based on ocean model output from the NEMO model on ORCA grids and the MITgcm on cartesian grids. The detection can be based on the Okubo-Weiss parameter or Sea Surface Height.

Based on work by Tobias Schulzki, Klaus Getzlaff and Rafael Abel. The original algorithm was implemented by Eric Oliver and further developed by Christopher Bull. It is based on the algorithm described in Chelton et al. (2011). The original eddy detection and tracking routines are described in Oliver et al. (2015). The contributions by Tobias Schulzki, Klaus Getzlaff and Rafael Abel are documented here.

The package works based on output loaded with load_xorca_dataset from the xorca module (for NEMO model output) or xmitgcm (for MITgcm model output) and additionally requires xgcm.

Install a minimal environment

# clone the git repository
git clone https://github.com/jk-rieck/eddytools.git
cd eddytools
# create and activate the environment
conda env create -f environment.yml
conda activate py3_eddy
# install modules not installed through environment.yml
pip install git+https://github.com/willirath/xorca.git@master
# install eddytools
pip install -e .

Install in existing environment

1. Make sure you have python 3, numpy, scipy, pandas, xarray, xesmf, xgcm, xorca, operator and pip installed.

2. Install from the repository using

pip install git+https://github.com/jk-rieck/eddytools.git@main

Usage

See the example notebooks for the different cases:

use case
ORCA Okubo-Weiss
ORCA SSH
MITgcm Okubo-Weiss
MITgcm SSH