From 05033a4769e9d6bfa701013555f4b1f866ed689a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20BRIOL?= Date: Tue, 2 Jul 2024 22:35:44 +0200 Subject: [PATCH] chore: Update tidal model documentation structure --- examples/ex_harmonic_analysis.py | 12 ++++++++---- examples/ex_interpolation.py | 5 +---- examples/ex_mapping.py | 11 ++++++++--- examples/ex_prediction.py | 12 ++++++++---- 4 files changed, 25 insertions(+), 15 deletions(-) diff --git a/examples/ex_harmonic_analysis.py b/examples/ex_harmonic_analysis.py index 88e70f3..9b8a6e9 100644 --- a/examples/ex_harmonic_analysis.py +++ b/examples/ex_harmonic_analysis.py @@ -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 ` +function. First, we import the required modules. """ @@ -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() diff --git a/examples/ex_interpolation.py b/examples/ex_interpolation.py index e5211eb..1937b5c 100644 --- a/examples/ex_interpolation.py +++ b/examples/ex_interpolation.py @@ -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 -`_. +using LGP2 discretization. First, we import the required modules. """ diff --git a/examples/ex_mapping.py b/examples/ex_mapping.py index a003547..fe5b2e7 100644 --- a/examples/ex_mapping.py +++ b/examples/ex_mapping.py @@ -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 -`_. +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 + `_. First, we import the required modules. """ diff --git a/examples/ex_prediction.py b/examples/ex_prediction.py index f8742dc..e569b84 100644 --- a/examples/ex_prediction.py +++ b/examples/ex_prediction.py @@ -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 -`_. +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 + `_. First, we import the required modules. """