qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/version.py

@@ -0,0 +1,84 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# 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.
+
+# pylint: disable=no-name-in-module,broad-except,cyclic-import
+
+"""Contains Qiskit version."""
+
+import os
+import subprocess
+
+ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
+
+
+def _minimal_ext_cmd(cmd):
+    # construct minimal environment
+    env = {}
+    for k in ["SYSTEMROOT", "PATH"]:
+        v = os.environ.get(k)
+        if v is not None:
+            env[k] = v
+    # LANGUAGE is used on win32
+    env["LANGUAGE"] = "C"
+    env["LANG"] = "C"
+    env["LC_ALL"] = "C"
+    with subprocess.Popen(
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        env=env,
+        cwd=os.path.join(os.path.dirname(ROOT_DIR)),
+    ) as proc:
+        stdout, stderr = proc.communicate()
+        if proc.returncode > 0:
+            error_message = stderr.strip().decode("ascii")
+            raise OSError(f"Command {cmd} exited with code {proc.returncode}: {error_message}")
+    return stdout
+
+
+def git_version():
+    """Get the current git head sha1."""
+    # Determine if we're at main
+    try:
+        out = _minimal_ext_cmd(["git", "rev-parse", "HEAD"])
+        git_revision = out.strip().decode("ascii")
+    except OSError:
+        git_revision = "Unknown"
+
+    return git_revision
+
+
+with open(os.path.join(ROOT_DIR, "VERSION.txt")) as version_file:
+    VERSION = version_file.read().strip()
+
+
+def get_version_info():
+    """Get the full version string."""
+    # Adding the git rev number needs to be done inside
+    # write_version_py(), otherwise the import of scipy.version messes
+    # up the build under Python 3.
+    full_version = VERSION
+
+    if not os.path.exists(os.path.join(os.path.dirname(ROOT_DIR), ".git")):
+        return full_version
+    try:
+        release = _minimal_ext_cmd(["git", "tag", "-l", "--points-at", "HEAD"])
+    except Exception:  # pylint: disable=broad-except
+        return full_version
+    git_revision = git_version()
+    if not release:
+        full_version += ".dev0+" + git_revision[:7]
+
+    return full_version
+
+
+__version__ = get_version_info()

qiskit/visualization/__init__.py

@@ -0,0 +1,288 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2022.
+#
+# 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.
+
+"""
+============================================
+Visualizations (:mod:`qiskit.visualization`)
+============================================
+
+.. currentmodule:: qiskit.visualization
+
+The visualization module contain functions that visualizes measurement outcome counts, quantum
+states, circuits, pulses, devices and more.
+
+To use visualization functions, you are required to install visualization optionals to your
+development environment:
+
+.. code-block:: bash
+
+   pip install 'qiskit[visualization]'
+
+Common Keyword Arguments
+========================
+
+Many of the figures created by visualization functions in this module are created by `Matplotlib
+<https://matplotlib.org/>`_ and accept a subset of the following common arguments. Consult the
+individual documentation for exact details.
+
+* ``title`` (``str``): a text string to use for the plot title.
+* ``legend`` (``list``): a list of strings to use for labels of the data.
+* ``figsize`` (``tuple``): figure size in inches .
+* ``color`` (``list``): a list of strings for plotting.
+* ``ax`` (`matplotlib.axes.Axes <https://matplotlib.org/stable/api/axes_api.html>`_): An optional
+  ``Axes`` object to be used for the visualization output. If none is specified a new
+  `matplotlib.figure.Figure <https://matplotlib.org/stable/api/figure_api.html>`_ will be created
+  and used. Additionally, if specified there will be no returned ``Figure`` since it is redundant.
+* ``filename`` (``str``): file path to save image to.
+
+The following example demonstrates the common usage of these arguments:
+
+.. plot::
+   :include-source:
+
+   from qiskit.visualization import plot_histogram
+
+   counts1 = {'00': 499, '11': 501}
+   counts2 = {'00': 511, '11': 489}
+
+   data = [counts1, counts2]
+   plot_histogram(data)
+
+You can specify ``legend``, ``title``, ``figsize`` and ``color`` by passing to the kwargs.
+
+.. plot::
+   :include-source:
+
+   from qiskit.visualization import plot_histogram
+
+   counts1 = {'00': 499, '11': 501}
+   counts2 = {'00': 511, '11': 489}
+   data = [counts1, counts2]
+
+   legend = ['First execution', 'Second execution']
+   title = 'New histogram'
+   figsize = (10,10)
+   color=['crimson','midnightblue']
+   plot_histogram(data, legend=legend, title=title, figsize=figsize, color=color)
+
+You can save the figure to file either by passing the file name to ``filename`` kwarg or use
+`matplotlib.figure.Figure.savefig
+<https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure.savefig>`_ method.
+
+.. code-block:: python
+
+   plot_histogram(data, filename='new_hist.png')
+
+   hist = plot_histogram(data)
+   hist.savefig('new_hist.png')
+
+Counts Visualizations
+=====================
+
+This section contains functions that visualize measurement outcome counts.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   plot_histogram
+
+Example Usage
+-------------
+
+Here is an example of using :func:`plot_histogram` to visualize measurement outcome counts:
+
+.. plot::
+   :include-source:
+
+   from qiskit.visualization import plot_histogram
+
+   counts = {"00": 501, "11": 499}
+   plot_histogram(counts)
+
+The data can be a dictionary with bit string as key and counts as value, or more commonly a
+:class:`~qiskit.result.Counts` object obtained from :meth:`~qiskit.result.Result.get_counts`.
+
+Distribution Visualizations
+===========================
+
+This section contains functions that visualize sampled distributions.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   plot_distribution
+
+State Visualizations
+====================
+
+This section contains functions that visualize quantum states.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   plot_bloch_vector
+   plot_bloch_multivector
+   plot_state_city
+   plot_state_hinton
+   plot_state_paulivec
+   plot_state_qsphere
+
+Example Usage
+-------------
+
+Here is an example of using :func:`plot_state_city` to visualize a quantum state:
+
+.. plot::
+   :include-source:
+
+   from qiskit.visualization import plot_state_city
+
+   state = [[ 0.75  , 0.433j],
+            [-0.433j, 0.25  ]]
+   plot_state_city(state)
+
+The state can be array-like list of lists, ``numpy.array``, or more commonly
+:class:`~qiskit.quantum_info.Statevector` or :class:`~qiskit.quantum_info.DensityMatrix` objects
+obtained from a :class:`~qiskit.circuit.QuantumCircuit`:
+
+.. plot::
+   :include-source:
+
+   from qiskit import QuantumCircuit
+   from qiskit.quantum_info import Statevector
+   from qiskit.visualization import plot_state_city
+
+   qc = QuantumCircuit(2)
+   qc.h(0)
+   qc.cx(0,1)
+
+   # plot using a Statevector
+   state = Statevector(qc)
+   plot_state_city(state)
+
+.. plot::
+   :include-source:
+
+   from qiskit import QuantumCircuit
+   from qiskit.quantum_info import DensityMatrix
+   from qiskit.visualization import plot_state_city
+
+   qc = QuantumCircuit(2)
+   qc.h(0)
+   qc.cx(0,1)
+
+   # plot using a DensityMatrix
+   state = DensityMatrix(qc)
+   plot_state_city(state)
+
+You can find code examples for each visualization functions on the individual function API page.
+
+Device Visualizations
+=====================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   plot_gate_map
+   plot_error_map
+   plot_circuit_layout
+   plot_coupling_map
+
+Circuit Visualizations
+======================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   circuit_drawer
+
+DAG Visualizations
+==================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   dag_drawer
+
+Pass Manager Visualizations
+===========================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   pass_manager_drawer
+
+Timeline Visualizations
+=======================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   timeline_drawer
+
+Single Qubit State Transition Visualizations
+============================================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   visualize_transition
+
+Array/Matrix Visualizations
+===========================
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   array_to_latex
+
+Exceptions
+==========
+
+.. autoexception:: VisualizationError
+"""
+
+import os
+import sys
+
+from .array import array_to_latex
+
+from .circuit import circuit_drawer
+from .counts_visualization import plot_histogram, plot_distribution
+from .state_visualization import (
+    plot_state_hinton,
+    plot_bloch_vector,
+    plot_bloch_multivector,
+    plot_state_city,
+    plot_state_paulivec,
+    plot_state_qsphere,
+    state_drawer,
+)
+from .transition_visualization import visualize_transition
+from .dag_visualization import dag_drawer
+from .gate_map import plot_gate_map, plot_circuit_layout, plot_error_map, plot_coupling_map
+from .pass_manager_visualization import pass_manager_drawer
+from .pass_manager_visualization import staged_pass_manager_drawer
+
+from .pulse_v2 import draw as pulse_drawer
+
+from .timeline import draw as timeline_drawer
+
+from .exceptions import VisualizationError
+
+# These modules aren't part of the public interface, and were moved in Terra 0.22.  They're
+# re-imported here to allow a backwards compatible path, and should be deprecated in Terra 0.23.
+from .circuit import text, matplotlib, latex
+
+# Prepare for migration of old versioned name to unversioned name.  The `pulse_drawer_v2` name can
+# be deprecated in Terra 0.24, as `pulse_drawer` became available by that name in Terra 0.23.
+pulse_drawer_v2 = pulse_drawer

qiskit/visualization/array.py

@@ -0,0 +1,204 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2020.
+#
+# 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.
+"""
+Tools to create LaTeX arrays.
+"""
+
+import numpy as np
+
+from qiskit.exceptions import MissingOptionalLibraryError
+
+
+def _num_to_latex(raw_value, decimals=15, first_term=True, coefficient=False):
+    """Convert a complex number to latex code suitable for a ket expression
+
+    Args:
+        raw_value (complex): Value to convert.
+        decimals (int): Number of decimal places to round to (default 15).
+        coefficient (bool): Whether the number is to be used as a coefficient
+                            of a ket.
+        first_term (bool): If a coefficient, whether this number is the first
+                           coefficient in the expression.
+    Returns:
+        str: latex code
+    """
+    import sympy  # runtime import
+
+    raw_value = np.around(raw_value, decimals=decimals).item()
+    value = sympy.nsimplify(raw_value, rational=False)
+
+    if isinstance(value, sympy.core.numbers.Rational) and value.denominator > 50:
+        # Avoid showing ugly fractions (e.g. 50498971964399/62500000000000)
+        value = value.evalf()  # Display as float
+
+    if isinstance(value, sympy.core.numbers.Float):
+        value = round(value, decimals)
+
+    element = sympy.latex(value, full_prec=False)
+
+    if not coefficient:
+        return element
+
+    if isinstance(value, sympy.core.Add):
+        # element has two terms
+        element = f"({element})"
+
+    if element == "1":
+        element = ""
+
+    if element == "-1":
+        element = "-"
+
+    if not first_term and not element.startswith("-"):
+        element = f"+{element}"
+
+    return element
+
+
+def _matrix_to_latex(matrix, decimals=10, prefix="", max_size=(8, 8)):
+    """Latex representation of a complex numpy array (with maximum dimension 2)
+
+    Args:
+        matrix (ndarray): The matrix to be converted to latex, must have dimension 2.
+        decimals (int): For numbers not close to integers, the number of decimal places
+                         to round to.
+        prefix (str): Latex string to be prepended to the latex, intended for labels.
+        max_size (list(```int```)): Indexable containing two integers: Maximum width and maximum
+                          height of output Latex matrix (including dots characters). If the
+                          width and/or height of matrix exceeds the maximum, the centre values
+                          will be replaced with dots. Maximum width or height must be greater
+                          than 3.
+
+    Returns:
+        str: Latex representation of the matrix
+
+    Raises:
+        ValueError: If minimum value in max_size < 3
+    """
+    if min(max_size) < 3:
+        raise ValueError("""Smallest value in max_size must be greater than or equal to 3""")
+
+    out_string = f"\n{prefix}\n"
+    out_string += "\\begin{bmatrix}\n"
+
+    def _elements_to_latex(elements):
+        # Takes a list of elements (a row) and creates a latex
+        # string from it; Each element separated by `&`
+        el_string = ""
+        for el in elements:
+            num_string = _num_to_latex(el, decimals=decimals)
+            el_string += num_string + " & "
+        el_string = el_string[:-2]  # remove trailing ampersands
+        return el_string
+
+    def _rows_to_latex(rows, max_width):
+        # Takes a list of lists (list of 'rows') and creates a
+        # latex string from it
+        row_string = ""
+        for r in rows:
+            if len(r) <= max_width:
+                row_string += _elements_to_latex(r)
+            else:
+                row_string += _elements_to_latex(r[: max_width // 2])
+                row_string += "& \\cdots & "
+                row_string += _elements_to_latex(r[-max_width // 2 + 1 :])
+            row_string += " \\\\\n "
+        return row_string
+
+    max_width, max_height = max_size
+    if matrix.ndim == 1:
+        out_string += _rows_to_latex([matrix], max_width)
+
+    elif len(matrix) > max_height:
+        # We need to truncate vertically, so we process the rows at the beginning
+        # and end, and add a line of vertical elipse (dots) characters between them
+        out_string += _rows_to_latex(matrix[: max_height // 2], max_width)
+
+        if max_width >= matrix.shape[1]:
+            out_string += "\\vdots & " * matrix.shape[1]
+        else:
+            # In this case we need to add the diagonal dots in line with the column
+            # of horizontal dots
+            pre_vdots = max_width // 2
+            post_vdots = max_width // 2 + np.mod(max_width, 2) - 1
+            out_string += "\\vdots & " * pre_vdots
+            out_string += "\\ddots & "
+            out_string += "\\vdots & " * post_vdots
+
+        out_string = out_string[:-2] + "\\\\\n "
+        out_string += _rows_to_latex(matrix[-max_height // 2 + 1 :], max_width)
+
+    else:
+        out_string += _rows_to_latex(matrix, max_width)
+    out_string += "\\end{bmatrix}\n"
+    return out_string
+
+
+def array_to_latex(array, precision=10, prefix="", source=False, max_size=8):
+    """Latex representation of a complex numpy array (with dimension 1 or 2)
+
+    Args:
+        array (ndarray): The array to be converted to latex, must have dimension 1 or 2 and
+                         contain only numerical data.
+        precision (int): For numbers not close to integers or common terms, the number of
+                         decimal places to round to.
+        prefix (str): Latex string to be prepended to the latex, intended for labels.
+        source (bool): If ``False``, will return IPython.display.Latex object. If display is
+                       ``True``, will instead return the LaTeX source string.
+        max_size (list(int) or int): The maximum size of the output Latex array.
+
+            * If list(``int``), then the 0th element of the list specifies the maximum
+              width (including dots characters) and the 1st specifies the maximum height
+              (also inc. dots characters).
+            * If a single ``int`` then this value sets the maximum width _and_ maximum
+              height.
+
+    Returns:
+        str or IPython.display.Latex: If ``source`` is ``True``, a ``str`` of the LaTeX
+            representation of the array, else an ``IPython.display.Latex`` representation of
+            the array.
+
+    Raises:
+        TypeError: If array can not be interpreted as a numerical numpy array.
+        ValueError: If the dimension of array is not 1 or 2.
+        MissingOptionalLibraryError: If ``source`` is ``False`` and ``IPython.display.Latex`` cannot be
+                     imported.
+    """
+    try:
+        array = np.asarray(array)
+        _ = array[0] + 1  # Test first element contains numerical data
+    except TypeError as err:
+        raise TypeError(
+            """array_to_latex can only convert numpy arrays containing numerical data,
+        or types that can be converted to such arrays"""
+        ) from err
+
+    if array.ndim > 2:
+        raise ValueError("array_to_latex can only convert numpy ndarrays of dimension 1 or 2")
+
+    if isinstance(max_size, int):
+        max_size = (max_size, max_size)
+
+    outstr = _matrix_to_latex(array, decimals=precision, prefix=prefix, max_size=max_size)
+
+    if source is True:
+        return outstr
+
+    try:
+        from IPython.display import Latex
+    except ImportError as err:
+        raise MissingOptionalLibraryError(
+            libname="IPython",
+            name="array_to_latex",
+            pip_install="pip install ipython",
+        ) from err
+    return Latex(f"$${outstr}$$")