Skip to content

eo‐tides package structure

Robbi Bishop-Taylor edited this page Nov 2, 2024 · 1 revision

The diagram below shows eo-tides' main functions and how they relate to each other. For example, the model_tides function uses external tide model data and the pyTMD Python package to model tides, while pixel_tides combines those modelled tides with external satellite data:

flowchart LR
    
    SD[("Satellite data")] --> PT 
    TMD[("Tide model data")] --> MT
    PD("<a href="https://pytmd.readthedocs.io/en/latest/getting_started/Overview.html">pyTMD</a>") --> MT
    
    SD --> TT

    subgraph "<big>eo-tides</big>"
        MT("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.model.model_tides"><code>model_tides</code></a>")
        MP("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.model.model_phases"><code>model_phases</code></a>")
        TT("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.eo.tag_tides"><code>tag_tides</code></a>")
        PT("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.eo.pixel_tides"><code>pixel_tides</code></a>")
        TS("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.stats.tide_stats"><code>tide_stats</code></a>")
        PS("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.stats.pixel_stats"><code>pixel_stats</code></a>")
        LG("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.validation.load_gauge_gesla"><code>load_gauge_gesla</code></a>")
        LM("<a href="https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.model.list_models"><code>list_models</code></a>")

        MT --> MP
        MT --> PT --> PS
        MT --> TT --> TS

    end
Loading