atomistics.workflows.phonons.helper.plot_band_structure

atomistics.workflows.phonons.helper.plot_band_structure(phonopy: Phonopy, axis: Any | None = None, *args, label: str | None = None, **kwargs)

Plot bandstructure calculated with get_bandstructure().

If get_bandstructure() hasn’t been called before, it is automatically called with the default arguments.

If label is passed a legend is added automatically.

Parameters:

• phonopy (Phonopy) – The Phonopy object.

• axis (matplotlib.axes._subplots.AxesSubplot, optional) – Plot to this axis, if not given a new one is created.

• *args – Passed through to matplotlib.pyplot.plot when plotting the dispersion.

• label (str, optional) – Label for dispersion line.

• **kwargs – Passed through to matplotlib.pyplot.plot when plotting the dispersion.

Returns:

The axis the figure has been drawn to, if axis is given the same object is returned.

Return type:

matplotlib.axes._subplots.AxesSubplot