perturbopy.postproc.utils.plot_tools.plot_dispersion

perturbopy.postproc.utils.plot_tools.plot_dispersion(ax, path, energies, energy_units, c='k', ls='-', energy_window=None)

Method to plot the dispersion (phonon dispersion or band structure).

Parameters:

• ax (matplotlib.axes.Axes) – Axis on which to plot the dispersion

• path (array_like) – The array or list of path coordinates to be plotted on the x-axis

• energies (dict) – Dictionary of arrays of energies to plot, with keys labelling the band number or phonon mode.

• energy_units (str)

• c (str, list) – Matplotlib color for plotting. If a list, different colors will be iterated through as each band is plotted.

• ls (str, list) – Matplotlib linestyle for plotting. If a list, different linestyles will be iterated through as each band is plotted.

• energy_window (tuple, optional) – Tuple with the lower and upper bound of the chosen energy window

Returns:

ax – Axis with the plotted dispesion

Return type:

matplotlib.axes.Axes