pastas.stressmodels.ChangeModel.set_stress

pastas.stressmodels.ChangeModel.set_stress(stress: pandas.Series | pastas.timeseries.TimeSeries, settings: str | pastas.typing.StressSettingsDict | None = None, metadata: dict | None = None) → None

Set the stress time series.

Parameters:

• stress (pandas.Series or pastas.TimeSeries) – pandas.Series with pandas.DatetimeIndex containing the stress or a pastas TimeSeries object.

• settings (dict or str, optional) – The settings of the stress. This can be a string referring to a predefined settings dictionary (defined in ps.rcParams[“timeseries”]), or a dictionary with the settings to apply. For more information refer to time series settings section on class initialization.

• metadata (dict, optional) – Dictionary with metadata of the stress time series.