grogupy.viz.plot_pairs

grogupy.viz.plot_pairs(pairs: Builder | list[Pair] | PairList, connect: bool = False, cell: bool = True, **kwargs) → Figure[source]

Creates a plot from a list of pairs.

Parameters

pairsUnion[Builder, list[Pair], PairList]: The pairs that contain the tags and coordinates
connectbool, optional: Wether to connect the pairs or not, by default False
cell: bool, optional: Wether to show the unit cell, by default True

Returns

plotly.graph_objs.go.Figure: The created figure