create_timeseries_dataset#

openstef_core.testing.create_timeseries_dataset(index: DatetimeIndex, available_ats: Series | list[datetime] | DatetimeIndex | None = None, horizons: Series | list[timedelta] | None = None, sample_interval: timedelta = timedelta(hours=1), *, check_frequency: bool = False, **kwargs: Series | list[Any] | DatetimeIndex) → TimeSeriesDataset[source]#

Create a TimeSeriesDataset for testing purposes.

Parameters:

  • index (DatetimeIndex) – Datetime index for the dataset.

  • available_ats (Series | list[datetime] | DatetimeIndex | None) – Optional available_at timestamps for each data point.

  • horizons (Series | list[timedelta] | None) – Optional forecast horizons for each data point.

  • sample_interval (timedelta) – Time interval between consecutive samples.

  • **kwargs (Series | list[Any] | DatetimeIndex) – Additional columns to include in the dataset.

  • check_frequency (bool) – Whether to check the frequency of the datetime index.

  • index

  • available_ats

  • horizons

  • sample_interval

  • check_frequency

  • kwargs (Series | list[Any] | DatetimeIndex)

Returns:

TimeSeriesDataset with the specified structure.

Return type:

TimeSeriesDataset