qilisdk.utils.visualization.style

Classes

Style	!!! abstract "Usage Documentation"
QTensorStyle	All visual parameters controlling the appearance of a QTensor plot.
CircuitStyle	All visual parameters controlling the appearance of a circuit plot.
HamiltonianStyle	All visual parameters controlling the appearance of a Hamiltonian interaction graph.
ScheduleStyle	Customization options for matplotlib schedule plots, with theme support.
DatasetStyle	Customization options for matplotlib dataset plots, with theme support.

Module Contents

class Style(/, **data: Any)

Bases: pydantic.BaseModel

!!! abstract «Usage Documentation»

[Models](../concepts/models.md)

A base class for creating Pydantic models.

__class_vars__

The names of the class variables defined on the model.

__private_attributes__

Metadata about the private attributes of the model.

__signature__

The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__

Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__

The core schema of the model.

__pydantic_custom_init__

Whether the model has a custom __init__ function.

__pydantic_decorators__

Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__

A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

__pydantic_parent_namespace__

Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__

The name of the post-init method for the model, if defined.

__pydantic_root_model__

Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__

The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__

The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__

A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__

A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__

A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to “allow”.

__pydantic_fields_set__

The names of fields explicitly set during instantiation.

__pydantic_private__

Values of private attributes set on the model instance.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

theme: qilisdk.utils.visualization.themes.Theme

fontfamily: str | list[str] | None

fontstyle: Literal['normal', 'italic', 'oblique']

fontvariant: Literal['normal', 'small-caps']

fontweight: str | int

fontstretch: str | int

fontsize: float | str

fontfname: str | None

math_fontfamily: str | None

dpi: int

title: str | None

property font: matplotlib.font_manager.FontProperties

Construct a Matplotlib FontProperties from the configured fields. If fontfname points to a real file, it is used (and overrides family).

class QTensorStyle(/, **data: Any)

Bases: Style

All visual parameters controlling the appearance of a QTensor plot.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

sphere_points: int

sphere_color: str

arrow_color: str

arrow_length_ratio: float

draw_center_circle: bool

centre_circle_color: str

draw_reference_points: bool

reference_point_distance: float

rotation_style: Literal['azel', 'trackball', 'sphere', 'arcball']

class CircuitStyle(/, **data: Any)

Bases: Style

All visual parameters controlling the appearance of a circuit plot.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

end_wire_ext: int

padding: float

gate_margin: float

wire_sep: float

layer_sep: float

gate_pad: float

label_pad: float

bulge: str

align_layer: bool

wire_label: list[Any] | None

start_pad: float

min_gate_h: float

min_gate_w: float

connector_r: float

target_r: float

control_r: float

layout: Literal['normal', 'compact']

fold: Annotated[int, Field(gt=0)] | Literal['auto'] | None

max_row_width: float

row_separation: float

fold_edges: Literal['dashed', 'closed', 'open']

fold_dash: float

max_view_height: Annotated[float, Field(gt=0.0)] | None

class HamiltonianStyle(/, **data: Any)

Bases: Style

All visual parameters controlling the appearance of a Hamiltonian interaction graph.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

figsize: tuple | None

tight_layout: bool

title_fontsize: int

layout: Literal['spring', 'circular', 'shell', 'spiral', 'random']

layout_seed: int

positions: dict[int, tuple[float, float]] | None

node_radius: float

min_node_radius: float

show_qubit_labels: bool

qubit_label_fontsize: int

show_field_labels: bool

field_label_fontsize: int

coupling_linewidth: float

coupling_curvature: float

coupling_line_styles: dict[str, Any]

default_coupling_line_styles: list[Any]

show_coupling_labels: bool

coupling_label_fontsize: int

show_multi_body: bool

colormap: str | None

show_colorbar: bool

colorbar_shrink: float

colorbar_label: str | None

separate_color_scales: bool

show_legend: bool

legend_loc: str

legend_fontsize: int

legend_frame: bool

show_identity_offset: bool

class ScheduleStyle(/, **data: Any)

Bases: Style

Customization options for matplotlib schedule plots, with theme support.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

figsize: tuple | None

grid: bool

grid_style: dict[str, Any]

title_fontsize: int

xlabel: str

ylabel: str

label_fontsize: int

legend_loc: str

legend_fontsize: int

legend_frame: bool

line_styles: dict[str, dict[str, Any]]

default_line_style: dict[str, Any]

marker: str | None

marker_size: int

xtick_fontsize: int

ytick_fontsize: int

tick_color: str | None

tight_layout: bool

class DatasetStyle(/, **data: Any)

Bases: Style

Customization options for matplotlib dataset plots, with theme support.

Controls only the appearance of a dataset plot (theme, fonts, colours, grid, markers, …). The kind of plot ("1d", "2d" or "3d") is selected separately via the style argument of Dataset.draw().

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

figsize: tuple | None

grid: bool

grid_style: dict[str, Any]

title_fontsize: int

label_fontsize: int

xlabel: str | None

ylabel: str | None

zlabel: str | None

legend_loc: str

legend_fontsize: int

legend_frame: bool

trajectory_style: Literal['scatter', 'line']

line_style: dict[str, Any]

marker: str | None

marker_size: float

point_size: float

color_by_time: bool

colorbar: bool

delay: int

xtick_fontsize: int

ytick_fontsize: int

tight_layout: bool