shnitsel.vis.datasheet.figures.per_state_hist

Functions

plot_per_state_histograms(per_state[, axs, fig])

Function to plot the per-state energy, forces and permanent dipole histogram plots.

Module Contents

plot_per_state_histograms(per_state, axs=None, fig=None)

Function to plot the per-state energy, forces and permanent dipole histogram plots.

Parameters:

  • per_state (PerState) – A dataset with per-state observable data.

  • axs (dict[str, Axes] | None, optional) – The map of subplot-axes. Keys identify the subplots (energy, forces, dip_perm) and the values are the axes to plot the subplot to. Defaults to None.

  • fig (Figure | SubFigure | None, optional) – Figure to generated axes from. Defaults to None.

Returns:

The axes dictionary after plotting.

Return type:

dict[str, Axes]