pastas.check.uncertainty_parameters#

pastas.check.uncertainty_parameters(ml: pastas.model.Model, parameters: list[str] | str | None = None, n_std: float = 1.96)#

Check if parameter value is larger than n_std times the standard deviation.

Note that it is the modelers responsibility to check if the estimated uncertainty is reliable!

Parameters:

  • ml (pastas.Model) – Pastas model instance.

  • parameters (list or str, optional) – List of parameter names to check the uncertainty for. Default is None, which means all parameters are checked.

  • n_std (float, optional) – Number of standard deviations to compare the parameter to. Default is 1.96.