diff --git a/README.md b/README.md index 9d09ad9..f2121b4 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,16 @@ > [!CAUTION] > This package is a work in progress, and not currently ready for operational use. -The `eo-tides` package contains parallelised tools for modelling ocean tides and combining them with time-series satellite earth observation data. The package builds upon tide modelling functionality from the powerful `pyTMD` package which supports many of the best-performing global tide models (e.g. FES2022, FES2014, TPXO9, EOT20 and many more). Tides can be easily modelled in parallel for multiple models, then combined with satellite data from any location on the planet using Open Data Cube's `odc-stac` or `datacube` packages. +The `eo-tides` package provides tools for analysing coastal and ocean satellite earth observation data using information about ocean tides. + +`eo-tides` combines advanced tide modelling functionality from the [`pyTMD`](https://pytmd.readthedocs.io/en/latest/) package and integrates it with `pandas`, `xarray` and `odc-geo` to provide a powerful set of tools for integrating satellite imagery with tide data. + +Some key functionality includes the ability to: + +- Model tides from multiple global ocean tide models (e.g. FES2022, FES2014, TPXO9, EOT20 and many more) in parallel, and return tide heights in standardised `pandas.DataFrame` format for further analysis +- "Tag" satellite data timeseries with tide data based on the exact moment of each satellite acquisition +- Model tides for every individual satellite pixel, producing three-dimensional "tide height" `xarray`-format datacubes that can be combined 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 + +These tools can be applied directly 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. diff --git a/docs/assets/eo-tides-logo.jpg b/docs/assets/eo-tides-logo.jpg new file mode 100644 index 0000000..f6eae19 Binary files /dev/null and b/docs/assets/eo-tides-logo.jpg differ diff --git a/docs/index.md b/docs/index.md index 0840a75..5ebca2f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,8 @@ -# eo-tides: Tide modelling tools for large-scale satellite earth observation analysis + +# `eo-tides:` Tide modelling tools for large-scale satellite earth observation analysis + + + [![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides) [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain) @@ -9,4 +13,16 @@ Note: This package is a work in progress, and not currently ready for operational use. -The `eo-tides` package contains parallelised tools for modelling ocean tides and combining them with time-series satellite earth observation data. The package builds upon tide modelling functionality from the powerful `pyTMD` package which supports many of the best-performing global tide models (e.g. FES2022, FES2014, TPXO9, EOT20 and many more). Tides can be easily modelled in parallel for multiple models, then combined with satellite data from any location on the planet using Open Data Cube's `odc-stac` or `datacube` packages. +The `eo-tides` package provides tools for analysing coastal and ocean satellite earth observation data using information about ocean tides. + +`eo-tides` combines advanced tide modelling functionality from the [`pyTMD`](https://pytmd.readthedocs.io/en/latest/) package and integrates it with `pandas`, `xarray` and `odc-geo` to provide a powerful set of tools for integrating satellite imagery with tide data. + +Some key functionality includes the ability to: + +- Model tides from multiple global ocean tide models (e.g. FES2022, FES2014, TPXO9, EOT20 and many more) in parallel, and return tide heights in standardised `pandas.DataFrame` format for further analysis +- "Tag" satellite data timeseries with tide data based on the exact moment of each satellite acquisition +- Model tides for every individual satellite pixel, producing three-dimensional "tide height" `xarray`-format datacubes that can be combined 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 + +These tools can be applied directly 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. diff --git a/mkdocs.yml b/mkdocs.yml index f2767d3..c0829d0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,7 +14,7 @@ nav: - Usage examples: # - Overview: usage.md - notebooks/Model_tides.ipynb - - notebooks/Tidal_modelling.ipynb + # - notebooks/Tidal_modelling.ipynb - API reference: api.md plugins: @@ -70,6 +70,13 @@ theme: name: Switch to light mode icon: repo: fontawesome/brands/github + logo: assets/eo-tides-logo.jpg + # features: + # - navigation.instant + # - navigation.tracking + # - navigation.tabs + # - navigation.sections + # - navigation.expand extra: social: