josuemtzmo / trackeddy

Tracking eddy algorithm:
http://trackeddy.readthedocs.io/
MIT License
48 stars 18 forks source link
eddies eddy extraction ocean oceanic-eddies

TrackEddy (Eddy Identification Algorithm)

Travis CI (Python 3.6) Read the Docs Code Coverage
Build Status Documentation Status codecov

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.

Alt Text

v1.0 Release:

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

Alt Text

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

References: