qiskit 1.3.0__cp39-abi3-macosx_11_0_arm64.whl

qiskit/visualization/transition_visualization.py

@@ -0,0 +1,369 @@
+# 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.
+
+"""
+Visualization function for animation of state transitions by applying gates to single qubit.
+"""
+import sys
+from math import sin, cos, acos, sqrt
+import numpy as np
+
+from qiskit.exceptions import MissingOptionalLibraryError
+from qiskit.utils.deprecation import deprecate_func
+
+
+def _normalize(v, tolerance=0.00001):
+    """Makes sure magnitude of the vector is 1 with given tolerance"""
+
+    mag2 = sum(n * n for n in v)
+    if abs(mag2 - 1.0) > tolerance:
+        mag = sqrt(mag2)
+        v = tuple(n / mag for n in v)
+    return np.array(v)
+
+
+class _Quaternion:
+    """For calculating vectors on unit sphere"""
+
+    def __init__(self):
+        self._val = None
+
+    @staticmethod
+    def from_axisangle(theta, v):
+        """Create quaternion from axis"""
+        v = _normalize(v)
+
+        new_quaternion = _Quaternion()
+        new_quaternion._axisangle_to_q(theta, v)
+        return new_quaternion
+
+    @staticmethod
+    def from_value(value):
+        """Create quaternion from vector"""
+        new_quaternion = _Quaternion()
+        new_quaternion._val = value
+        return new_quaternion
+
+    def _axisangle_to_q(self, theta, v):
+        """Convert axis and angle to quaternion"""
+        x = v[0]
+        y = v[1]
+        z = v[2]
+
+        w = cos(theta / 2.0)
+        x = x * sin(theta / 2.0)
+        y = y * sin(theta / 2.0)
+        z = z * sin(theta / 2.0)
+
+        self._val = np.array([w, x, y, z])
+
+    def __mul__(self, b):
+        """Multiplication of quaternion with quaternion or vector"""
+
+        if isinstance(b, _Quaternion):
+            return self._multiply_with_quaternion(b)
+        elif isinstance(b, (list, tuple, np.ndarray)):
+            if len(b) != 3:
+                raise ValueError(f"Input vector has invalid length {len(b)}")
+            return self._multiply_with_vector(b)
+        else:
+            return NotImplemented
+
+    def _multiply_with_quaternion(self, q_2):
+        """Multiplication of quaternion with quaternion"""
+        w_1, x_1, y_1, z_1 = self._val
+        w_2, x_2, y_2, z_2 = q_2._val
+        w = w_1 * w_2 - x_1 * x_2 - y_1 * y_2 - z_1 * z_2
+        x = w_1 * x_2 + x_1 * w_2 + y_1 * z_2 - z_1 * y_2
+        y = w_1 * y_2 + y_1 * w_2 + z_1 * x_2 - x_1 * z_2
+        z = w_1 * z_2 + z_1 * w_2 + x_1 * y_2 - y_1 * x_2
+
+        result = _Quaternion.from_value(np.array((w, x, y, z)))
+        return result
+
+    def _multiply_with_vector(self, v):
+        """Multiplication of quaternion with vector"""
+        q_2 = _Quaternion.from_value(np.append((0.0), v))
+        return (self * q_2 * self.get_conjugate())._val[1:]
+
+    def get_conjugate(self):
+        """Conjugation of quaternion"""
+        w, x, y, z = self._val
+        result = _Quaternion.from_value(np.array((w, -x, -y, -z)))
+        return result
+
+    def __repr__(self):
+        theta, v = self.get_axisangle()
+        return f"(({theta}; {v[0]}, {v[1]}, {v[2]}))"
+
+    def get_axisangle(self):
+        """Returns angle and vector of quaternion"""
+        w, v = self._val[0], self._val[1:]
+        theta = acos(w) * 2.0
+
+        return theta, _normalize(v)
+
+    def tolist(self):
+        """Converts quaternion to a list"""
+        return self._val.tolist()
+
+    def vector_norm(self):
+        """Calculates norm of quaternion"""
+        _, v = self.get_axisangle()
+        return np.linalg.norm(v)
+
+
+@deprecate_func(
+    since="1.2.0",
+    removal_timeline="in the 2.0 release",
+)
+def visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2):
+    """
+    Creates animation showing transitions between states of a single
+    qubit by applying quantum gates.
+
+    Args:
+        circuit (QuantumCircuit): Qiskit single-qubit QuantumCircuit. Gates supported are
+            h,x, y, z, rx, ry, rz, s, sdg, t, tdg and u1.
+        trace (bool): Controls whether to display tracing vectors - history of 10 past vectors
+            at each step of the animation.
+        saveas (str): User can choose to save the animation as a video to their filesystem.
+            This argument is a string of path with filename and extension (e.g. "movie.mp4" to
+            save the video in current working directory).
+        fpg (int): Frames per gate. Finer control over animation smoothness and computational
+            needs to render the animation. Works well for tkinter GUI as it is, for jupyter GUI
+            it might be preferable to choose fpg between 5-30.
+        spg (int): Seconds per gate. How many seconds should animation of individual gate
+            transitions take.
+
+    Returns:
+        IPython.core.display.HTML:
+            If arg jupyter is set to True. Otherwise opens tkinter GUI and returns
+            after the GUI is closed.
+
+    Raises:
+        MissingOptionalLibraryError: Must have Matplotlib (and/or IPython) installed.
+        VisualizationError: Given gate(s) are not supported.
+
+    """
+    try:
+        from IPython.display import HTML
+
+        has_ipython = True
+    except ImportError:
+        has_ipython = False
+
+    try:
+        import matplotlib
+        from matplotlib import pyplot as plt
+        from matplotlib import animation
+        from mpl_toolkits.mplot3d import Axes3D
+        from .bloch import Bloch
+        from .exceptions import VisualizationError
+
+        has_matplotlib = True
+    except ImportError:
+        has_matplotlib = False
+
+    jupyter = False
+    if ("ipykernel" in sys.modules) and ("spyder" not in sys.modules):
+        jupyter = True
+
+    if not has_matplotlib:
+        raise MissingOptionalLibraryError(
+            libname="Matplotlib",
+            name="visualize_transition",
+            pip_install="pip install matplotlib",
+        )
+    if not has_ipython and jupyter is True:
+        raise MissingOptionalLibraryError(
+            libname="IPython",
+            name="visualize_transition",
+            pip_install="pip install ipython",
+        )
+    if len(circuit.qubits) != 1:
+        raise VisualizationError("Only one qubit circuits are supported")
+
+    frames_per_gate = fpg
+    time_between_frames = (spg * 1000) / fpg
+
+    # quaternions of gates which don't take parameters
+    simple_gates = {}
+    simple_gates["x"] = (
+        "x",
+        _Quaternion.from_axisangle(np.pi / frames_per_gate, [1, 0, 0]),
+        "#1abc9c",
+    )
+    simple_gates["y"] = (
+        "y",
+        _Quaternion.from_axisangle(np.pi / frames_per_gate, [0, 1, 0]),
+        "#2ecc71",
+    )
+    simple_gates["z"] = (
+        "z",
+        _Quaternion.from_axisangle(np.pi / frames_per_gate, [0, 0, 1]),
+        "#3498db",
+    )
+    simple_gates["s"] = (
+        "s",
+        _Quaternion.from_axisangle(np.pi / 2 / frames_per_gate, [0, 0, 1]),
+        "#9b59b6",
+    )
+    simple_gates["sdg"] = (
+        "sdg",
+        _Quaternion.from_axisangle(-np.pi / 2 / frames_per_gate, [0, 0, 1]),
+        "#8e44ad",
+    )
+    simple_gates["h"] = (
+        "h",
+        _Quaternion.from_axisangle(np.pi / frames_per_gate, _normalize([1, 0, 1])),
+        "#34495e",
+    )
+    simple_gates["t"] = (
+        "t",
+        _Quaternion.from_axisangle(np.pi / 4 / frames_per_gate, [0, 0, 1]),
+        "#e74c3c",
+    )
+    simple_gates["tdg"] = (
+        "tdg",
+        _Quaternion.from_axisangle(-np.pi / 4 / frames_per_gate, [0, 0, 1]),
+        "#c0392b",
+    )
+
+    list_of_circuit_gates = []
+
+    for gate, _, _ in circuit._data:
+        if gate.name == "barrier":
+            continue
+        if gate.name in simple_gates:
+            list_of_circuit_gates.append(simple_gates[gate.name])
+        elif gate.name == "rx":
+            theta = gate.params[0]
+            quaternion = _Quaternion.from_axisangle(theta / frames_per_gate, [1, 0, 0])
+            list_of_circuit_gates.append((f"{gate.name}: {theta:.2f}", quaternion, "#16a085"))
+        elif gate.name == "ry":
+            theta = gate.params[0]
+            quaternion = _Quaternion.from_axisangle(theta / frames_per_gate, [0, 1, 0])
+            list_of_circuit_gates.append((f"{gate.name}: {theta:.2f}", quaternion, "#27ae60"))
+        elif gate.name == "rz":
+            theta = gate.params[0]
+            quaternion = _Quaternion.from_axisangle(theta / frames_per_gate, [0, 0, 1])
+            list_of_circuit_gates.append((f"{gate.name}: {theta:.2f}", quaternion, "#2980b9"))
+        elif gate.name == "u1":
+            theta = gate.params[0]
+            quaternion = _Quaternion.from_axisangle(theta / frames_per_gate, [0, 0, 1])
+            list_of_circuit_gates.append((f"{gate.name}: {theta:.2f}", quaternion, "#f1c40f"))
+        else:
+            raise VisualizationError(f"Gate {gate.name} is not supported")
+
+    if len(list_of_circuit_gates) == 0:
+        raise VisualizationError("Nothing to visualize.")
+
+    starting_pos = _normalize(np.array([0, 0, 1]))
+
+    fig = plt.figure(figsize=(5, 5))
+    if tuple(int(x) for x in matplotlib.__version__.split(".")) >= (3, 4, 0):
+        _ax = Axes3D(fig, auto_add_to_figure=False)
+        fig.add_axes(_ax)
+    else:
+        _ax = Axes3D(fig)
+
+    _ax.set_xlim(-10, 10)
+    _ax.set_ylim(-10, 10)
+    sphere = Bloch(axes=_ax)
+
+    class Namespace:
+        """Helper class serving as scope container"""
+
+        def __init__(self):
+            self.new_vec = []
+            self.last_gate = -2
+            self.colors = []
+            self.pnts = []
+
+    namespace = Namespace()
+    namespace.new_vec = starting_pos
+
+    def animate(i):
+        sphere.clear()
+
+        # starting gate count from -1 which is the initial vector
+        gate_counter = (i - 1) // frames_per_gate
+        if gate_counter != namespace.last_gate:
+            namespace.pnts.append([[], [], []])
+            namespace.colors.append(list_of_circuit_gates[gate_counter][2])
+
+        # starts with default vector [0,0,1]
+        if i == 0:
+            sphere.add_vectors(namespace.new_vec)
+            namespace.pnts[0][0].append(namespace.new_vec[0])
+            namespace.pnts[0][1].append(namespace.new_vec[1])
+            namespace.pnts[0][2].append(namespace.new_vec[2])
+            namespace.colors[0] = "r"
+            sphere.make_sphere()
+            return _ax
+
+        namespace.new_vec = list_of_circuit_gates[gate_counter][1] * namespace.new_vec
+
+        namespace.pnts[gate_counter + 1][0].append(namespace.new_vec[0])
+        namespace.pnts[gate_counter + 1][1].append(namespace.new_vec[1])
+        namespace.pnts[gate_counter + 1][2].append(namespace.new_vec[2])
+
+        sphere.add_vectors(namespace.new_vec)
+        if trace:
+            # sphere.add_vectors(namespace.points)
+            for point_set in namespace.pnts:
+                sphere.add_points([point_set[0], point_set[1], point_set[2]])
+
+        sphere.vector_color = [list_of_circuit_gates[gate_counter][2]]
+        sphere.point_color = namespace.colors
+        sphere.point_marker = "o"
+
+        annotation_text = list_of_circuit_gates[gate_counter][0]
+        annotationvector = [1.40, -0.45, 1.65]
+        sphere.add_annotation(
+            annotationvector,
+            annotation_text,
+            color=list_of_circuit_gates[gate_counter][2],
+            fontsize=30,
+            horizontalalignment="left",
+        )
+
+        sphere.make_sphere()
+
+        namespace.last_gate = gate_counter
+        return _ax
+
+    def init():
+        sphere.vector_color = ["r"]
+        return _ax
+
+    ani = animation.FuncAnimation(
+        fig,
+        animate,
+        range(frames_per_gate * len(list_of_circuit_gates) + 1),
+        init_func=init,
+        blit=False,
+        repeat=False,
+        interval=time_between_frames,
+    )
+
+    if saveas:
+        ani.save(saveas, fps=30)
+    if jupyter:
+        # This is necessary to overcome matplotlib memory limit
+        matplotlib.rcParams["animation.embed_limit"] = 50
+        plt.close(fig)
+        return HTML(ani.to_jshtml())
+    plt.show()
+    plt.close(fig)
+    return None

qiskit/visualization/utils.py

@@ -0,0 +1,49 @@
+# 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.
+
+"""Common visualization utilities."""
+
+from qiskit.utils import optionals as _optionals
+
+
+@_optionals.HAS_PIL.require_in_call("the latex circuit drawer")
+def _trim(image):
+    """Trim a PIL image and remove white space."""
+    import PIL
+
+    background = PIL.Image.new(image.mode, image.size, image.getpixel((0, 0)))
+    diff = PIL.ImageChops.difference(image, background)
+    diff = PIL.ImageChops.add(diff, diff, 2.0, -100)
+    bbox = diff.getbbox()
+    if bbox:
+        image = image.crop(bbox)
+    return image
+
+
+MATPLOTLIB_INLINE_BACKENDS = {
+    "module://ipykernel.pylab.backend_inline",
+    "module://matplotlib_inline.backend_inline",
+    "nbAgg",
+}
+
+
+def matplotlib_close_if_inline(figure):
+    """Close the given matplotlib figure if the backend in use draws figures inline.
+
+    If the backend does not draw figures inline, this does nothing.  This function is to prevent
+    duplicate images appearing; the inline backends will capture the figure in preparation and
+    display it as well, whereas the drawers want to return the figure to be displayed."""
+    # This can only called if figure has already been created, so matplotlib must exist.
+    import matplotlib.pyplot
+
+    if matplotlib.get_backend() in MATPLOTLIB_INLINE_BACKENDS:
+        matplotlib.pyplot.close(figure)

qiskit-1.3.0.dist-info/LICENSE.txt

@@ -0,0 +1,203 @@
+                    Copyright 2017 IBM and its contributors
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 IBM and its contributors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.