wulfric.PlotlyEngine#

class wulfric.PlotlyEngine(fig=None, _sphinx_gallery_fix=False, rows=1, cols=1)[source]#

Plotting engine based on Plotly.

Parameters:
figplotly graph object, optional

Figure to plot on. If not provided, then a new one is created as fig = go.Figure().

_sphinx_gallery_fixbool, default False

Fixes display issues when building documentation using sphinx gallery. Please, always ignore this argument

Attributes:
figplotly graph object

Figure to plot on.

Notes

This class is a part of wulfric[visual]

Methods:

plot_atoms(cell, atoms[, colors, ...])

Plots a set of atoms.

plot_brillouin_zone(cell[, plot_vectors, ...])

Plots Brillouin zone.

plot_cell(cell[, color, plot_vectors, ...])

Plots given cell as is.

plot_kpath(kp[, color, shift, legend_label, ...])

Plots k-path in the reciprocal space.

plot_kpoints(kp[, color, shift, ...])

Plots high-symmetry k-points in the reciprocal space.

plot_lattice(cell[, color, range, shift, ...])

Plots lattice points spawned by the given cell.

plot_line(start_point, end_point[, color, ...])

Plots a single line between start_point to end_point.

plot_points(points[, colors, legend_label, ...])

Plots a set of points.

plot_vector(start_point, end_point[, color, ...])

Plots a single vector pointing from start_point to end_point.

plot_wigner_seitz_cell(cell[, plot_vectors, ...])

Plots Wigner-Seitz cell of the lattice spawned by the given cell.

save([output_name, axes_visible, ...])

Saves the figure in the html file.

show([axes_visible, legend_position])

Shows the figure in the interactive mode.