check
=====

.. py:module:: pastas.check

.. autoapi-nested-parse::

   This module provides functions for checking and validating Pastas models and their
   components.

   .. rubric:: Examples

   Run a checklist of standard checks on a Pastas model::

       checks = [
           {"func": rsq_geq_threshold, "threshold": 0.7},
           {"func": response_memory, "cutoff": 0.95, "factor_length_oseries": 0.5},
           {"func": uncertainty_gain, "n_std": 1.96},
           {"func": parameter_bounds},
       ]

       ps.check.checklist(ml, checks)

   Or use the list of checks defined in Brakenhoff et al. (2022)::

       ps.check.checklist(ml, ps.check.checks_brakenhoff_2022)

   ..
       !! processed by numpydoc !!


Functions
---------

.. toctree::
   :hidden:

   /api/pastas/check/rsq_geq_threshold
   /api/pastas/check/response_memory
   /api/pastas/check/response_memory_vs_warmup
   /api/pastas/check/uncertainty_gain
   /api/pastas/check/parameter_bounds
   /api/pastas/check/uncertainty_parameters
   /api/pastas/check/guess_unit_or_dims
   /api/pastas/check/acf_runs_test
   /api/pastas/check/acf_stoffer_toloi_test
   /api/pastas/check/checklist
   /api/pastas/check/print_check_report

.. autoapisummary::

   pastas.check.rsq_geq_threshold
   pastas.check.response_memory
   pastas.check.response_memory_vs_warmup
   pastas.check.uncertainty_gain
   pastas.check.parameter_bounds
   pastas.check.uncertainty_parameters
   pastas.check.guess_unit_or_dims
   pastas.check.acf_runs_test
   pastas.check.acf_stoffer_toloi_test
   pastas.check.checklist
   pastas.check.print_check_report