pastas.check.checklist#
- pastas.check.checklist(ml: pastas.model.Model, checks: list[str | collections.abc.Callable | dict], report=True)#
Run a list of checks on a Pastas model.
- Parameters:
ml (pastas.Model) – Pastas model instance.
checks (list) –
List of checks to perform. Each entry in the list can be a string, a callable, or a dict:
If a string, it must be the name of a function in this module, e.g. “rsq_geq_threshold”.
If a callable, it must be a function that takes a model instance as an argument and return a DataFrame with columns: [“statistic”, “operator”, “threshold”, “dimensions”, “pass”, “comment”]].
If a dict, it must have a key “func” with a function to perform the check, additional dictionary entries are passed to the function as kwargs.
report (bool, optional) – If True, display a report of the check results. Default is True.
- Returns:
df – DataFrame with the results of the checks.
- Return type: