pastas.check.parameters_leq_threshold#
- pastas.check.parameters_leq_threshold(ml: pastas.typing.Model, parameters: list[str] | str | None = None, threshold: float = 500.0)#
Check if parameter values are less than or equal to a threshold.
- Parameters:
ml (pastas.Model) – Pastas model instance.
parameters (list or str, optional) – List of parameter names to check the threshold for. Default is None, which means all parameters are checked. If str, partial matches are allowed.
threshold (float, optional) – Threshold value for the parameters. Default is 500.0.
- Returns:
df – DataFrame with the results of the check.
- Return type: