Skip to content

Commit

Permalink
refactor: convert Doodson coefficients table to JSON (#353)
Browse files Browse the repository at this point in the history 
* feat: added option to use Munk-Cartwright admittance interpolation for minor constituents
* feat: add Cartwright and Edden (1973) table 1
* feat: add Cartwright and Tayler (1971) table 5
* feat: add function to parse Cartwright/Tayler/Edden tables
* feat: add functions to calculate UKHO Extended Doodson numbers for constituents
* refactor: convert coefficients table to JSON
* test: add test for extended doodson
* docs: add citations to included data
  • Loading branch information
@tsutterley
tsutterley authored Oct 29, 2024
1 parent e5df139 commit 2276154
Show file tree
Hide file tree
Showing 12 changed files with 1,932 additions and 570 deletions.
6 changes: 6 additions & 0 deletions doc/source/api_reference/arguments.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Calling Sequence

.. autofunction:: pyTMD.arguments._constituent_parameters

.. autofunction:: pyTMD.arguments._parse_tide_potential_table

.. autofunction:: pyTMD.arguments._to_doodson_number

.. autofunction:: pyTMD.arguments._to_extended_doodson

.. autofunction:: pyTMD.arguments._from_doodson_number

.. autofunction:: pyTMD.arguments._from_extended_doodson
25 changes: 25 additions & 0 deletions doc/source/getting_started/Citations.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,27 @@ The NASA Goddard Space Flight Center (GSFC) PREdict Tidal Heights (PERTH3) softw
Richard Ray and Remko Scharroo.
An updated and more versatile version of the NASA GSFC tidal prediction software (PERTH5) was developed by Richard Ray.

Data Citations
##############

Internally, ``pyTMD`` includes datasets from the following:

D. E. Cartwright and R. J. Tayler, "New Computations of the Tide-generating Potential,"
*Geophysical Journal of the Royal Astronomical Society*, 23(1), 45--73. (1971).
`doi: 10.1111/j.1365-246X.1971.tb01803.x <https://doi.org/10.1111/j.1365-246X.1971.tb01803.x>`_

D. E. Cartwright and A. C. Edden, "Corrected Tables of Tidal Harmonics,"
*Geophysical Journal of the Royal Astronomical Society*, 33(3), 253--264, (1973).
`doi: 10.1111/j.1365-246X.1973.tb03420.x <https://doi.org/10.1111/j.1365-246X.1973.tb03420.x>`_

S. Desai, J. Wahr and B. Beckley "Revisiting the pole tide for and from satellite altimetry",
*Journal of Geodesy*, 89(12), p1233-1243, (2015).
`doi: 10.1007/s00190-015-0848-7 <https://doi.org/10.1007/s00190-015-0848-7>`_

*IERS Conventions (2010)*, G. Petit and B. Luzum (eds.), (IERS Technical Note; 36),
Frankfurt am Main: Verlag des Bundesamts f\ |uuml|\ r Kartographie und Geod\ |auml|\ sie, 179 pp. (2010).
`ISBN 3-89888-989-6 <https://www.iers.org/IERS/EN/Publications/TechnicalNotes/tn36.html>`_

Disclaimer
##########

Expand All @@ -89,3 +110,7 @@ of Washington Applied Physics Laboratory (UW-APL).
It is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA.
Outputs from this software should be used for scientific or technical purposes only.
This software should not be used for coastal navigation or any application that may risk life or property.

.. |auml| unicode:: U+00E4 .. LATIN SMALL LETTER A WITH DIAERESIS
.. |uuml| unicode:: U+00FC .. LATIN SMALL LETTER U WITH DIAERESIS

686 changes: 146 additions & 540 deletions pyTMD/arguments.py
View file

Large diffs are not rendered by default.

382 changes: 382 additions & 0 deletions pyTMD/data/ce1973_tab1.txt
View file

Large diffs are not rendered by default.

99 changes: 99 additions & 0 deletions pyTMD/data/ct1971_tab5.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
0 0 0 1 0 0 -0.00020 -0.00020 -0.00021 055.655 0.00025 0.00026
0 0 2 -1 0 0 -0.00004 -0.00004 -0.00004 057.455 0.00005
0 1 -2 0 0 0 0.00004 0.00004 0.00004 063.555 -0.00005
0 1 0 0 -1 0 0.00019 0.00020 0.00019 065.545 -0.00024 -0.00024
0 1 0 0 0 0 -0.00375 -0.00375 -0.00375 065.555 0.00466 0.00466
0 1 0 0 1 0 -0.00059 -0.00059 -0.00059 065.565 0.00074 0.00073
0 1 0 0 2 0 0.00005 0.00005 0.00005 065.575 -0.00006
0 2 -2 1 0 0 -0.00012 -0.00012 -0.00012 073.655 0.00015 0.00015
0 2 0 -1 0 0 -0.00061 -0.00061 -0.00061 075.455 0.00076 0.00076
0 2 0 -1 1 0 -0.00010 -0.00010 -0.00010 075.465 0.00012 0.00012
0 3 -2 0 0 0 -0.00010 -0.00010 -0.00010 083.555 0.00013 0.00013
0 3 0 -2 0 0 -0.00007 -0.00007 -0.00007 085.355 0.00009
0 3 0 0 0 0 -0.00031 -0.00030 -0.00030 085.555 0.00038 0.00038
0 3 0 0 1 0 -0.00019 -0.00019 -0.00019 085.565 0.00023 0.00024
0 3 0 0 2 0 -0.00004 -0.00004 -0.00004 085.575 0.00005
0 4 0 -1 0 0 -0.00008 -0.00008 -0.00008 095.455 0.00010 0.00011
0 4 0 -1 1 0 -0.00005 -0.00005 -0.00005 095.465 0.00006
1 -4 0 2 0 0 -0.00006 -0.00006 -0.00006 115.755 -0.00010 -0.00010
1 -4 2 0 0 0 -0.00006 -0.00006 -0.00006 117.555 -0.00010 -0.00010
1 -3 0 1 -1 0 -0.00014 -0.00014 -0.00014 125.645 -0.00023 -0.00023
1 -3 0 1 0 0 -0.00035 -0.00035 -0.00035 125.655 -0.00058 -0.00058
1 -3 2 -1 0 0 -0.00007 -0.00007 -0.00007 127.455 -0.00011 -0.00011
1 -2 0 0 -2 0 -0.00004 -0.00004 -0.00004 135.535 -0.00007
1 -2 0 0 -1 0 -0.00051 -0.00050 -0.00050 135.545 -0.00083 -0.00084
1 -2 0 0 0 0 -0.00128 -0.00128 -0.00128 135.555 -0.00211 -0.00211
1 -2 0 2 0 0 -0.00008 -0.00008 -0.00008 135.755 -0.00013 -0.00013
1 -2 2 0 0 0 -0.00011 -0.00011 -0.00011 137.555 -0.00018 -0.00018
1 -1 0 -1 0 0 0.00007 0.00007 0.00007 145.455 0.00012 0.00012
1 -1 0 1 -1 0 0.00010 0.00010 0.00010 145.645 0.00016 0.00016
1 -1 0 1 0 0 -0.00065 -0.00065 -0.00065 145.655 -0.00108 -0.00108
1 -1 0 1 1 0 0.00009 0.00008 0.00009 145.665 0.00014 0.00014
1 -1 2 -1 0 0 -0.00013 -0.00013 -0.00013 147.455 -0.00021 -0.00021
1 0 0 0 -1 0 0.00059 0.00059 0.00059 155.545 0.00098 0.00098
1 0 0 0 0 0 -0.00399 -0.00399 -0.00399 155.555 -0.00660 -0.00661
1 0 0 0 1 0 0.00052 0.00052 0.00052 155.565 0.00086 0.00086
1 1 -2 1 0 0 -0.00004 -0.00004 -0.00004 163.655 -0.00007
1 1 0 -1 -1 0 0.00003 0.00003 0.00003 165.445 0.00005
1 1 0 -1 0 0 -0.00022 -0.00022 -0.00022 165.455 -0.00036 -0.00036
1 1 0 -1 1 0 0.00003 0.00003 0.00003 165.465 0.00005
1 1 0 1 0 0 -0.00008 -0.00008 -0.00008 165.655 -0.00013 -0.00013
1 1 0 1 1 0 -0.00003 -0.00003 -0.00003 165.665 -0.00005
1 2 -2 0 0 0 -0.00005 -0.00005 -0.00005 173.555 -0.00008
1 2 0 0 -1 0 0.00005 0.00005 0.00005 175.545 0.00008
1 2 0 0 0 0 -0.00146 -0.00146 -0.00146 175.555 -0.00242 -0.00241
1 2 0 0 1 0 -0.00059 -0.00059 -0.00059 175.565 -0.00098 -0.00089
1 2 0 0 2 0 -0.00005 -0.00005 -0.00005 175.575 -0.00008
1 3 -2 1 0 0 -0.00005 -0.00005 -0.00005 183.655 -0.00008
1 3 0 -1 0 0 -0.00024 -0.00024 -0.00024 185.455 -0.00039 -0.00040
1 3 0 -1 1 0 -0.00010 -0.00010 -0.00010 185.465 -0.00016 -0.00016
1 4 -2 0 0 0 -0.00004 -0.00004 -0.00004 193.555 -0.00007
1 4 0 0 0 0 -0.00006 -0.00005 -0.00005 195.555 -0.00009
1 4 0 0 1 0 -0.00005 -0.00005 -0.00005 195.565 -0.00008
2 -4 2 1 0 0 -0.00006 -0.00006 -0.00006 217.655 -0.00008
2 -3 0 2 0 0 -0.00018 -0.00018 -0.00018 225.755 -0.00027 -0.00027
2 -3 2 0 -1 0 -0.00003 -0.00003 -0.00003 227.545 -0.00005
2 -3 2 0 0 0 -0.00019 -0.00018 -0.00018 227.555 -0.00027 -0.00027
2 -2 0 1 -1 0 -0.00018 -0.00018 -0.00018 235.645 -0.00027 -0.00027
2 -2 0 1 0 0 -0.00107 -0.00107 -0.00107 235.655 -0.00156 -0.00156
2 -2 2 -1 -1 0 -0.00003 -0.00003 -0.00003 237.445 -0.00005
2 -2 2 -1 0 0 -0.00020 -0.00020 -0.00020 237.455 -0.00029 -0.00029
2 -1 0 0 -2 0 0.00003 0.00004 0.00003 245.535 0.00005
2 -1 0 0 -1 0 -0.00066 -0.00066 -0.00066 245.545 -0.00097 -0.00097
2 -1 0 0 0 0 -0.00389 -0.00389 -0.00389 245.555 -0.00569 -0.00569
2 -1 0 2 0 0 0.00007 0.00007 0.00007 245.755 0.00010 0.00011
2 -1 2 0 0 0 0.00010 0.00010 0.00010 247.555 0.00014 0.00015
2 0 -2 1 0 0 0.00005 0.00005 0.00005 253.655 0.00008
2 0 0 -1 -1 0 0.00004 0.00004 0.00004 255.445 0.00005
2 0 0 -1 0 0 0.00022 0.00022 0.00022 255.455 0.00032 0.00032
2 0 0 1 -1 0 -0.00003 -0.00003 -0.00003 255.645 -0.00005
2 0 0 1 0 0 0.00059 0.00059 0.00059 255.655 0.00086 0.00086
2 0 0 1 1 0 0.00011 0.00011 0.00011 255.665 0.00016 0.00016
2 0 2 -1 0 0 0.00011 0.00011 0.00011 257.455 0.00017 0.00017
2 1 0 0 -1 0 -0.00021 -0.00021 -0.00021 265.545 -0.00031 -0.00031
2 1 0 0 0 0 0.00359 0.00359 0.00359 265.555 0.00525 0.00525
2 1 0 0 1 0 0.00068 0.00068 0.00068 265.565 0.00099 0.00099
2 2 -2 1 0 0 0.00004 0.00004 0.00004 273.655 0.00005
2 2 0 -1 0 0 0.00019 0.00019 0.00019 275.455 0.00028 0.00028
2 2 0 -1 1 0 0.00004 0.00004 0.00004 275.465 0.00005
2 3 -2 0 0 0 0.00004 0.00004 0.00004 283.555 0.00006
2 3 0 0 0 0 0.00033 0.00033 0.00033 285.555 0.00048 0.00048
2 3 0 0 1 0 0.00021 0.00021 0.00021 285.565 0.00031 0.00031
2 3 0 0 2 0 0.00004 0.00004 0.00004 285.575 0.00006
2 4 0 -1 0 0 0.00005 0.00005 0.00005 295.455 0.00008
3 -2 0 2 0 0 0.00036 0.00037 0.00037 335.755 -0.00057 -0.00056
3 -2 2 0 0 0 0.00037 0.00037 0.00037 337.555 -0.00057 -0.00057
3 -1 0 1 -1 0 -0.00012 -0.00012 -0.00012 345.645 0.00018 0.00018
3 -1 0 1 0 0 0.00210 0.00210 0.00210 345.655 -0.00326 -0.00326
3 -1 2 -1 0 0 0.00039 0.00039 0.00039 347.455 -0.00061 -0.00061
3 0 -2 2 0 0 -0.00005 -0.00005 -0.00005 353.755 0.00007
3 0 0 0 -1 0 -0.00043 -0.00043 -0.00043 355.545 0.00067 0.00066
3 0 0 0 0 0 0.00765 0.00765 0.00765 355.555 -0.01188 -0.01188
3 1 -2 1 0 0 -0.00011 -0.00011 -0.00011 363.655 0.00017 0.00017
3 1 0 -1 0 0 -0.00043 -0.00043 -0.00043 365.455 0.00067 0.00067
3 1 0 1 0 0 0.00016 0.00016 0.00016 365.655 -0.00025 -0.00025
3 1 0 1 1 0 0.00007 0.00007 0.00007 365.665 -0.00011 -0.00011
3 2 0 0 -1 0 -0.00004 -0.00004 -0.00004 375.545 0.00006
3 2 0 0 0 0 0.00100 0.00100 0.00100 375.555 -0.00155 -0.00155
3 2 0 0 1 0 0.00044 0.00044 0.00043 375.565 -0.00068 -0.00068
3 2 0 0 2 0 0.00005 0.00005 0.00005 375.575 -0.00007
Loading

0 comments on commit 2276154

Please sign in to comment.