README

How to cite code?

Zenodo provide DOI for each tagged version, all DOI are available here

Method

Method was described in :

Pegliasco, C., Delepoulle, A., Morrow, R., Faugère, Y., and Dibarboure, G.: META3.1exp : A new Global Mesoscale Eddy Trajectories Atlas derived from altimetry, Earth Syst. Sci. Data Discuss.

Mason, E., A. Pascual, and J. C. McWilliams, 2014: A new sea surface height–based code for oceanic mesoscale eddy tracking.

Use case

Method is used in :

Mason, E., A. Pascual, P. Gaube, S.Ruiz, J. Pelegrí, A. Delepoulle, 2017: Subregional characterization of mesoscale eddies across the Brazil-Malvinas Confluence

How do I get set up?

Short story

pip install pyeddytracker

Long story

To avoid problems with installation, use of the virtualenv Python virtual environment is recommended.

Then use pip to install all dependencies (numpy, scipy, matplotlib, netCDF4, ...), e.g.:

pip install numpy scipy netCDF4 matplotlib opencv-python pyyaml pint polygon3

Clone :

git clone https://github.com/AntSimi/py-eddy-tracker

Then run the following to install the eddy tracker :

python setup.py install

Tools gallery

Several examples based on py eddy tracker module are here.

Quick use

EddyId share/nrt_global_allsat_phy_l4_20190223_20190226.nc 20190223 adt ugos vgos longitude latitude ./ -v INFO

for identification, followed by:

EddyTracking tracking.yaml

for tracking (Edit the corresponding yaml files and then run the code).