vibeqc.plot.band_structure_figure¶
- vibeqc.plot.band_structure_figure(bs, *, ax=None, units='eV', shift_to_fermi=True, color='tab:blue', linewidth=1.0, title=None)[source]¶
Draw a band-structure plot.
- Parameters:
bs (BandStructure) –
vibeqc.BandStructurefromvibeqc.band_structure().ax – Existing matplotlib axes; a new figure is made if
None.units (str) –
"eV"(default) or"Hartree".shift_to_fermi (bool) – If True and
bs.e_fermiis set, shift the y-axis so the Fermi level sits at zero.color (str)
linewidth (float)
title (str | None)