ostk.physics.environment.atmospheric.earth.Manager

class Manager

Bases: Manager

CSSI space weather manager.

The following environment variables can be defined:

• "OSTK_PHYSICS_ENVIRONMENT_ATMOSPHERIC_EARTH_MANAGER_MODE" will override "DefaultMode"

• "OSTK_PHYSICS_ENVIRONMENT_ATMOSPHERIC_EARTH_MANAGER_LOCAL_REPOSITORY" will override "DefaultLocalRepository"

• "OSTK_PHYSICS_ENVIRONMENT_ATMOSPHERIC_EARTH_MANAGER_LOCAL_REPOSITORY_LOCK_TIMEOUT" will override "DefaultLocalRepositoryLockTimeout"

Reference:

https://ai-solutions.com/_help_Files/cssi_space_weather_file.htm

Methods

clear_local_repository	Clear the local repository.
fetch_latest_cssi_space_weather	Fetch latest CSSI Space Weather file.
get	Get manager singleton.
get_ap_3_hour_solar_indices_at	Get a list of 8 3-hourly Ap solar indices for the day containing instant.
get_ap_daily_index_at	Get daily Ap index for the day containing instant.
get_cssi_space_weather_at	Get CSSI Space Weather at instant.
get_cssi_space_weather_directory	Get CSSI space weather directory.
get_f107_solar_flux_81_day_avg_at	Get the 81-day average value for F10.7 solar flux centered on instant.
get_f107_solar_flux_at	Get the daily value for F10.7 solar flux at instant.
get_kp_3_hour_solar_indices_at	Get a list of 8 3-hourly Kp solar indices for the day containing instant.
get_loaded_cssi_space_weather	Get currently loaded CSSI Space Weather file.
get_local_repository	Get the local repository.
get_local_repository_lock_timeout	Get the local repository lock timeout.
get_mode	Get the manager mode.
load_cssi_space_weather	Load CSSI Space Weather.
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_cssi_space_weather(

self: ostk.physics.environment.atmospheric.earth.Manager,

) → ostk.core.filesystem.File

Fetch latest CSSI Space Weather file.

Returns:

Latest CSSI Space Weather file.

Return type:

File

static get() → ostk.physics.environment.atmospheric.earth.Manager

Get manager singleton.

Returns:

Reference to manager.

Return type:

Manager

get_ap_3_hour_solar_indices_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → list[ostk.core.type.Integer]

Get a list of 8 3-hourly Ap solar indices for the day containing instant.

Parameters:

instant (Instant) -- An instant.

Returns:

list of 8 3-hourly Ap solar indices.

Return type:

list[int]

get_ap_daily_index_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → ostk.core.type.Integer

Get daily Ap index for the day containing instant.

Parameters:

instant (Instant) -- An instant.

Returns:

Daily Ap index.

Return type:

Integer

get_cssi_space_weather_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → ostk.physics.environment.atmospheric.earth.CSSISpaceWeather

Get CSSI Space Weather at instant.

Parameters:

instant (Instant) -- An instant.

Returns:

CSSI Space Weather.

Return type:

CSSISpaceWeather

get_cssi_space_weather_directory(

self: ostk.physics.environment.atmospheric.earth.Manager,

) → ostk.core.filesystem.Directory

Get CSSI space weather directory.

Returns:

CSSI space weather directory.

Return type:

Directory

get_f107_solar_flux_81_day_avg_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → ostk.core.type.Real

Get the 81-day average value for F10.7 solar flux centered on instant.

Parameters:

instant (Instant) -- An instant.

Returns:

Centered 81-day average value for F10.7 solar flux.

Return type:

float

get_f107_solar_flux_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → ostk.core.type.Real

Get the daily value for F10.7 solar flux at instant.

Parameters:

instant (Instant) -- An instant.

Returns:

Daily value for F10.7 solar flux.

Return type:

float

get_kp_3_hour_solar_indices_at(

self: ostk.physics.environment.atmospheric.earth.Manager,

instant: ostk.physics.time.Instant,

) → list[ostk.core.type.Integer]

Get a list of 8 3-hourly Kp solar indices for the day containing instant.

Parameters:

instant (Instant) -- An instant.

Returns:

list of 8 3-hourly Kp solar indices.

Return type:

list[int]

get_loaded_cssi_space_weather(

self: ostk.physics.environment.atmospheric.earth.Manager,

) → ostk.physics.environment.atmospheric.earth.CSSISpaceWeather

Get currently loaded CSSI Space Weather file.

Returns:

Currently loaded CSSI Space Weather file.

Return type:

CSSISpaceWeather

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_mode(self: ostk.physics.Manager) → ostk.physics.Manager.Mode

Get the manager mode.

Returns:

Manager mode.

Return type:

Mode

load_cssi_space_weather(

self: ostk.physics.environment.atmospheric.earth.Manager,

cssi_space_weather: ostk.physics.environment.atmospheric.earth.CSSISpaceWeather,

) → None

Load CSSI Space Weather.

Parameters:

cssi_space_weather (CSSISpaceWeather) -- A CSSI Space Weather.

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.