pastas.check.parameter_ufunc_threshold

pastas.check.parameter_ufunc_threshold(ml: pastas.model.Model, parameter: str, ufunc: collections.abc.Callable, threshold: float)

Generic function to compare a model statistic with a threshold using a ufunc.

Parameters:

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

• parameter (str) – Name of the parameter to be compared.

• ufunc (callable) – Numpy ufunc (e.g. np.greater_than) to compare the model statistic with the threshold.

• threshold (float) – Threshold value for the statistic.

Returns:

df – DataFrame with the results of the check.

Return type:

pandas.DataFrame