grogupy.viz.plot_DMI
- grogupy.viz.plot_DMI(pairs: Builder | list[Pair] | PairList, heatplot: bool = False, rescale: float = 1, tags: None | list[str] = None, colors: None | list[str] = None, colorscale: str = 'Viridis', show_cell: bool = True, width: int = 800, height: int = 500, title: None | str = None, legend: bool = True) 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. WARNING: because the sizes of the cones are also dependent on the norm of the DM vectors, very small DMs can be missing from the fgure.
Parameters
- pairsUnion[Builder, list[Pair], PairList]
The pairs that contain the tags, coordinates and the DM vectors
- heatplotbool, optional
Whether to use heatplot or plot all DMs separatly, by default False
- rescalefloat, optional
Rescale parameter for the lengths of DM vectors. If this is not set to 1, then the lengths are not in meV, by default 1
- tagsUnion[None, list[str]], optional
The tags of the markers, if None, then it is autogenerated, by default None
- colors: Union[None, list[str]], optional
The colors of the markers, if None, then it is autogenerated, by default None
- colorscalestr, optional
The colorscale of the weights, by default Viridis
- show_cellbool, optional
Whether to show the cell or not, by default True
- widthint, optional
Width of the figure, by default 800
- heightint, optional
Height of the figure, by default 500
- titleUnion[None, str], optional
Title of the figure, if set to None, then title is not generated, by default None
- legendbool, optional
Whether to show the legend, by default True
Returns
- plotly.graph_objs.go.Figure
The created figure