From c81ca796e547f3f821b487738df3486374cebe0e Mon Sep 17 00:00:00 2001 From: DanPuzzuoli Date: Fri, 15 Mar 2024 07:42:00 -0700 Subject: [PATCH] adding link in deprecation text --- qiskit_dynamics/array/__init__.py | 9 +++++---- qiskit_dynamics/arraylias/__init__.py | 9 --------- qiskit_dynamics/dispatch/__init__.py | 14 ++++++++++++-- ...ispatch-array-deprecation-fb945946caba447a.yaml | 9 +++++---- 4 files changed, 22 insertions(+), 19 deletions(-) diff --git a/qiskit_dynamics/array/__init__.py b/qiskit_dynamics/array/__init__.py index 4dbb8f76a..ddab9a769 100644 --- a/qiskit_dynamics/array/__init__.py +++ b/qiskit_dynamics/array/__init__.py @@ -24,10 +24,11 @@ The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version 0.5.0. The use of the ``Array`` class is no longer required to work with different array - libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on - using different array libraries with Qiskit Dynamics. Users can now work directly with the - supported array type of their choice, without the need to wrap them to enable dispatching. The - ``array`` and ``dispatch`` submodules will be removed in version 0.6.0. + libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry + on using different array libraries with Qiskit Dynamics `. + Users can now work directly with the supported array type of their choice, without the need to + wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in + version 0.6.0. This module contains an :class:`Array` class that wraps N-dimensional array objects from different libraries. It enables working with different array libraries through a common NumPy-based interface, diff --git a/qiskit_dynamics/arraylias/__init__.py b/qiskit_dynamics/arraylias/__init__.py index 745f29521..3aedfe27c 100644 --- a/qiskit_dynamics/arraylias/__init__.py +++ b/qiskit_dynamics/arraylias/__init__.py @@ -19,15 +19,6 @@ .. currentmodule:: qiskit_dynamics.arraylias -.. warning:: - - The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version - 0.5.0. The use of the ``Array`` class is no longer required to work with different array - libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on - using different array libraries with Qiskit Dynamics. Users can now work directly with the - supported array type of their choice, without the need to wrap them to enable dispatching. The - ``array`` and ``dispatch`` submodules will be removed in version 0.6.0. - This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases provided by `Arraylias `_. These are used to manage dispatching of array operations for the different array types supported by Qiskit Dynamics. They diff --git a/qiskit_dynamics/dispatch/__init__.py b/qiskit_dynamics/dispatch/__init__.py index 3a7a9e0ee..ab3a8e755 100644 --- a/qiskit_dynamics/dispatch/__init__.py +++ b/qiskit_dynamics/dispatch/__init__.py @@ -19,8 +19,18 @@ .. currentmodule:: qiskit_dynamics.dispatch -This module contains dispatch methods used by the -:class:`~qiskit_dynamics.array.Array` class. +.. warning:: + + The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version + 0.5.0. The use of the ``Array`` class is no longer required to work with different array + libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry + on using different array libraries with Qiskit Dynamics `. + Users can now work directly with the supported array type of their choice, without the need to + wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in + version 0.6.0. + + +This module contains dispatch methods used by the :class:`~qiskit_dynamics.array.Array` class. Dispatch Functions diff --git a/releasenotes/notes/dispatch-array-deprecation-fb945946caba447a.yaml b/releasenotes/notes/dispatch-array-deprecation-fb945946caba447a.yaml index ba2e89ad0..0fbe684cc 100644 --- a/releasenotes/notes/dispatch-array-deprecation-fb945946caba447a.yaml +++ b/releasenotes/notes/dispatch-array-deprecation-fb945946caba447a.yaml @@ -3,7 +3,8 @@ upgrade: - | The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version 0.5.0. The use of the ``Array`` class is no longer required to work with different array - libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on - using different array libraries with Qiskit Dynamics. Users can now work directly with the - supported array type of their choice, without the need to wrap them to enable dispatching. The - ``array`` and ``dispatch`` submodules will be removed in version 0.6.0. \ No newline at end of file + libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry + on using different array libraries with Qiskit Dynamics `. + Users can now work directly with the supported array type of their choice, without the need to + wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in + version 0.6.0. \ No newline at end of file