qoro-divi 0.3.4__tar.gz → 0.4.0__tar.gz

{qoro_divi-0.3.4 → qoro_divi-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qoro-divi
-Version: 0.3.4
+Version: 0.4.0
 Summary: A Python library to automate generating, parallelizing, and executing quantum programs.
 Author: Ahmed Darwish
 Author-email: ahmed@qoroquantum.de
@@ -17,6 +17,7 @@ Requires-Dist: networkx (>=3.5,<4.0)
 Requires-Dist: pennylane (>=0.42.3,<0.43.0)
 Requires-Dist: ply (>=3.11,<4.0)
 Requires-Dist: pymetis (>=2025.1.1,<2026.0.0)
+Requires-Dist: pymoo (>=0.6.1.5,<0.7.0.0)
 Requires-Dist: python-dotenv (>=1.1.1,<2.0.0)
 Requires-Dist: qiskit (<2.0)
 Requires-Dist: qiskit-aer (>=0.17.1,<0.18.0)
@@ -62,3 +63,17 @@ pip install qoro-divi
 - Full documentation is available at: <https://docs.qoroquantum.net/divi>
 - Tutorials can be found in the `tutorials` folder.
 
+## 🧪 Testing
+
+To run the test suite:
+
+```bash
+# Run all tests
+pytest
+
+# Run only API tests (requires API token)
+pytest --run-api-tests
+```
+
+**Note:** Some tests require a Qoro API token to test the cloud REST API. Set the `QORO_API_KEY` environment variable or use the `--api-token` option. For local development, you can create a `.env`.
+

{qoro_divi-0.3.4 → qoro_divi-0.4.0}/README.md

@@ -30,3 +30,17 @@ pip install qoro-divi
 
 - Full documentation is available at: <https://docs.qoroquantum.net/divi>
 - Tutorials can be found in the `tutorials` folder.
+
+## 🧪 Testing
+
+To run the test suite:
+
+```bash
+# Run all tests
+pytest
+
+# Run only API tests (requires API token)
+pytest --run-api-tests
+```
+
+**Note:** Some tests require a Qoro API token to test the cloud REST API. Set the `QORO_API_KEY` environment variable or use the `--api-token` option. For local development, you can create a `.env`.

{qoro_divi-0.3.4 → qoro_divi-0.4.0}/divi/backends/__init__.py

@@ -4,4 +4,4 @@
 
 from ._circuit_runner import CircuitRunner
 from ._parallel_simulator import ParallelSimulator
-from ._qoro_service import JobStatus, JobType, QoroService
+from ._qoro_service import JobConfig, JobStatus, JobType, QoroService

qoro_divi-0.4.0/divi/backends/_circuit_runner.py

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2025 Qoro Quantum Ltd <divi@qoroquantum.de>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from abc import ABC, abstractmethod
+
+
+class CircuitRunner(ABC):
+    """
+    A generic interface for anything that can "run" quantum circuits.
+    """
+
+    def __init__(self, shots: int):
+        if shots <= 0:
+            raise ValueError(f"Shots must be a positive integer. Got {shots}.")
+
+        self._shots = shots
+
+    @property
+    def shots(self):
+        """
+        Get the number of measurement shots for circuit execution.
+
+        Returns:
+            int: Number of shots configured for this runner.
+        """
+        return self._shots
+
+    @property
+    @abstractmethod
+    def supports_expval(self) -> bool:
+        """
+        Whether the backend supports expectation value measurements.
+        """
+        return False
+
+    @property
+    @abstractmethod
+    def is_async(self) -> bool:
+        """
+        Whether the backend executes circuits asynchronously.
+
+        Returns:
+            bool: True if the backend returns a job ID and requires polling
+                  for results (e.g., QoroService). False if the backend
+                  returns results immediately (e.g., ParallelSimulator).
+        """
+        return False
+
+    @abstractmethod
+    def submit_circuits(self, circuits: dict[str, str], **kwargs):
+        """
+        Submit quantum circuits for execution.
+
+        This abstract method must be implemented by subclasses to define how
+        circuits are executed on their respective backends (simulator, hardware, etc.).
+
+        Args:
+            circuits (dict[str, str]): Dictionary mapping circuit labels to their
+                OpenQASM string representations.
+            **kwargs: Additional backend-specific parameters for circuit execution.
+
+        Returns:
+            The return type depends on the backend implementation. Typically returns
+            measurement results or a job identifier.
+        """
+        pass

{qoro_divi-0.3.4 → qoro_divi-0.4.0}/divi/backends/_parallel_simulator.py

@@ -66,12 +66,15 @@ class ParallelSimulator(CircuitRunner):
         simulation_seed: int | None = None,
         qiskit_backend: Backend | Literal["auto"] | None = None,
         noise_model: NoiseModel | None = None,
+        _deterministic_execution: bool = False,
     ):
         """
-        A multi-process wrapper around Qiskit's AerSimulator.
+        A parallel wrapper around Qiskit's AerSimulator using Qiskit's built-in parallelism.
 
         Args:
-            n_processes (int, optional): Number of parallel processes to use for simulation. Defaults to 2.
+            n_processes (int, optional): Number of parallel processes to use for transpilation and
+                simulation. Defaults to 2. This sets both the transpile num_processes and
+                AerSimulator's max_parallel_experiments.
             shots (int, optional): Number of shots to perform. Defaults to 5000.
             simulation_seed (int, optional): Seed for the random number generator to ensure reproducibility. Defaults to None.
             qiskit_backend (Backend | Literal["auto"] | None, optional): A Qiskit backend to initiate the simulator from.
@@ -92,62 +95,152 @@ class ParallelSimulator(CircuitRunner):
         self.simulation_seed = simulation_seed
         self.qiskit_backend = qiskit_backend
         self.noise_model = noise_model
+        self._deterministic_execution = _deterministic_execution
 
-    @staticmethod
-    def simulate_circuit(
-        circuit_data: tuple[str, str],
-        shots: int,
-        simulation_seed: int | None = None,
-        qiskit_backend: Backend | None = None,
-        noise_model: NoiseModel | None = None,
-    ):
-        circuit_label, circuit = circuit_data
+    def set_seed(self, seed: int):
+        """
+        Set the random seed for circuit simulation.
 
-        qiskit_circuit = QuantumCircuit.from_qasm_str(circuit)
+        Args:
+            seed (int): Seed value for the random number generator used in simulation.
+        """
+        self.simulation_seed = seed
 
-        resolved_backend = (
-            _find_best_fake_backend(qiskit_circuit)[-1]()
-            if qiskit_backend == "auto"
-            else qiskit_backend
-        )
+    @property
+    def supports_expval(self) -> bool:
+        """
+        Whether the backend supports expectation value measurements.
+        """
+        return False
 
-        aer_simulator = (
-            AerSimulator.from_backend(resolved_backend)
-            if qiskit_backend
-            else AerSimulator(noise_model=noise_model)
-        )
-        transpiled_circuit = transpile(qiskit_circuit, aer_simulator)
+    @property
+    def is_async(self) -> bool:
+        """
+        Whether the backend executes circuits asynchronously.
+        """
+        return False
 
-        aer_simulator.set_option("seed_simulator", simulation_seed)
-        job = aer_simulator.run(transpiled_circuit, shots=shots)
+    def _execute_circuits_deterministically(
+        self, circuit_labels: list[str], transpiled_circuits: list, resolved_backend
+    ) -> list[dict]:
+        """
+        Execute circuits individually for debugging purposes.
 
-        result = job.result()
-        counts = result.get_counts(0)
+        This method ensures deterministic results by running each circuit with its own
+        simulator instance and the same seed. Used internally for debugging non-deterministic
+        behavior in batch execution.
 
-        return {"label": circuit_label, "results": dict(counts)}
+        Args:
+            circuit_labels: List of circuit labels
+            transpiled_circuits: List of transpiled QuantumCircuit objects
+            resolved_backend: Resolved backend for simulator creation
 
-    def set_seed(self, seed: int):
-        self.simulation_seed = seed
+        Returns:
+            List of result dictionaries
+        """
+        results = []
+        for i, (label, transpiled_circuit) in enumerate(
+            zip(circuit_labels, transpiled_circuits)
+        ):
+            # Create a new simulator instance for each circuit with the same seed
+            if resolved_backend is not None:
+                circuit_simulator = AerSimulator.from_backend(resolved_backend)
+            else:
+                circuit_simulator = AerSimulator(noise_model=self.noise_model)
+
+            if self.simulation_seed is not None:
+                circuit_simulator.set_option("seed_simulator", self.simulation_seed)
+
+            # Run the single circuit
+            job = circuit_simulator.run(transpiled_circuit, shots=self.shots)
+            circuit_result = job.result()
+            counts = circuit_result.get_counts(0)
+            results.append({"label": label, "results": dict(counts)})
+
+        return results
 
     def submit_circuits(self, circuits: dict[str, str]):
+        """
+        Submit multiple circuits for parallel simulation using Qiskit's built-in parallelism.
+
+        Uses Qiskit's native batch transpilation and execution, which handles parallelism
+        internally.
+
+        Args:
+            circuits (dict[str, str]): Dictionary mapping circuit labels to OpenQASM
+                string representations.
+
+        Returns:
+            list[dict]: List of result dictionaries, each containing:
+                - 'label' (str): Circuit identifier
+                - 'results' (dict): Measurement counts as {bitstring: count}
+        """
         logger.debug(
             f"Simulating {len(circuits)} circuits with {self.n_processes} processes"
         )
 
-        with Pool(processes=self.n_processes) as pool:
-            results = pool.starmap(
-                self.simulate_circuit,
-                [
-                    (
-                        circuit,
-                        self.shots,
-                        self.simulation_seed,
-                        self.qiskit_backend,
-                        self.noise_model,
-                    )
-                    for circuit in circuits.items()
-                ],
+        # Convert QASM strings to QuantumCircuit objects
+        circuit_labels = list(circuits.keys())
+        qiskit_circuits = [
+            QuantumCircuit.from_qasm_str(qasm) for qasm in circuits.values()
+        ]
+
+        # Determine backend for transpilation
+        if self.qiskit_backend == "auto":
+            # For "auto", find the maximum number of qubits across all circuits to determine backend
+            max_qubits_circ = max(qiskit_circuits, key=lambda x: x.num_qubits)
+            resolved_backend = _find_best_fake_backend(max_qubits_circ)[-1]()
+        elif self.qiskit_backend is not None:
+            resolved_backend = self.qiskit_backend
+        else:
+            resolved_backend = None
+
+        # Create simulator
+        if resolved_backend is not None:
+            aer_simulator = AerSimulator.from_backend(resolved_backend)
+        else:
+            aer_simulator = AerSimulator(noise_model=self.noise_model)
+
+        # Set simulator options for parallelism
+        # Note: We don't set seed_simulator here because we need different seeds for each circuit
+        # to ensure deterministic results when running multiple circuits in parallel
+        aer_simulator.set_options(max_parallel_experiments=self.n_processes)
+
+        # Batch transpile all circuits (Qiskit handles parallelism internally)
+        transpiled_circuits = transpile(
+            qiskit_circuits, aer_simulator, num_processes=self.n_processes
+        )
+
+        # Use deterministic execution for debugging if enabled
+        if self._deterministic_execution:
+            return self._execute_circuits_deterministically(
+                circuit_labels, transpiled_circuits, resolved_backend
             )
+
+        # Batch execution with metadata checking for non-deterministic behavior
+        job = aer_simulator.run(transpiled_circuits, shots=self.shots)
+        batch_result = job.result()
+
+        # Check metadata to detect non-deterministic behavior
+        metadata = batch_result.metadata
+        parallel_experiments = metadata.get("parallel_experiments", 1)
+        omp_nested = metadata.get("omp_nested", False)
+
+        # If parallel execution is detected and we have a seed, warn about potential non-determinism
+        if parallel_experiments > 1 and self.simulation_seed is not None:
+            logger.warning(
+                f"Parallel execution detected (parallel_experiments={parallel_experiments}, "
+                f"omp_nested={omp_nested}). Results may not be deterministic across different "
+                "grouping strategies. Consider enabling deterministic mode for "
+                "deterministic results."
+            )
+
+        # Extract results and match with labels
+        results = []
+        for i, label in enumerate(circuit_labels):
+            counts = batch_result.get_counts(i)
+            results.append({"label": label, "results": dict(counts)})
+
         return results
 
     @staticmethod
@@ -187,15 +280,18 @@ class ParallelSimulator(CircuitRunner):
 
             op_name = node.name
 
+            # Determine qubit indices for the operation
             if node.num_clbits == 1:
                 idx = (node.cargs[0]._index,)
-
-            if op_name != "measure" and node.num_qubits > 0:
+            elif op_name != "measure" and node.num_qubits > 0:
                 idx = tuple(qarg._index for qarg in node.qargs)
+            else:
+                # Skip operations without qubits or measurements without classical bits
+                continue
 
             try:
                 total_run_time_s += (
-                    qiskit_backend.instruction_durations.duration_by_name_qubits[
+                    resolved_backend.instruction_durations.duration_by_name_qubits[
                         (op_name, idx)
                     ][0]
                 )
@@ -209,7 +305,7 @@ class ParallelSimulator(CircuitRunner):
     @staticmethod
     def estimate_run_time_batch(
         circuits: list[str] | None = None,
-        precomputed_duration: list[float] | None = None,
+        precomputed_durations: list[float] | None = None,
         n_qpus: int = 5,
         **transpilation_kwargs,
     ) -> float:
@@ -226,7 +322,7 @@ class ParallelSimulator(CircuitRunner):
         """
 
         # Compute the run time estimates for each given circuit, in descending order
-        if precomputed_duration is None:
+        if precomputed_durations is None:
             with Pool() as p:
                 estimated_run_times = p.map(
                     partial(
@@ -238,7 +334,7 @@ class ParallelSimulator(CircuitRunner):
                 )
             estimated_run_times_sorted = sorted(estimated_run_times, reverse=True)
         else:
-            estimated_run_times_sorted = sorted(precomputed_duration, reverse=True)
+            estimated_run_times_sorted = sorted(precomputed_durations, reverse=True)
 
         # Just return the longest run time if there are enough QPUs
         if n_qpus >= len(estimated_run_times_sorted):