pastas.model.Model.residuals#

Model.residuals(p=None, tmin=None, tmax=None, freq=None, warmup=None)[source]#

Method to calculate the residual series.

Parameters
  • p (array_like, optional) – array_like object with the values as floats representing the model parameters. See Model.get_parameters() for more info if parameters is None.

  • tmin (str, optional) – String with a start date for the simulation period (E.g. ‘1980’). If none is provided, the tmin from the oseries is used.

  • tmax (str, optional) – String with an end date for the simulation period (E.g. ‘2010’). If none is provided, the tmax from the oseries is used.

  • freq (str, optional) – String with the frequency the stressmodels are simulated. Must be one of the following: (D, h, m, s, ms, us, ns) or a multiple of that e.g. “7D”.

  • warmup (float or int, optional) – Warmup period (in Days).

Returns

res – pandas.Series with the residuals series.

Return type

pandas.Series