Mohima17/trackeddy

Tracking eddy algorithm:

TrackEddy (Eddy Identification Algorithm)

Travis CI (Python 3.6)	Read the Docs	Code Coverage

Supports Python 2.7 and Python 3 This code will let you identify and track any normal shape in a 2D space. The principal objective of this development is finding and tracking all the eddies in the ocean.

v1.0 Release:

The source code supports the extraction of eddies each time step and moving in vertical coordinate Z.

Installing TrackEddy

1. Make a new directory where you want the repository.
2. Clone the TrackEddy repository from Github. In the command prompt, type: git clone https://github.com/Josue-Martinez-Moreno/trackeddy.git
3. Install the package globally: pip install -e . This make the package an editable install so that it can be updated with future additions to TrackEddy. To instead install the package locally: pip install --user .

Updating TrackEddy

1. Move into your TrackEddy directory.
2. Update your GitHub repository. git pull
3. Edit your install of TrackEddy. pip install -e . or pip install --force-reinstall -e . or, for local installation: pip install --ignore-installed --user .

Read more about TrackEddy in

• Martínez-Moreno, J., Hogg, A. McC., Kiss, A. E., Constantinou, N. C., and Morrison, A. K. (2019). Kinetic energy of eddy-like features from sea surface altimetry. Journal of Advances in Modeling Earth Systems, 11(10), 3090-3105. doi:10.1029/2019MS001769

References:

• Faghmous, J. H., Frenger, I., Yao, Y., Warmka, R., Lindell, A., & Kumar, V. (2015). A daily global mesoscale ocean eddy dataset from satellite altimetry. Scientific Data, 2, 150028.
• Chang, Y. L., & Oey, L. Y. (2014). Analysis of STCC eddies using the Okubo–Weiss parameter on model and satellite data. Ocean Dynamics, 64(2), 259-271.
• Chelton, D. B., Schlax, M. G., Samelson, R. M., & de Szoeke, R. A. (2007). Global observations of large oceanic eddies. Geophysical Research Letters, 34(15), L15606.