swvo.io.kp.omni

Module holding the reader for reading Kp data from OMNI files.

Classes

KpOMNI([data_dir, prefer_env_var])

Class for reading Kp data from OMNI low resolution files.

class swvo.io.kp.omni.KpOMNI(data_dir: Path | None = None, prefer_env_var: bool = False)

Bases: OMNILowRes

Class for reading Kp data from OMNI low resolution files. Inherits the download_and_process(), other private methods and attributes from OMNILowRes.

read(start_time: datetime, end_time: datetime, download: bool = False) → DataFrame

Extract Kp data from OMNI Low Resolution files.

Parameters:

start_timedatetime

Start time of the data to read.

end_timedatetime

End time of the data to read.

downloadbool, optional

Download data on the go, defaults to False.

Returns:

pandas.DataFrame

Kp data from OMNI Low Resolution data.

download_and_process(start_time: datetime, end_time: datetime, reprocess_files: bool = False) → None

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:

None