Visualization

This submodule contains various routines to plot the system of magnetic entities and pairs. Furthermore it will be able to plot the calculated magnetic exchange parameters.

Functions

plot_contour(contour)

Creates a plot from the contour sample points.

plot_kspace(kspace)

Creates a plot from the Brillouin zone sample points.

plot_magnetic_entities(magnetic_entities)

Creates a plot from a list of magnetic entities.

plot_pairs(pairs[, connect])

Creates a plot from a list of pairs.

plot_DMI(pairs[, rescale])

Creates a plot of the DM vectors from a list of pairs.

Background information

Currently all the functions are using the plotly library. This decision was made because it can be used in the Jupyter environment and supports interactive and 3D plots.

Examples

For examples, see the tutorials.