iwfm.diagnostics.read_convergence_hdf¶

iwfm.diagnostics.read_convergence_hdf(hdf_path, max_iter_threshold=40, diffmax_threshold=0.1, top_n_trouble=10, verbose=False)[source]¶

Read Diagnostics_Convergence.hdf and compute summary statistics.

Parameters:

hdf_path (str) – Path to Diagnostics_Convergence.hdf.
max_iter_threshold (int) – Flag timesteps with ITERX >= this value.
diffmax_threshold (float) – Flag timesteps with abs(DIFFMAX) >= this value.
top_n_trouble (int) – Max number of trouble timesteps to report.
verbose (bool) – Print progress.

Return type:

ConvergenceSummary