eop
Utilities for maintaining Earth Orientation Parameter (EOP) files
Syncs mean pole files with IERS servers
Can calculate update mean pole files using data from IERS servers
Syncs finals orientation files with IERS servers
General Methods
- pyTMD.eop.update_mean_pole(verbose: bool = False, mode: oct = 509)[source]
Connects to servers to download mean-pole.tab files from HPIERS servers
Servers and Mirrors
- Parameters
- verbose: bool, default False
print file information about output file
- mode: oct, default 0o775
permissions mode of output file
- pyTMD.eop.calculate_mean_pole(verbose: bool = False, mode: oct = 509)[source]
Calculates the mean pole coordinates x and y are obtained by a Gaussian-weighted average of the IERS pole coordinates
Servers and Mirrors
ftp://ftp.iers.org/products/eop/long-term/c01/eopc01.iau2000.1900-now.dat
ftp://hpiers.obspm.fr/iers/eop/eopc01/eopc01.iau2000.1900-now.dat
http://hpiers.obspm.fr/eoppc/eop/eopc01/eopc01.iau2000.1900-now.dat
- Parameters
- verbose: bool, default False
print file information about output file
- mode: oct, default 0o775
permissions mode of output file
- pyTMD.eop.pull_pole_coordinates(FILE: str, verbose: bool = False)[source]
Connects to servers and downloads IERS pole coordinate files
Servers and Mirrors
ftp://ftp.iers.org/products/eop/long-term/c01/eopc01.iau2000.1900-now.dat
ftp://hpiers.obspm.fr/iers/eop/eopc01/eopc01.iau2000.1900-now.dat
http://hpiers.obspm.fr/eoppc/eop/eopc01/eopc01.iau2000.1900-now.dat
- Parameters
- FILE: str
IERS pole coordinate file to download from remote servers
eopc01.1846-now.dat
eopc01.1900-now.dat
eopc01.iau2000.1900-now.dat
eopc01.iau2000.1846-now.dat
- verbose: bool, default False
print file information about output file
- pyTMD.eop.update_finals_file(username: str | None = None, password: str | None = None, timeout: int | None = 20, verbose: bool = False, mode: oct = 509)[source]
Connects to servers and downloads finals EOP files
Servers and Mirrors
- Parameters
- username: str or NoneType, default None
NASA Earthdata username
- password: str or NoneType, default None
NASA Earthdata password
- timeout: int or NoneType, default 20
timeout in seconds for blocking operations
- verbose: bool, default False
print file information about output file
- mode: oct, default 0o775
permissions mode of output file
- pyTMD.eop.iers_mean_pole(input_epoch: ndarray, convention: str = '2018', **kwargs)[source]
Calculates the angular coordinates of the IERS Conventional Mean Pole (CMP) or IERS Secular Pole (2018 convention)
- Parameters
- input_epoch: np.ndarray
Dates for the angular coordinates of the Conventional Mean Pole in decimal years
- convention: str, default ‘2018’
IERS Mean or Secular Pole Convention
'2003'
'2010'
'2015'
'2018'
- input_file: str or pathlib.Path
Full path to mean-pole.tab file provided by IERS
- fill_value: float, default np.nan
Value for invalid flags
- Returns
- x: np.ndarray
Angular coordinate x of conventional mean pole or secular pole
- y: np.ndarray
Angular coordinate y of conventional mean pole or secular pole
- flag: np.ndarray
epoch is valid for version and version number is valid
References
- 1
G. Petit and B. Luzum (eds.), IERS Conventions (2010), International Earth Rotation and Reference Systems Service (IERS), IERS Technical Note No. 36
- pyTMD.eop.iers_daily_EOP(input_file: str | pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/pytmd/conda/stable/lib/python3.12/site-packages/pyTMD/data/finals.all'))[source]
Read daily earth orientation parameters (EOP) file from IERS
- Parameters
- input_file: str or Pathlib.Path
full path to IERS EOP “finals” file
- Returns
- MJD: np.ndarray
Modified Julian Date of EOP measurements
- x: np.ndarray
Angular coordinate x [arcsec]
- y: np.ndarray
Angular coordinate y [arcsec]
References
- 1
G. Petit and B. Luzum (eds.), IERS Conventions (2010), International Earth Rotation and Reference Systems Service (IERS), IERS Technical Note No. 36
- pyTMD.eop.iers_polar_motion(MJD: float | numpy.ndarray, file: str | pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/pytmd/conda/stable/lib/python3.12/site-packages/pyTMD/data/finals.all'), **kwargs)[source]
Interpolates daily earth orientation parameters (EOP) file from IERS
- Parameters
- MJD: np.ndarray
Modified Julian Date for interpolated measurements
- file: str or Pathlib.Path
default path to IERS EOP “finals” file
- k: int
Degree of the spline fit
- s: int or float
Positive smoothing factor for the spline fit
- Returns
- px: np.ndarray
Angular coordinate x [arcsec]
- py: np.ndarray
Angular coordinate y [arcsec]
References
- 1
G. Petit and B. Luzum (eds.), IERS Conventions (2010), International Earth Rotation and Reference Systems Service (IERS), IERS Technical Note No. 36