pastas.check.correlation_sim_vs_res
===================================

.. py:function:: pastas.check.correlation_sim_vs_res(ml: pastas.model.Model, threshold: float = 0.2)

   
   Check if the correlation between simulated and residuals is less than threshold.

   :param ml: Pastas model instance.
   :type ml: pastas.Model
   :param threshold: Threshold value for the correlation coefficient.
   :type threshold: float

   :returns: **df** -- DataFrame with the results of the check.
   :rtype: pandas.DataFrame















   ..
       !! processed by numpydoc !!