grogupy.viz.plot_1D_convergence

grogupy.viz.plot_1D_convergence(files: str | list[str], parameter: str, maxdiff: float = 0.0001, method: str = 'absolute', **kwargs) → Figure[source]

Reads output files and create a plot for the convergence test.

Parameters

filesUnion[str, list[str]]: The path to the output files .pkl
parameter{“eset”, “esetp”, “kset”}: The parameter for the test
maxdifffloat, optional: The criteria for the convergence by relative difference from the last step, by default 1e-4
method: str, optional: The convergence method, can be ‘relative’ or ‘absolute’, by default ‘absolute’

Returns

go.Figure: Plotly figure

Raises

Exception: Multiple parameters changed in different runs!
Exception: Unknown convergence parameter!