qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/visualization/circuit/qcstyle.py

@@ -0,0 +1,130 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Matplotlib circuit visualization style."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+from qiskit.visualization.style import StyleDict, DefaultStyle
+
+
+class MPLStyleDict(StyleDict):
+    """A dictionary for matplotlib styles.
+
+    Defines additional abbreviations for key accesses, such as allowing
+    ``"ec"`` instead of writing ``"edgecolor"``.
+    """
+
+    VALID_FIELDS = {
+        "name",
+        "textcolor",
+        "gatetextcolor",
+        "subtextcolor",
+        "linecolor",
+        "creglinecolor",
+        "gatefacecolor",
+        "barrierfacecolor",
+        "backgroundcolor",
+        "edgecolor",
+        "fontsize",
+        "subfontsize",
+        "showindex",
+        "figwidth",
+        "dpi",
+        "margin",
+        "creglinestyle",
+        "displaytext",
+        "displaycolor",
+    }
+
+    ABBREVIATIONS = {
+        "tc": "textcolor",
+        "gt": "gatetextcolor",
+        "sc": "subtextcolor",
+        "lc": "linecolor",
+        "cc": "creglinecolor",
+        "gc": "gatefacecolor",
+        "bc": "barrierfacecolor",
+        "bg": "backgroundcolor",
+        "ec": "edgecolor",
+        "fs": "fontsize",
+        "sfs": "subfontsize",
+        "index": "showindex",
+        "cline": "creglinestyle",
+        "disptex": "displaytext",
+        "dispcol": "displaycolor",
+    }
+
+    NESTED_ATTRS = {"displaycolor", "displaytext"}
+
+
+class MPLDefaultStyle(DefaultStyle):
+    """Creates a Default Style dictionary
+
+    The style dict contains numerous options that define the style of the
+    output circuit visualization. The style dict is used by the `mpl` or
+    `latex` output. The options available in the style dict are defined below:
+
+    Attributes:
+        name (str): The name of the style. The name can be set to ``iqp``,
+            ``iqp-dark``, ``textbook``, ``bw``, ``clifford``, or the name of a
+            user-created json file. This overrides the setting in the user config
+            file (usually ``~/.qiskit/settings.conf``).
+        textcolor (str): the color code to use for all text not inside a gate.
+        subtextcolor (str): the color code to use for subtext.
+        linecolor (str): the color code to use for lines.
+        creglinecolor (str): The color code to use for classical register lines.
+        gatetextcolor (str): The color code to use for gate text.
+        gatefacecolor (str): The color code to use for a gate if no color
+            specified in the 'displaycolor' dict.
+        barrierfacecolor (str): The color code to use for barriers.
+        backgroundcolor (str): The color code to use for the background.
+        edgecolor (str): The color code to use for gate edges when using the
+            `bw` style.
+        fontsize (int): The font size to use for text.
+        subfontsize (int): The font size to use for subtext.
+        showindex (bool): If set to True, show the index numbers at the top.
+        figwidth (int): The maximum width (in inches) for the output figure.
+            If set to -1, the maximum displayable width will be used.
+        dpi (int): The DPI to use for the output image.
+        margin (list): A list of margin values to adjust spacing around output
+            image. Takes a list of 4 ints: [x left, x right, y bottom, y top].
+        creglinestyle (str): The style of line to use for classical registers.
+            Choices are ``solid``, ``doublet``, or any valid matplotlib
+            `linestyle` kwarg value.
+        displaytext (dict): a dictionary of the text to use for certain element
+            types in the output visualization. These items allow the use of
+            LaTeX formatting for gate names. The 'displaytext' dict can contain
+            any number of elements. User created names and labels may be used as
+            keys, which allow these to have Latex formatting.
+        displaycolor (dict): the color codes to use for each circuit element in
+            the form (gate_color, text_color). Colors can also be entered without
+            the text color, such as 'u1': '#FA74A6', in which case the text color
+            will always be `gatetextcolor`. The `displaycolor` dict can contain
+            any number of elements. User names and labels may be used as keys,
+            which allows for custom colors for user-created gates.
+    """
+
+    DEFAULT_STYLE_NAME = "iqp"
+    DEFAULT_STYLE_PATH = Path(__file__).parent / "styles"
+
+    def __init__(self):
+        path = self.DEFAULT_STYLE_PATH / Path(self.DEFAULT_STYLE_NAME).with_suffix(".json")
+
+        with open(path, "r") as infile:
+            default_style = json.load(infile)
+
+        # set shortcuts, such as "ec" for "edgecolor"
+        self.style = MPLStyleDict(**default_style)

qiskit/visualization/circuit/styles/__init__.py

@@ -0,0 +1,13 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2014.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Empty init for data directory."""

qiskit/visualization/circuit/styles/bw.json

@@ -0,0 +1,202 @@
+{
+    "name": "bw",
+    "textcolor": "#000000",
+    "gatetextcolor": "#000000",
+    "subtextcolor": "#000000",
+    "linecolor": "#000000",
+    "creglinecolor": "#778899",
+    "gatefacecolor": "#FFFFFF",
+    "barrierfacecolor": "#BDBDBD",
+    "backgroundcolor": "#FFFFFF",
+    "edgecolor": "#000000",
+    "fontsize": 13,
+    "subfontsize": 8,
+    "showindex": false,
+    "figwidth": -1,
+    "dpi": 150,
+    "margin": [
+        2.0,
+        0.1,
+        0.1,
+        0.3
+    ],
+    "creglinestyle": "doublet",
+    "displaytext": {
+        "u1": "U_1",
+        "u2": "U_2",
+        "u3": "U_3",
+        "id": "I",
+        "sdg": "S^\\dagger",
+        "sx": "\\sqrt{X}",
+        "sxdg": "\\sqrt{X}^\\dagger",
+        "tdg": "T^\\dagger",
+        "ms": "MS",
+        "rx": "R_X",
+        "ry": "R_Y",
+        "rz": "R_Z",
+        "rxx": "R_{XX}",
+        "ryy": "R_{YY}",
+        "rzx": "R_{ZX}",
+        "rzz": "ZZ",
+        "reset": "\\left|0\\right\\rangle",
+        "initialize": "$|\\psi\\rangle$"
+    },
+    "displaycolor": {
+        "u1": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "u2": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "u3": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "u": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "p": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "id": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "x": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "y": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "z": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "h": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "cx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "ccx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "mcx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "mcx_gray": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "cy": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "cz": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "swap": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "cswap": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "ccswap": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "dcx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "cdcx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "ccdcx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "iswap": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "s": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "sdg": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "t": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "tdg": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "sx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "sxdg": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "r": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "rx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "ry": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "rz": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "rxx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "ryy": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "rzx": [
+            "#FFFFFF",
+            "#000000"
+        ],
+        "reset": [
+            "#000000",
+            "#FFFFFF"
+        ],
+        "target": [
+            "#FFFFFF",
+            "#FFFFFF"
+        ],
+        "measure": [
+            "#000000",
+            "#FFFFFF"
+        ]
+    }
+}

qiskit/visualization/circuit/styles/clifford.json

@@ -0,0 +1,202 @@
+{
+    "name": "default",
+    "textcolor": "#000000",
+    "gatetextcolor": "#000000",
+    "subtextcolor": "#000000",
+    "linecolor": "#000000",
+    "creglinecolor": "#778899",
+    "gatefacecolor": "#BB8BFF",
+    "barrierfacecolor": "#BDBDBD",
+    "backgroundcolor": "#FFFFFF",
+    "edgecolor": null,
+    "fontsize": 13,
+    "subfontsize": 8,
+    "showindex": false,
+    "figwidth": -1,
+    "dpi": 150,
+    "margin": [
+        2.0,
+        0.1,
+        0.1,
+        0.3
+    ],
+    "creglinestyle": "doublet",
+    "displaytext": {
+        "u1": "U_1",
+        "u2": "U_2",
+        "u3": "U_3",
+        "id": "I",
+        "sdg": "S^\\dagger",
+        "sx": "\\sqrt{X}",
+        "sxdg": "\\sqrt{X}^\\dagger",
+        "tdg": "T^\\dagger",
+        "ms": "MS",
+        "rx": "R_X",
+        "ry": "R_Y",
+        "rz": "R_Z",
+        "rxx": "R_{XX}",
+        "ryy": "R_{YY}",
+        "rzx": "R_{ZX}",
+        "rzz": "ZZ",
+        "reset": "\\left|0\\right\\rangle",
+        "initialize": "$|\\psi\\rangle$"
+    },
+    "displaycolor": {
+        "u1": [
+            "#FA74A6",
+            "#000000"
+        ],
+        "u2": [
+            "#FA74A6",
+            "#000000"
+        ],
+        "u3": [
+            "#FA74A6",
+            "#000000"
+        ],
+        "u": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "p": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "id": [
+            "#05BAB6",
+            "#000000"
+        ],
+        "x": [
+            "#05BAB6",
+            "#000000"
+        ],
+        "y": [
+            "#05BAB6",
+            "#000000"
+        ],
+        "z": [
+            "#05BAB6",
+            "#000000"
+        ],
+        "h": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "cx": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "ccx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "mcx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "mcx_gray": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "cy": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "cz": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "swap": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "cswap": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "ccswap": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "dcx": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "cdcx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "ccdcx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "iswap": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "s": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "sdg": [
+            "#6FA4FF",
+            "#000000"
+        ],
+        "t": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "tdg": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "sx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "sxdg": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "r": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "rx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "ry": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "rz": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "rxx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "ryy": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "rzx": [
+            "#BB8BFF",
+            "#000000"
+        ],
+        "reset": [
+            "#000000",
+            "#FFFFFF"
+        ],
+        "target": [
+            "#FFFFFF",
+            "#FFFFFF"
+        ],
+        "measure": [
+            "#000000",
+            "#FFFFFF"
+        ]
+    }
+}