grogupy.viz.plot_onsite_anisotropy

grogupy.viz.plot_onsite_anisotropy(magnetic_entities: Builder | list[MagneticEntity] | MagneticEntityList, colorscale: str = 'Viridis', show_cell: bool = True, width: int = 800, height: int = 500, title: None | str = None) → Figure

Creates a plot of the on-site anisotropy from a list of magnetic entities.

Based on the work of Marcell Sipos.

Parameters

magnetic_entitiesUnion[Builder, list[MagneticEntity], MagneticEntityList]

The magnetic entities that contain the tags and coordinates

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