grogupy.viz.plot_1D_convergence
- grogupy.viz.plot_1D_convergence(files: list[str], atol: float = 0.0001, rtol: float = 0.0001, marker_size: float = 10, marker_opacity: float = 1, width: int = 800, height: int = 500, title: None | str = None) Figure[source]
Reads output files and create a plot for the convergence test.
Parameters
- fileslist[str]
The path to the output files .pkl
- atolfloat, optional
Absolute tolerance to convergence, by default 1e-4
- rtolfloat, optional
Relative tolerance to convergence, by default 1e-4
- marker_sizefloat, optional
Size of the markers, by default 10
- marker_opacityfloat, optional
Opacity of the markers, by default 1
- widthint, optional
Width of the figure, by default 800
- heightint, optional
Height of the figure, by default 500
- titleUnion[None, str], optional
Title of the figure, if set to None, then title is not generated, by default None
Returns
- go.Figure
Plotly figure
Raises
- Exception
Not enough paths to compare!
- Exception
Multiple spin models in files!
- Exception
Convergence parameter not found!