grogupy.viz.plot_DMI

grogupy.viz.plot_DMI(pairs: Builder | list[Pair] | PairList, rescale: float = 1, **kwargs) → Figure[source]

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

It can only use pairs from a finished simulation. The magnitude of the vectors are in meV.

Parameters

pairsUnion[Builder, list[Pair], PairList]: The pairs that contain the tags, coordinates and the DM vectors
rescalefloat, optional: The length of the vectors are rescaled by this, by default 1

Returns

plotly.graph_objs.go.Figure: The created figure