fixes #9355 deprecate visualize_transition (#12287) (#12822)

* added deprecation warnings and decorators to transition_visualization.py * fixed style with tox -epy310 -eblack * added release notes * added to warning category=DeprecationWarning and stacklevel=2 * Update releasenotes/notes/deprecate-visualize_transition-8c1d257b7f37aa58.yaml Co-authored-by: atharva-satpute <[email protected]> * Update releasenotes/notes/deprecate-visualize_transition-8c1d257b7f37aa58.yaml Co-authored-by: atharva-satpute <[email protected]> * Apply suggestions from code review * Fix lint complaint --------- Co-authored-by: atharva-satpute <[email protected]> Co-authored-by: Matthew Treinish <[email protected]> Co-authored-by: Elena Peña Tapia <[email protected]> (cherry picked from commit 4ec51d1) Co-authored-by: YingHongTham <[email protected]>
Qiskit · Jul 26, 2024 · c0bd6fd · c0bd6fd
1 parent 706dfaa
commit c0bd6fd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/qiskit/visualization/transition_visualization.py b/qiskit/visualization/transition_visualization.py
@@ -18,6 +18,7 @@
 import numpy as np
 
 from qiskit.exceptions import MissingOptionalLibraryError
+from qiskit.utils.deprecation import deprecate_func
 
 
 def _normalize(v, tolerance=0.00001):
@@ -121,6 +122,10 @@ def vector_norm(self):
         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

diff --git a/releasenotes/notes/deprecate-visualize_transition-8c1d257b7f37aa58.yaml b/releasenotes/notes/deprecate-visualize_transition-8c1d257b7f37aa58.yaml
@@ -0,0 +1,7 @@
+---
+deprecations_visualization:
+  - |
+    The :func:`.transition_visualization` function has been deprecated and will
+    be removed in the 2.0.0 release. This function had a number of limitations
+    which limited it's utility to only very specific use cases and didn't fit in with
+    the rest of the Qiskit visualization module.