Skip to content

Commit

Permalink
chore: Update tidal model documentation structure
Browse files Browse the repository at this point in the history
  • Loading branch information
fbriol committed Jul 2, 2024
1 parent be0a469 commit 05033a4
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 15 deletions.
12 changes: 8 additions & 4 deletions examples/ex_harmonic_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
Harmonic Analysis
*****************
This example demonstrates how to perform harmonic analysis on a signal using
the :func:`pyfes.harmonic_analysis` function.
This example demonstrates how to perform harmonic analysis on a signal using the
:func:`harmonic_analysis <pyfes.wave_table.WaveTable.harmonic_analysis>`
function.
First, we import the required modules.
"""
Expand Down Expand Up @@ -84,7 +85,10 @@
h_tide = wt.tide_from_tide_series(time, leap_seconds, w)

# %%
# Finally, the result can be compared with the original time series:
# Finally, we can visualize the original signal's height adjusted by the tidal
# height derived from harmonic analysis. The outcome is zero because the
# analyzed signal originates from the tidal model using identical
# waves as those in the harmonic analysis.
matplotlib.pyplot.plot(time, h, label='Original')
matplotlib.pyplot.plot(time, h_tide, label='Tide')
matplotlib.pyplot.plot(time, h - h_tide, label='Corrected height')
matplotlib.pyplot.legend()
5 changes: 1 addition & 4 deletions examples/ex_interpolation.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@
******************
This example demonstrates how to interpolate a tidal model stored in a mesh
using LGP2 discretization. The model used is an old FES tidel-atlas model. Do
not use it for real applications. You can download the model from the AVISO
`website
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_.
using LGP2 discretization.
First, we import the required modules.
"""
Expand Down
11 changes: 8 additions & 3 deletions examples/ex_mapping.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@
********************
In this example, we will use the model to predict the tidal elevation on a
global grid. The model used is an old FES tidel-atlas model. Do not use it for
real applications. You can download the model from the AVISO `website
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_.
global grid.
.. warning::
The model employed is an older FES tidal-atlas model due to its
significantly smaller size compared to newer models. **Do not use it for
real applications**. You can download the model from the `AVISO website
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_.
First, we import the required modules.
"""
Expand Down
12 changes: 8 additions & 4 deletions examples/ex_prediction.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
******************
In this example, we will use the model to predict the tidal elevation on a
specific location, like a tide gauge. The model used is an old FES tidel-atlas
model. Do not use it for real applications. You can download the model from the
AVISO `website
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_.
specific location, like a tide gauge.
.. warning::
The model employed is an older FES tidal-atlas model due to its
significantly smaller size compared to newer models. **Do not use it for
real applications**. You can download the model from the `AVISO website
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_.
First, we import the required modules.
"""
Expand Down

0 comments on commit 05033a4

Please sign in to comment.