Ocetrac documentation#

https://github.com/ocetrac/ocetrac/workflows/Tests/badge.svg https://codecov.io/gh/ocetrac/ocetrac/branch/main/graph/badge.svg https://img.shields.io/badge/License-MIT-lightgray.svg?style=flat-square https://img.shields.io/pypi/v/ocetrac.svg https://img.shields.io/conda/dn/conda-forge/ocetrac?label=conda-forge https://readthedocs.org/projects/ocetrac/badge/?version=latest

Welcome to the documentation of Ocetrac! Ocetrac is a Python toolkit for labelling and tracking the evolution of geospatial features in gridded datasets. It is designed to operate lazily using Dask, enabling memory-efficient and parallelised compuation on large datasets. Ocetrac provides two core tracking algorithms:

  • SurfTrack — surface features with dimensions (time, lat, lon)

  • DeepTrack — subsurface volumetric features with dimensions (time, depth, lat, lon)

Ocetrac feature animation

With Ocetrac, users can track a wide range of phenomena, including marine heatwaves, cold spells, phytoplankton blooms, and other time-evolving features in gridded data. The documentation includes everything needed to get started, from installation instructions to detailed API references and usage examples.

For recommendations or bug reports, please file an issue on GitHub: ocetrac/ocetrac#new. If you are interested in contributing to the codebase, please see the contributing guidelines. If you need more help with Parcels, try the Discussions page on GitHub.