Refactoring API structure

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-latest', 'windows-2022', 'macos-latest']
-        python: ['3.8', '3.9', '3.10', '3.11']
+        python: ['3.9', '3.10', '3.11', '3.12']
 
     name: "Python ${{ matrix.python }} / ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 - Updated to support Qiskit 1.0.
+- Modified the APIs for Qiskit simulation and execution on IBMQ hardware.
 
 ### Fixed
 

docs/source/tutorial.rst

@@ -29,7 +29,7 @@ First, let us import relevant modules and define function we will use:
 .. code-block:: python
 
     from graphix import Circuit
-    from graphix_ibmq.runner import IBMQBackend
+    from graphix_ibmq.backend import IBMQBackend
     import qiskit.quantum_info as qi
     from qiskit.visualization import plot_histogram
     import numpy as np

examples/gallery/aer_sim.py

@@ -12,10 +12,9 @@
 import matplotlib.pyplot as plt
 import networkx as nx
 import random
-from graphix import Circuit
-from graphix_ibmq.runner import IBMQBackend
-from qiskit.tools.visualization import plot_histogram
-from qiskit_aer.noise import NoiseModel, depolarizing_error
+from graphix.transpiler import Circuit
+from graphix_ibmq.backend import IBMQBackend
+from qiskit.visualization import plot_histogram
 
 
 def cp(circuit, theta, control, target):
@@ -84,23 +83,28 @@ def swap(circuit, a, b):
 pattern.minimize_space()
 
 # convert to qiskit circuit
-backend = IBMQBackend(pattern)
-print(type(backend.circ))
+backend = IBMQBackend()
+compiled = backend.compile(pattern)
 
 #%%
 # We can now simulate the circuit with Aer.
 
 # run and get counts
-result = backend.simulate()
+backend.set_simulator()
+job = backend.submit_job(compiled, shots=1024)
+result = job.retrieve_result()
 
 #%%
 # We can also simulate the circuit with noise model
 
 # create an empty noise model
+from qiskit_aer.noise import NoiseModel, depolarizing_error
+
+# add depolarizing error to all single qubit gates
 noise_model = NoiseModel()
-# add depolarizing error to all single qubit u1, u2, u3 gates
 error = depolarizing_error(0.01, 1)
-noise_model.add_all_qubit_quantum_error(error, ["u1", "u2", "u3"])
+noise_model.add_all_qubit_quantum_error(error, ["id", "rz", "sx", "x", "u1"])
+backend.set_simulator(noise_model=noise_model)
 
 # print noise model info
 print(noise_model)
@@ -109,7 +113,8 @@ def swap(circuit, a, b):
 # Now we can run the simulation with noise model
 
 # run and get counts
-result_noise = backend.simulate(noise_model=noise_model)
+job = backend.submit_job(compiled, shots=1024)
+result_noise = job.retrieve_result()
 
 
 #%%
@@ -137,31 +142,3 @@ def swap(circuit, a, b):
 legend = ax.legend(fontsize=18)
 legend = ax.legend(loc='upper left')
 # %%
-
-
-#%%
-# Example demonstrating how to run a pattern on an IBM Quantum device. All explanations are provided as comments.
-
-# First, load the IBMQ account using an API token.
-"""
-from qiskit_ibm_runtime import QiskitRuntimeService
-service = QiskitRuntimeService(channel="ibm_quantum", token="your_ibm_token", instance="ibm-q/open/main")
-"""
-
-# Then, select the quantum system on which to run the circuit.
-# If no system is specified, the least busy system will be automatically selected.
-"""
-backend.get_system(service, "ibm_kyoto")
-"""
-
-# Finally, transpile the quantum circuit for the chosen system and execute it.
-"""
-backend.transpile()
-result = backend.run(shots=128)
-"""
-
-# To retrieve the result at a later time, use the code below.
-"""
-result = backend.retrieve_result("your_job_id")
-"""
-# %%

examples/gallery/qiskit_to_graphix.py

@@ -9,7 +9,7 @@
 
 
 # %%
-from qiskit import QuantumCircuit, transpile
+from qiskit import transpile
 from qiskit.circuit.random.utils import random_circuit
 
 qc = random_circuit(5, 2, seed=42)

examples/ibm_device.py

@@ -12,10 +12,9 @@
 import matplotlib.pyplot as plt
 import networkx as nx
 import random
-from graphix import Circuit
-from graphix_ibmq.runner import IBMQBackend
-from qiskit_ibm_provider import IBMProvider
-from qiskit.tools.visualization import plot_histogram
+from graphix.transpiler import Circuit
+from graphix_ibmq.backend import IBMQBackend
+from qiskit.visualization import plot_histogram
 from qiskit.providers.fake_provider import FakeLagos
 
 
@@ -68,7 +67,7 @@ def swap(circuit, a, b):
 swap(circuit, 0, 2)
 
 # transpile and plot the graph
-pattern = circuit.transpile()
+pattern = circuit.transpile().pattern
 nodes, edges = pattern.get_graph()
 g = nx.Graph()
 g.add_nodes_from(nodes)
@@ -84,45 +83,38 @@ def swap(circuit, a, b):
 pattern.minimize_space()
 
 # convert to qiskit circuit
-backend = IBMQBackend(pattern)
-backend.to_qiskit()
-print(type(backend.circ))
+backend = IBMQBackend()
+compiled = backend.compile(pattern)
 
 #%%
 # load the account with API token
-IBMProvider.save_account(token='MY API TOKEN')
+from qiskit_ibm_runtime import QiskitRuntimeService
+QiskitRuntimeService.save_account(channel="ibm_quantum", token="API TOKEN", overwrite=True)
 
 # get the device backend
-instance_name = 'ibm-q/open/main'
-backend_name = "ibm_lagos"
-backend.get_backend(instance=instance_name,resource=backend_name)
-
-#%%
-# Get provider and the backend.
-
-instance_name = "ibm-q/open/main"
-backend_name = "ibm_lagos"
-
-backend.get_backend(instance=instance_name, resource=backend_name)
+backend.select_device()
 
 #%%
 # We can now execute the circuit on the device backend.
 
-result = backend.run()
+job = backend.submit_job(compiled, shots=1024)
 
 #%%
-# Retrieve the job if needed
+# Retrieve the job result
 
-# result = backend.retrieve_result("Job ID")
+if job.is_done:
+    result = job.retrieve_result()
 
 #%%
-# We can simulate the circuit with noise model based on the device we used
+# We can simulate the circuit with device-based noise model.
 
 # get the noise model of the device backend
-backend_noisemodel = FakeLagos()
+from qiskit_ibm_runtime.fake_provider import FakeManilaV2
+backend.set_simulator(based_on=FakeManilaV2())
 
 # execute noisy simulation and get counts
-result_noise = backend.simulate(noise_model=backend_noisemodel)
+job = backend.submit_job(compiled, shots=1024)
+result_noise = job.retrieve_result()
 
 #%%
 # Now let us compare the results with theoretical output

graphix_ibmq/backend.py

@@ -0,0 +1,126 @@
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+from qiskit_aer import AerSimulator
+from qiskit_aer.noise import NoiseModel
+from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
+from qiskit_ibm_runtime import SamplerV2 as Sampler, QiskitRuntimeService
+
+from graphix_ibmq.compile_options import IBMQCompileOptions
+from graphix_ibmq.compiler import IBMQPatternCompiler, IBMQCompiledCircuit
+from graphix_ibmq.job import IBMQJob
+
+if TYPE_CHECKING:
+    from graphix.pattern import Pattern
+    from qiskit.providers.backend import BackendV2, Backend
+
+
+class IBMQBackend:
+    """
+    Manages compilation and execution on IBMQ simulators or hardware.
+
+    This class configures the execution target and provides methods to compile
+    a graphix Pattern and submit it as a job.
+    """
+
+    def __init__(self) -> None:
+        self._options = IBMQCompileOptions()
+        # The target backend, either a simulator or a real hardware device.
+        self._backend: Backend | None = None
+
+    def compile(self, pattern: Pattern, options: IBMQCompileOptions | None = None) -> IBMQCompiledCircuit:
+        """
+        Compiles the given pattern into a Qiskit QuantumCircuit.
+
+        Parameters
+        ----------
+        pattern : Pattern
+            The graphix pattern to compile.
+        options : IBMQCompileOptions, optional
+            Compilation options. If not provided, default options are used.
+
+        Returns
+        -------
+        IBMQCompiledCircuit
+            An object containing the compiled circuit and related metadata.
+        """
+        if options is None:
+            self._options = IBMQCompileOptions()
+        elif not isinstance(options, IBMQCompileOptions):
+            raise TypeError("options must be an instance of IBMQCompileOptions")
+        else:
+            self._options = options
+
+        compiler = IBMQPatternCompiler(pattern)
+        return compiler.compile(save_statevector=self._options.save_statevector)
+
+    def set_simulator(self, noise_model: NoiseModel | None = None, from_backend: BackendV2 | None = None) -> None:
+        """
+        Configures the backend to use a local Aer simulator.
+
+        Parameters
+        ----------
+        noise_model : NoiseModel, optional
+            A custom noise model for the simulation.
+        from_backend : BackendV2, optional
+            A hardware backend to base the noise model on. Ignored if `noise_model` is provided.
+        """
+        if noise_model is None and from_backend is not None:
+            noise_model = NoiseModel.from_backend(from_backend)
+
+        self._backend = AerSimulator(noise_model=noise_model)
+        print("Backend set to local AerSimulator.")
+
+    def set_hardware(self, name: str | None = None, least_busy: bool = False, min_qubits: int = 1) -> None:
+        """
+        Selects a real hardware backend from IBM Quantum.
+
+        Parameters
+        ----------
+        name : str, optional
+            The specific name of the device (e.g., 'ibm_brisbane').
+        least_busy : bool
+            If True, selects the least busy device meeting the criteria.
+        min_qubits : int
+            The minimum number of qubits required.
+        """
+        service = QiskitRuntimeService()
+
+        if name:
+            backend = service.backend(name)
+        else:
+            backend = service.least_busy(min_num_qubits=min_qubits, operational=True)
+
+        self._backend = backend
+        # Note: In a production library, consider using the `logging` module instead of `print`.
+        print(f"Selected hardware backend: {self._backend.name}")
+
+    def submit_job(self, compiled_circuit: IBMQCompiledCircuit, shots: int = 1024) -> IBMQJob:
+        """
+        Submits the compiled circuit to the configured backend for execution.
+
+        Parameters
+        ----------
+        compiled_circuit : IBMQCompiledCircuit
+            The compiled circuit object from the `compile` method.
+        shots : int, optional
+            The number of execution shots. Defaults to 1024.
+
+        Returns
+        -------
+        IBMQJob
+            A job object to monitor execution and retrieve results.
+        """
+        if self._backend is None:
+            raise RuntimeError("Backend not set. Call 'set_simulator()' or 'set_hardware()' before submitting a job.")
+
+        pass_manager = generate_preset_pass_manager(
+            backend=self._backend,
+            optimization_level=self._options.optimization_level,
+        )
+        transpiled_circuit = pass_manager.run(compiled_circuit.circuit)
+
+        sampler = Sampler(mode=self._backend)
+        job = sampler.run([transpiled_circuit], shots=shots)
+
+        return IBMQJob(job, compiled_circuit)

graphix_ibmq/compile_options.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass
+class IBMQCompileOptions:
+    """Compilation options specific to IBMQ backends.
+
+    Attributes
+    ----------
+    optimization_level : int
+        Optimization level for Qiskit transpiler (0 to 3).
+    save_statevector : bool
+        Whether to save the statevector before measurement (for debugging/testing).
+    layout_method : str
+        Qubit layout method used by the transpiler (for future use).
+    """
+
+    optimization_level: int = 3
+    save_statevector: bool = False
+    layout_method: str = "trivial"
+
+    def __repr__(self) -> str:
+        """Return a string representation of the compilation options."""
+        return (
+            f"IBMQCompileOptions(optimization_level={self.optimization_level}, "
+            f"save_statevector={self.save_statevector}, "
+            f"layout_method='{self.layout_method}')"
+        )