Add dynamical decoupling pass

docs/apidocs/ibm-provider.rst

@@ -10,3 +10,4 @@ qiskit-ibm-provider API Reference
    ibm_visualization
    ibm_jupyter
    ibm_utils
+   ibm_transpiler

docs/apidocs/ibm_transpiler.rst

@@ -0,0 +1,6 @@
+.. _qiskit_ibm_provider-utils:
+
+.. automodule:: qiskit_ibm_provider.transpiler
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:

qiskit_ibm_provider/transpiler/__init__.py

@@ -0,0 +1,31 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""
+====================================================================
+IBM Backend Transpiler Tools (:mod:`qiskit_ibm_provider.transpiler`)
+====================================================================
+
+A collection of transpiler tools for working with IBM Quantum's
+next-generation backends that support advanced "dynamic circuit"
+capabilities. Ie., circuits with support for classical
+compute and control-flow/feedback based off of measurement results.
+
+Transpiler Passes
+==================
+
+.. autosummary::
+    :toctree: ../stubs/
+
+    passes
+
+"""

qiskit_ibm_provider/transpiler/passes/__init__.py

@@ -0,0 +1,33 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""
+================================================================
+Transpiler Passes (:mod:`qiskit_ibm_provider.transpiler.passes`)
+================================================================
+
+.. currentmodule:: qiskit_ibm_provider.transpiler.passes
+
+A collection of transpiler passes for IBM backends.
+
+.. autosummary::
+   :toctree: ../stubs/
+
+   scheduling
+
+
+"""
+
+# circuit scheduling
+from .scheduling import DynamicCircuitScheduleAnalysis
+from .scheduling import PadDynamicalDecoupling
+from .scheduling import PadDelay

qiskit_ibm_provider/transpiler/passes/scheduling/__init__.py

@@ -0,0 +1,110 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 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.
+
+"""
+====================================================================
+Scheduling (:mod:`qiskit_ibm_provider.transpiler.passes.scheduling`)
+====================================================================
+
+.. currentmodule:: qiskit_ibm_provider.transpiler.passes.scheduling
+
+A collection of scheduling passes for working with IBM Quantum's next-generation
+backends that support advanced "dynamic circuit" capabilities. Ie.,
+circuits with support for classical control-flow/feedback based off
+of measurement results.
+
+
+Below we demonstrate how to schedule and pad a teleportation circuit with delays
+for a dynamic circuit backend's execution model:
+
+.. jupyter-execute::
+
+    from qiskit import transpile
+    from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister
+    from qiskit.transpiler.instruction_durations import InstructionDurations
+    from qiskit.transpiler.passmanager import PassManager
+
+    from qiskit_ibm_provider.transpiler.passes.scheduling import DynamicCircuitScheduleAnalysis, PadDelay
+    from qiskit.providers.fake_provider.backends.jakarta.fake_jakarta import FakeJakarta
+
+
+    backend = FakeJakarta()
+
+    durations = InstructionDurations.from_backend(backend)
+    pm = PassManager([DynamicCircuitScheduleAnalysis(durations), PadDelay()])
+
+    qr = QuantumRegister(3)
+    crz = ClassicalRegister(1, name="crz")
+    crx = ClassicalRegister(1, name="crx")
+    result = ClassicalRegister(1, name="result")
+
+    teleport = QuantumCircuit(qr, crz, crx, result, name="Teleport")
+
+    teleport.h(qr[1])
+    teleport.cx(qr[1], qr[2])
+    teleport.cx(qr[0], qr[1])
+    teleport.h(qr[0])
+    teleport.measure(qr[0], crz)
+    teleport.measure(qr[1], crx)
+    teleport.z(qr[2]).c_if(crz, 1)
+    teleport.x(qr[2]).c_if(crx, 1)
+    teleport.measure(qr[2], result)
+
+    teleport = transpile(teleport, backend)
+
+    scheduled_teleport = pm.run(teleport)
+
+    scheduled_teleport.draw(output="mpl")
+
+
+Instead of padding with delays we may also insert a dynamical decoupling sequence
+using the :class:`PadDynamicalDecoupling` pass as shown below:
+
+.. jupyter-execute::
+
+    from qiskit.circuit.library import XGate
+
+    from qiskit_ibm_provider.transpiler.passes.scheduling import PadDynamicalDecoupling
+
+
+    dd_sequence = [XGate(), XGate()]
+
+    pm = PassManager(
+        [
+            DynamicCircuitScheduleAnalysis(durations),
+            PadDynamicalDecoupling(durations, dd_sequence),
+        ]
+    )
+
+    dd_teleport = pm.run(teleport)
+
+    dd_teleport.draw(output="mpl")
+
+
+Scheduling & Dynamical Decoupling
+=================================
+.. autosummary::
+   :toctree: ../stubs/
+
+    BlockBasePadder
+    DynamicCircuitScheduleAnalysis
+    PadDelay
+    PadDynamicalDecoupling
+
+
+
+"""
+
+from .block_base_padder import BlockBasePadder
+from .dynamical_decoupling import PadDynamicalDecoupling
+from .pad_delay import PadDelay
+from .scheduler import DynamicCircuitScheduleAnalysis