quant_met.plotting.

plot_bandstructure

quant_met.plotting.plot_bandstructure(bands, k_point_list, ticks, labels, overlaps=None, overlap_labels=None, fig_in=None, ax_in=None)

Plot bands along a k space path.

To have a plot that respects the distances in k space and generate everything that is needed for plotting, use the function generate_bz_path.

Parameters:

bandsnumpy.ndarray

k_point_listnumpy.ndarray

List of points to plot against. This is not a list of two-dimensional k-points!

tickslist(float)

Position for ticks.

labelslist(str)

Labels on ticks.

overlapsnumpy.ndarray, optional

Overlaps.

overlap_labelslist(str), optional

Labels to put on overlaps.

fig_inmatplotlib.figure.Figure, optional

Figure that holds the axes. If not provided, a new figure and ax is created.

ax_inmatplotlib.axes.Axes, optional

Ax to plot the data in. If not provided, a new figure and ax is created.

Returns:

matplotlib.figure.Figure

Figure with the data plotted onto the axis.