pastas.check.response_memory#
- pastas.check.response_memory(ml: pastas.typing.Model, cutoff: float = 0.95, factor_length_oseries: float = 0.5, names: list[str] | str | None = None)#
Check if response function memory is shorter than fraction of calibration period.
- Parameters:
ml (pastas.Model) – Pastas model instance.
cutoff (float, optional) – Cutoff value for the length of the response function. Default is 0.95, which means that the response function is cutoff at the time the step response is at 95% of the gain.
factor_length_oseries (float, optional) – Factor to multiply the length of the observation series with to get the maximum allowed memory. Default is 0.5, e.g. half of the calibration period.
names (list or str, optional) – List of stressmodel names to check the memory for. Default is None, which means all stressmodels are checked.
- Returns:
df – DataFrame with the results of the check.
- Return type: