Giter Club home page Giter Club logo

trackeddy's Introduction

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:

Now the source code supports the extraction of eddies each time step and moving in Z.

Alt Text

To get the code

  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 .

To update the code later

  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 .

To test the code

Work in progress!

To learn more about the module TrackEddy

  • 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, 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.

trackeddy's People

Contributors

josuemtzmo avatar navidcy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.