wulfric.PlotlyEngine.plot_kpath#
method
- PlotlyEngine.plot_kpath(kp, color='#000000', shift=(0.0, 0.0, 0.0), legend_label=None, legend_group=None, row=1, col=1)[source]#
Plots k-path in the reciprocal space.
- Parameters:
- kp
Kpoints K-points and k-path.
- colorstr, default "#000000"
Colour for the plot. Any value that is supported by Plotly.
- shift(3, ) array-like, default (0, 0, 0)
Absolute coordinates of the shift in reciprocal space.
- legend_labelstr, optional
Label for the legend. Entry in legend only showed if
legend_label is not None.- legend_groupstr, optional
Legend's group. If
None, then defaults to the random string of 10 characters.- rowint, default 1
Row of the subplot.
- colint, default 1
Column of the subplot.
- kp