pastas.check.correlation_sim_vs_res#

pastas.check.correlation_sim_vs_res(ml: pastas.typing.Model, threshold: float = 0.2)#

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

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

  • threshold (float) – Threshold value for the correlation coefficient.

Returns:

df – DataFrame with the results of the check.

Return type:

pandas.DataFrame