arguments
Calculates the nodal corrections for tidal constituents
Originally based on Richard Ray’s
ARGUMENTSfortran subroutine
Calling Sequence
import pyTMD.arguments
pu,pf,G = pyTMD.arguments.arguments(MJD, constituents,
deltat=DELTAT, corrections=CORRECTIONS)
- pyTMD.arguments.arguments(MJD: ndarray, constituents: list | numpy.ndarray, **kwargs)[source]
Calculates the nodal corrections for tidal constituents [1] [2] [3] [4]
- Parameters
- MJD: np.ndarray
modified Julian day of input date
- constituents: list
tidal constituent IDs
- deltat: float or np.ndarray, default 0.0
time correction for converting to Ephemeris Time (days)
- corrections: str, default ‘OTIS’
use nodal corrections from OTIS/ATLAS or GOT models
- M1: str, default ‘Ray’
coefficients to use for M1 tides
'Doodson''Ray'
- Returns
- pu: np.ndarray
nodal angle correction
- pf: np.ndarray
nodal factor correction
- G: np.ndarray
phase correction in degrees
References
- 1
A. T. Doodson and H. D. Warburg, “Admiralty Manual of Tides”, HMSO, London, (1941).
- 2
P. Schureman, “Manual of Harmonic Analysis and Prediction of Tides,” US Coast and Geodetic Survey, Special Publication, 98, (1958).
- 3
M. G. G. Foreman and R. F. Henry, “The harmonic analysis of tidal model time series,” Advances in Water Resources, 12(3), 109–120, (1989). doi: 10.1016/0309-1708(89)90017-1
- 4
G. D. Egbert and S. Y. Erofeeva, “Efficient Inverse Modeling of Barotropic Ocean Tides,” Journal of Atmospheric and Oceanic Technology, 19(2), 183–204, (2002). doi: 10.1175/1520-0426(2002)019<0183:EIMOBO>2.0.CO;2
- pyTMD.arguments.minor_arguments(MJD: ndarray, **kwargs)[source]
Calculates the nodal corrections for minor tidal constituents in order to infer their values [1] [2] [3] [4]
- Parameters
- MJD: np.ndarray
modified Julian day of input date
- deltat: float or np.ndarray, default 0.0
time correction for converting to Ephemeris Time (days)
- corrections: str, default ‘OTIS’
use nodal corrections from OTIS/ATLAS or GOT models
- Returns
- pu: np.ndarray
nodal angle correction
- pf: np.ndarray
nodal factor correction
- G: np.ndarray
phase correction in degrees
References
- 1
A. T. Doodson and H. D. Warburg, “Admiralty Manual of Tides”, HMSO, London, (1941).
- 2
P. Schureman, “Manual of Harmonic Analysis and Prediction of Tides,” US Coast and Geodetic Survey, Special Publication, 98, (1958).
- 3
M. G. G. Foreman and R. F. Henry, “The harmonic analysis of tidal model time series,” Advances in Water Resources, 12(3), 109–120, (1989). doi: 10.1016/0309-1708(89)90017-1
- 4
G. D. Egbert and S. Y. Erofeeva, “Efficient Inverse Modeling of Barotropic Ocean Tides,” Journal of Atmospheric and Oceanic Technology, 19(2), 183–204, (2002). doi: 10.1175/1520-0426(2002)019<0183:EIMOBO>2.0.CO;2
- pyTMD.arguments.doodson_number(constituents: str | list | numpy.ndarray, **kwargs)[source]
Calculates the Doodson or Cartwright number for tidal constituents [1]
- Parameters
- constituents: str, list or np.ndarray
tidal constituent ID(s)
- corrections: str, default ‘OTIS’
use arguments from OTIS/ATLAS or GOT models
- formalism: str, default ‘Doodson’
constituent identifier formalism
'Cartwright''Doodson'
- raise_error: bool, default True
Raise exception if constituent is unsupported
- Returns
- numbers: float, np.ndarray or dict
Doodson or Cartwright number for each constituent
References
- 1
A. T. Doodson and H. Lamb, “The harmonic development of the tide-generating potential”, Proceedings of the Royal Society of London. Series A, Containing Papers of a Mathematical and Physical Character, 100(704), 305–329, (1921). doi: 10.1098/rspa.1921.0088
- pyTMD.arguments._arguments_table(**kwargs)[source]
Arguments table for tidal constituents [1] [2]
- Parameters
- corrections: str, default ‘OTIS’
use arguments from OTIS/ATLAS or GOT models
- Returns
- coef: np.ndarray
Doodson coefficients (Cartwright numbers) for each constituent
References
- 1
A. T. Doodson and H. Lamb, “The harmonic development of the tide-generating potential”, Proceedings of the Royal Society of London. Series A, Containing Papers of a Mathematical and Physical Character, 100(704), 305–329, (1921). doi: 10.1098/rspa.1921.0088
- 2
A. T. Doodson and H. D. Warburg, “Admiralty Manual of Tides”, HMSO, London, (1941).
- pyTMD.arguments._minor_table(**kwargs)[source]
Arguments table for minor tidal constituents [1] [2]
- Returns
- coef: np.ndarray
Doodson coefficients (Cartwright numbers) for each constituent
References
- 1
A. T. Doodson and H. Lamb, “The harmonic development of the tide-generating potential”, Proceedings of the Royal Society of London. Series A, Containing Papers of a Mathematical and Physical Character, 100(704), 305–329, (1921). doi: 10.1098/rspa.1921.0088
- 2
A. T. Doodson and H. D. Warburg, “Admiralty Manual of Tides”, HMSO, London, (1941).
- pyTMD.arguments._constituent_parameters(c: str, **kwargs)[source]
Loads parameters for a given tidal constituent
- Parameters
- c: str
tidal constituent ID
- raise_error: bool, default False
Raise exception if constituent is unsupported
- Returns
- amplitude: float
amplitude of equilibrium tide for tidal constituent (meters)
- phase: float
phase of tidal constituent (radians)
- omega: float
angular frequency of constituent (radians)
- alpha: float
load love number of tidal constituent
- species: float
spherical harmonic dependence of quadrupole potential
References
- 1
G. D. Egbert and S. Y. Erofeeva, “Efficient Inverse Modeling of Barotropic Ocean Tides,” Journal of Atmospheric and Oceanic Technology, 19(2), 183–204, (2002). doi: 10.1175/1520-0426(2002)019<0183:EIMOBO>2.0.CO;2
- pyTMD.arguments._to_doodson_number(coef: list | numpy.ndarray, **kwargs)[source]
Converts Cartwright numbers into a Doodson number
- Parameters
- coef: list or np.ndarray
Doodson coefficients (Cartwright numbers) for constituent
- raise_error: bool, default True
Raise exception if constituent is unsupported
- Returns
- DO: float
Doodson number for constituent