pastas.check.uncertainty_gain#

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

Check if the gain is larger than n_std times the uncertainty in the gain.

Parameters:

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

  • n_std (int, optional) – Number of standard errors to compare the the gain to. Default is 1.96.

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

Returns:

df – DataFrame with the results of the check.

Return type:

pandas.DataFrame