plot_levels

Model.plot_levels(zoom_electron_state=None, *, height=None, return_fig_ax=False)

Plot the energy spectrum with optionally zoomed electron subpanels.

Parameters:
  • zoom_electron_state (List[Tuple[float, ...]] | None) – Electron basis states that receive dedicated zoom panels. Each entry must be an iterable of quantum numbers (for example [(0,), (-1,), (1,)]). When omitted and the system has a single electron spin, all of its basis states are zoomed.

  • height (float | None) – Total figure height in inches. If None, a height is chosen automatically based on the number of spins (capped at 12 inches).

  • return_fig_ax (bool) – Whether to return the created Matplotlib figure and main axis.

Raises:

SimphonyError – If the static Hamiltonian has not been calculated or the model contains more than three electron spins.

Returns:

Figure and main axis if return_fig_ax is True.