-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Update tidal model documentation structure
- Loading branch information
Showing
1 changed file
with
45 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,52 @@ | ||
PyFES documentation | ||
=================== | ||
|
||
This package is the fully revised version of the FES2022 distribution. A full | ||
description of the FES2022 tidal solution is given in the `handbook | ||
<https://www.aviso.altimetry.fr/fileadmin/documents/data/tools/hdbk_FES2022.pdf>`_ | ||
and in the paper (Lyard et al. 2024). | ||
|
||
The library uses a set of tidal components to predict the ocean tide at any | ||
location on the Earth. The source code provides an older version of the FES | ||
model (99), because it is significantly smaller than newer versions. **Do not | ||
use it for scientific purposes**. You can download the model from the `AVISO | ||
<https://www.aviso.altimetry.fr/en/data/products/auxiliary-products/global-tide-fes.html>`_ | ||
website. | ||
|
||
.. note:: | ||
|
||
This new code is under development and it is designed to handle the new finite | ||
element grids of FES2022. It will become official at the end of this year. For | ||
now, we do not provide support for this new version. | ||
|
||
Bibliography | ||
------------ | ||
|
||
* Lyard, F. H., Carrere, L., Fouchet, E., Cancet, M., Greenberg, D., | ||
Dibarboure, G. and Picot, N.: FES2022 a step towards a SWOT-compliant tidal | ||
correction, in preparation, to be submitted to Ocean Sciences in 2024. | ||
|
||
* Lyard, F. H., Allain, D. J., Cancet, M., Carrère, L., and Picot, N.: FES2014 | ||
global ocean tide atlas: design and performance, Ocean Sci., 17, 615–649, | ||
https://doi.org/10.5194/os-17-615-2021, 2021. | ||
|
||
* Carrere L., F. Lyard, M. Cancet, A. Guillot, N. Picot: FES 2014, a new tidal | ||
model - Validation results and perspectives for improvements, presentation to | ||
ESA Living Planet Conference, Prague 2016. | ||
|
||
Credits | ||
------- | ||
When using FES2022, please mention: ``FES2022 was produced by LEGOS, NOVELTIS and | ||
CLS Ocean and Climate Division; the project was funded by CNES. It is | ||
distributed by AVISO, with support from CNES (http://www.aviso.altimetry.fr/)`` | ||
|
||
Contact | ||
------- | ||
|
||
`[email protected] <mailto:[email protected]>`_ | ||
|
||
.. toctree:: | ||
:hidden: | ||
:maxdepth: 1 | ||
:caption: Contents: | ||
|
||
|
@@ -11,10 +56,3 @@ PyFES documentation | |
pyfes | ||
api | ||
core | ||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |