Skip to main content

Tide modelling tools for large-scale satellite earth observation analysis

Project description

eo-tides: Tide modelling tools for large-scale satellite earth observation analysis

eo-tides logo

Release Build status Python Version from PEP 621 TOML codecov License status


eo-tides provides powerful parallelized tools for integrating satellite Earth observation data with tide modelling. 🛠️🌊🛰️

eo-tides combines advanced tide modelling functionality from the pyTMD package with pandas, xarray and odc-geo, providing a suite of flexible tools for efficient analysis of coastal and ocean Earth observation data – from regional, continental, to global scale.

These tools can be applied to petabytes of freely available satellite data (e.g. from Digital Earth Australia or Microsoft Planetary Computer) loaded via Open Data Cube's odc-stac or datacube packages, supporting coastal and ocean earth observation analysis for any time period or location globally.

eo-tides abstract showing satellite data, tide data array and tide animation

Highlights

  • 🌊 Model tide heights and phases (e.g. high, low, ebb, flow) from multiple global ocean tide models in parallel, and return a pandas.DataFrame for further analysis
  • 🛰️ "Tag" satellite data with tide heights based on the exact moment of image acquisition
  • 🌐 Model tides for every individual satellite pixel through time, producing three-dimensional "tide height" xarray-format datacubes that can be integrated with satellite data
  • 📈 Calculate statistics describing local tide dynamics, as well as biases caused by interactions between tidal processes and satellite orbits
  • 🛠️ Validate modelled tides using measured sea levels from coastal tide gauges (e.g. GESLA Global Extreme Sea Level Analysis)

Supported tide models

eo-tides supports all ocean tide models supported by pyTMD. These include:

For instructions on how to set up these models for use in eo-tides, refer to Setting up tide models.

Installing and setting up eo-tides

To get started with eo-tides, follow the Installation and Setting up tide models guides.

Jupyter Notebooks code examples

Interactive Jupyter Notebook usage examples and more complex coastal EO case studies can be found in the docs/notebooks/ directory, or rendered in the documentation here.

Citing eo-tides

To cite eo-tides in your work, please use the following citation:

Bishop-Taylor, R., Sagar, S., Phillips, C., & Newey, V. (2024). eo-tides: Tide modelling tools for large-scale satellite earth observation analysis. https://github.com/GeoscienceAustralia/eo-tides

In addition, please consider also citing the underlying pyTMD Python package which powers the tide modelling functionality behind eo-tides:

Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395

Contributing

We welcome contributions to eo-tides, both through posting issues (e.g. bug reports or feature suggestions), or directly via pull requests (e.g. bug fixes and new features). Read the Contributing guide for details about how you can get involved.

Acknowledgements

For a full list of acknowledgements, refer to Citations and Credits. This repository was initialised using the cookiecutter-uv package.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eo_tides-0.7.2.dev1.tar.gz (18.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eo_tides-0.7.2.dev1-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file eo_tides-0.7.2.dev1.tar.gz.

File metadata

  • Download URL: eo_tides-0.7.2.dev1.tar.gz
  • Upload date:
  • Size: 18.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.0

File hashes

Hashes for eo_tides-0.7.2.dev1.tar.gz
Algorithm Hash digest
SHA256 7ce17c66dfef554811748deef3474476273758a32657ce5bc5b86ad305553d63
MD5 65200ce33b0a31a7d89c4fa6683b5a1e
BLAKE2b-256 dfc3e86de048ffce463a26759e0946ee094eed91fa3835c71d6f763765624b8e

See more details on using hashes here.

File details

Details for the file eo_tides-0.7.2.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for eo_tides-0.7.2.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b28166418fcbe5f55a9b7338f34bce6185657f366398d6d62eec7ee5207cac2
MD5 800848c987bad6c9510a8b594c3b6abc
BLAKE2b-256 81ddb9291d2745d02de12a5eb96c43b5d84e02fa4263ba39f17ce820a6cc661f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page