foxes.input.states.create.random_timeseries

Functions

random_timseries_data(→ pandas.DataFrame)

Creates random uniform timeseries data

Module Contents

foxes.input.states.create.random_timeseries.random_timseries_data(n_times: int, data_ranges: dict[str, tuple[float, float]] | None = None, start_time: str = '2000-01-01 00:00:00', freq: str = 'h', seed: int | None = None, iname: str = 'Time') pandas.DataFrame[source]

Creates random uniform timeseries data

Parameters:
n_times

The number of time steps

data_ranges

The data ranges keyed by variable name. Values define the half-open interval [min, max) for each variable.

start_time

The first time stamp in the series

freq

The time period range frequency

seed

The random seed

iname

The index name

Returns:
sdata

The timeseries data