StressModel2¶

class StressModel2(stress, rfunc, name, up=True, cutoff=0.999, settings=('prec', 'evap'), metadata=(None, None), meanstress=None)[source]¶

Time series model consisting of the convolution of two stresses with one response function. The first stress causes the head to go up and the second stress causes the head to go down.

Parameters

stress (list of pandas.Series or list of pastas.timeseries) – list of two pandas.Series or pastas.timeseries objects containing the stresses. Usually the first is the precipitation and the second the evaporation.
rfunc (pastas.rfunc instance) – Response function used in the convolution with the stress.
name (str) – Name of the stress
up (bool or None, optional) – True if response function is positive (default), False if negative. None if you don’t want to define if response is positive or negative.
cutoff (float, optional) – float between 0 and 1 to determine how long the response is (default is 99.9% of the actual response time). Used to reduce computation times.
settings (list of dicts or strs, optional) – The settings of the individual TimeSeries.
settings – The settings of the stresses. This can be a string referring to a predefined settings dict, or a dict with the settings to apply. Refer to the docstring of pastas.Timeseries for further information. Default is (“prec”, “evap”).
metadata (list of dicts, optional) – dictionary containing metadata about the stress. This is passed onto the TimeSeries object.

Notes

The order in which the stresses are provided is the order the metadata and settings dictionaries or string are passed onto the TimeSeries objects. By default, the precipitation stress is the first and the evaporation stress the second stress.

Attributes¶

nparam

Methods¶

`__init__`
`dump_stress`	Method to dump all stresses in the stresses list.
`get_nsplit`	Determine in how many timeseries the contribution can be split.
`get_stress`	Returns the stress or stresses of the time series object as a pandas DataFrame.
`set_init_parameters`	Set the initial parameters back to their default values.
`simulate`	Simulates the head contribution.
`to_dict`	Method to export the StressModel object.
`update_stress`	Method to update the settings of the individual TimeSeries.

pastas.stressmodels.StressModel.update_stress pastas.stressmodels.StressModel2.__init__