swvo.io.dst.read_dst_from_multiple_models

swvo.io.dst.read_dst_from_multiple_models(start_time: datetime, end_time: datetime, model_order: Sequence[DSTOMNI | DSTWDC] | None = None, historical_data_cutoff_time: datetime | None = None, *, download: bool = False) → DataFrame

Read DST data from multiple models.

The model order represents the priorities of models. The first model in the model order is read. If there are still NaNs in the resulting data, the next model will be read, and so on. For ensemble predictions, a list will be returned; otherwise, a plain data frame will be returned.

Parameters:

start_timedatetime

Start time of the data request.

end_timedatetime

End time of the data request.

model_orderSequence or None, optional

Order in which data will be read from the models. Defaults to [OMNI, WDC].

historical_data_cutoff_timedatetime or None, optional

Time representing “now”. After this time, no data will be taken from historical models (OMNI, WDC). Defaults to None.

downloadbool, optional

Flag indicating whether new data should be downloaded. Defaults to False.

Returns:

pandas.DataFrame

A data frame containing data for the requested period.