swvo.io.omni.omni_low_res#

Module for handling OMNI low resolution data.

Classes

OMNILowRes([data_dir, prefer_env_var])

This is a class for the OMNI Low Resolution data.

class swvo.io.omni.omni_low_res.OMNILowRes(data_dir: Path | None = None, prefer_env_var: bool = False)[source]#

This is a class for the OMNI Low Resolution data.

Methods

`download_and_process`(start_time, end_time[, ...])	Download and process OMNI Low Resolution data files.
`read`(start_time, end_time[, download])	Read OMNI Low Resolution data for the given time range.

Raises:

ValueError: Returns ValueError if necessary environment variable is not set.

download_and_process(start_time: datetime, end_time: datetime, reprocess_files: bool = False) → None[source]#

Download and process OMNI Low Resolution data files.

Parameters:

start_timedatetime: Start time for the data to be downloaded and processed.
end_timedatetime: End time for the data to be downloaded and processed.
reprocess_filesbool, optional: Downloads and processes the files again, defaults to False, by default False

Returns:

read(start_time: datetime, end_time: datetime, download: bool = False) → DataFrame[source]#

Read OMNI Low Resolution data for the given time range.

Parameters:

Returns: