ostk.physics.coordinate.frame.provider.iers.Manager

class Manager

Bases: Manager

IERS bulletins manager (thread-safe)

The following environment variables can be defined:

  • "OSTK_PHYSICS_COORDINATE_FRAME_PROVIDER_IERS_MANAGER_MODE" will override

"DefaultMode" - "OSTK_PHYSICS_COORDINATE_FRAME_PROVIDER_IERS_MANAGER_LOCAL_REPOSITORY" will override "DefaultLocalRepository" - "OSTK_PHYSICS_COORDINATE_FRAME_PROVIDER_IERS_MANAGER_LOCAL_REPOSITORY_LOCK_TIMEOUT" will override "DefaultLocalRepositoryLockTimeout"

Reference:

https://www.iers.org/IERS/EN/DataProducts/EarthOrientationData/eop.html

Methods

clear_local_repository

Clear the local repository.

fetch_latest_bulletin_a

Fetch latest Bulletin A file.

fetch_latest_finals_2000a

Fetch latest Finals 2000A file.

get

Get manager singleton.

get_bulletin_a

Get Bulletin A.

get_bulletin_a_directory

Get Bulletin A directory.

get_finals_2000a

Get Finals 2000A.

get_finals_2000a_directory

Get Finals 2000A directory.

get_local_repository

Get the local repository.

get_local_repository_lock_timeout

Get the local repository lock timeout.

get_lod_at

Get length of day at instant.

get_mode

Get the manager mode.

get_polar_motion_at

Get polar motion at instant.

get_ut1_minus_utc_at

Get UT1 - UTC at instant.

load_bulletin_a

Load Bulletin A.

load_finals_2000a

Load Finals 2000A.

reset

Reset the manager.

set_local_repository

Set the local repository.

set_mode

Set the manager mode.

class Mode(self: ostk.physics.Manager.Mode, value: int)

Bases: pybind11_object

Members:

Manual

Automatic

property name
clear_local_repository(self: ostk.physics.Manager) None

Clear the local repository.

fetch_latest_bulletin_a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk.core.filesystem.File

Fetch latest Bulletin A file.

Returns:

Latest Bulletin A file.

Return type:

File

fetch_latest_finals_2000a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk.core.filesystem.File

Fetch latest Finals 2000A file.

Returns:

Latest Finals 2000A file.

Return type:

File

static get() ostk.physics.coordinate.frame.provider.iers.Manager

Get manager singleton.

Returns:

Reference to manager.

Return type:

Manager

get_bulletin_a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk::physics::coordinate::frame::provider::iers::BulletinA

Get Bulletin A.

Returns:

Bulletin A.

Return type:

BulletinA

get_bulletin_a_directory(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk.core.filesystem.Directory

Get Bulletin A directory.

Returns:

Bulletin A directory.

Return type:

Directory

get_finals_2000a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk::physics::coordinate::frame::provider::iers::Finals2000A

Get Finals 2000A.

Returns:

Finals 2000A.

Return type:

Finals2000A

get_finals_2000a_directory(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
) ostk.core.filesystem.Directory

Get Finals 2000A directory.

Returns:

Finals 2000A directory.

Return type:

Directory

get_local_repository(
self: ostk.physics.Manager,
) ostk.core.filesystem.Directory

Get the local repository.

Returns:

Local repository.

Return type:

Directory

get_local_repository_lock_timeout(
self: ostk.physics.Manager,
) ostk::physics::time::Duration

Get the local repository lock timeout.

Returns:

Local repository lock timeout.

Return type:

Duration

get_lod_at(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
instant: ostk.physics.time.Instant,
) ostk.core.type.Real

Get length of day at instant.

Parameters:

instant (Instant) -- Instant.

Returns:

Length of day [ms].

Return type:

float

get_mode(self: ostk.physics.Manager) ostk.physics.Manager.Mode

Get the manager mode.

Returns:

Manager mode.

Return type:

Mode

get_polar_motion_at(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
instant: ostk.physics.time.Instant,
) numpy.ndarray[numpy.float64[2, 1]]

Get polar motion at instant.

Parameters:

instant (Instant) -- Instant.

Returns:

Polar motion.

Return type:

numpy.ndarray

get_ut1_minus_utc_at(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
instant: ostk.physics.time.Instant,
) ostk.core.type.Real

Get UT1 - UTC at instant.

Parameters:

instant (Instant) -- Instant.

Returns:

UT1 - UTC [sec].

Return type:

float

load_bulletin_a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
bulletin_a: ostk::physics::coordinate::frame::provider::iers::BulletinA,
) None

Load Bulletin A.

Returns:

Bulletin A.

Return type:

bulletin_a (BulletinA)

load_finals_2000a(
self: ostk.physics.coordinate.frame.provider.iers.Manager,
finals_2000a: ostk::physics::coordinate::frame::provider::iers::Finals2000A,
) None

Load Finals 2000A.

Returns:

Finals 2000A.

Return type:

finals_2000a (Finals2000A)

reset(self: ostk.physics.Manager) None

Reset the manager.

set_local_repository(
self: ostk.physics.Manager,
directory: ostk.core.filesystem.Directory,
) None

Set the local repository.

Parameters:

directory (Directory) -- Local repository.

set_mode(self: ostk.physics.Manager, mode: ostk.physics.Manager.Mode) None

Set the manager mode.

Parameters:

mode (Mode) -- Manager mode.