0.0.0 release

.github/workflows/python-publish-pypi.yaml → .github/workflows/python-publish-pypi.yml

@@ -14,7 +14,10 @@ on:
 jobs:
   build:
     name: Build distribution 📦
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+        matrix:
+            os: [ubuntu-latest, windows-latest, macos-latest]
     permissions:
       attestations: write
       id-token: write
@@ -32,7 +35,10 @@ jobs:
     name: Publish Python 🐍 distribution 📦 to PyPI
     needs: build
     if: ${{ github.event.action == 'published' }}
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+        matrix:
+            os: [ubuntu-latest, windows-latest, macos-latest]
     environment:
       name: pypi
       url: https://pypi.org/project/quick-core/${{ github.ref_name }}

.github/workflows/tests.yml

@@ -9,8 +9,9 @@ jobs:
     test:
         runs-on: ${{ matrix.os }}
         strategy:
+            fail-fast: false
             matrix:
-                os: [ubuntu-latest]
+                os: [ubuntu-latest, windows-latest, macos-latest]
                 python-version: ["3.10", "3.11", "3.12"]
 
         steps:

pyproject.toml

@@ -8,17 +8,17 @@ version = "0.0.0"
 dependencies = [
     "cirq-core == 1.4.1",
     "genQC == 0.1.0",
-    "numpy >= 1.23,< 3.0",
-    "pennylane == 0.39.0",
-    "pytket == 1.37.0",
-    "pytket-qiskit == 0.62.0",
-    "pytket-cirq == 0.39.0",
-    "qiskit == 1.3.1",
-    "qiskit_aer == 0.16.0",
-    "qiskit_ibm_runtime == 0.34.0",
-    "qiskit-transpiler-service == 0.4.14",
+    "numpy >= 1.23",
+    "pennylane == 0.42.3",
+    "pytket == 2.4.1",
+    "pytket-qiskit == 0.68.0",
+    "pytket-cirq == 0.40.0",
+    "qiskit == 2.0.1",
+    "qiskit_aer == 0.17.0",
+    "qiskit_ibm_runtime == 0.39.0",
+    "qiskit-ibm-transpiler == 0.11.0",
     "quimb == 1.10.0",
-    "tket2 == 0.6.0"
+    "tket2 == 0.10.0"
 ]
 requires-python = ">=3.10, <3.13"
 authors = [
@@ -60,6 +60,10 @@ include = ["quick*"]
 [tool.setuptools.package-data]
 "quick" = ["py.typed"]
 
+[tools.pyright]
+include = ["quick", "tests"]
+typeCheckingMode = "strict"
+
 [tool.codeflash]
 # All paths are relative to this pyproject.toml's directory.
 module-root = "quick"

quick/backend/backend.py

@@ -28,7 +28,6 @@
 import numpy as np
 from numpy.typing import NDArray
 from types import NotImplementedType
-from typing import Type
 
 from quick.circuit import Circuit
 
@@ -59,14 +58,14 @@ class Backend(ABC):
     """
     def __init__(
             self,
-            device: str="CPU"
+            device: str = "CPU"
         ) -> None:
         """ Initialize a `quick.backend.Backend` instance.
         """
         if device not in ["CPU", "GPU"]:
             raise ValueError(f"Invalid device: {device}. Must be either 'CPU' or 'GPU'.")
         self.device = device
-        self._qc_framework: Type[Circuit]
+        self._qc_framework: type[Circuit]
 
     @staticmethod
     def backendmethod(method):
@@ -177,7 +176,7 @@ def get_operator(
     def get_counts(
             self,
             circuit: Circuit,
-            num_shots: int=1024
+            num_shots: int = 1024
         ) -> dict[str, int]:
         """ Get the counts of the backend.
 
@@ -316,7 +315,7 @@ class NoisyBackend(Backend, ABC):
     `device` : str
         The device to use for simulating the circuit.
         This can be either "CPU", or "GPU".
-    `_qc_framework` : Type[quick.circuit.Circuit]
+    `_qc_framework` : type[quick.circuit.Circuit]
         The quantum computing framework to use.
     `noisy` : bool
         Whether the simulation is noisy or not.
@@ -332,7 +331,7 @@ def __init__(
             self,
             single_qubit_error: float,
             two_qubit_error: float,
-            device: str="CPU"
+            device: str = "CPU"
         ) -> None:
         """ Initialize a `quick.backend.NoisyBackend` instance.
         """
@@ -348,7 +347,7 @@ def __init__(
 
         self.noisy = self.single_qubit_error > 0.0 or self.two_qubit_error > 0.0
 
-        self._qc_framework: Type[Circuit]
+        self._qc_framework: type[Circuit]
 
 
 class FakeBackend(Backend, ABC):
@@ -367,7 +366,7 @@ class FakeBackend(Backend, ABC):
     `device` : str
         The device to use for simulating the circuit.
         This can be either "CPU", or "GPU".
-    `_qc_framework` : Type[quick.circuit.Circuit]
+    `_qc_framework` : type[quick.circuit.Circuit]
         The quantum computing framework to use.
     `_backend_name` : str
         The name of the backend to use (usually the name of the backend being emulated).
@@ -381,12 +380,12 @@ class FakeBackend(Backend, ABC):
     """
     def __init__(
             self,
-            device: str="CPU"
+            device: str = "CPU"
         ) -> None:
         """ Initialize a `quick.backend.FakeBackend` instance.
         """
         super().__init__(device=device)
-        self._qc_framework: Type[Circuit]
+        self._qc_framework: type[Circuit]
         self._backend_name: str
         self._max_num_qubits: int
 
@@ -452,7 +451,7 @@ def get_operator(
     def get_counts(
             self,
             circuit: Circuit,
-            num_shots: int=1024
+            num_shots: int = 1024
         ) -> dict[str, int]:
         """ Get the counts of the backend.
 

quick/backend/qiskit_backends/aer_backend.py

@@ -87,9 +87,9 @@ class AerBackend(NoisyBackend):
     """
     def __init__(
             self,
-            single_qubit_error: float=0.0,
-            two_qubit_error: float=0.0,
-            device: str="CPU"
+            single_qubit_error: float = 0.0,
+            two_qubit_error: float = 0.0,
+            device: str = "CPU"
         ) -> None:
 
         super().__init__(
@@ -189,7 +189,7 @@ def get_operator(
     def get_counts(
             self,
             circuit: Circuit,
-            num_shots: int=1024
+            num_shots: int = 1024
         ) -> dict[str, int]:
 
         if len(circuit.measured_qubits) == 0:

quick/backend/qiskit_backends/fake_ibm_backend.py

@@ -21,6 +21,7 @@
 
 import numpy as np
 from numpy.typing import NDArray
+import warnings
 
 from qiskit.primitives import BackendSamplerV2 as BackendSampler # type: ignore
 from qiskit_aer import AerSimulator # type: ignore
@@ -89,7 +90,7 @@ def __init__(
             self,
             hardware_name: str,
             qiskit_runtime: QiskitRuntimeService,
-            device: str="CPU"
+            device: str = "CPU"
         ) -> None:
 
         super().__init__(device=device)
@@ -113,7 +114,7 @@ def __init__(
             self._op_backend = AerSimulator.from_backend(backend, device="GPU", method="unitary")
         else:
             if self.device == "GPU" and available_devices["GPU"] is None:
-                print("Warning: GPU acceleration is not available. Defaulted to CPU.")
+                warnings.warn("Warning: GPU acceleration is not available. Defaulted to CPU.")
             self._counts_backend = BackendSampler(backend=AerSimulator.from_backend(backend))
             self._op_backend = AerSimulator.from_backend(backend, method="unitary")
 
@@ -161,7 +162,7 @@ def get_operator(
     def get_counts(
             self,
             circuit: Circuit,
-            num_shots: int=1024
+            num_shots: int = 1024
         ) -> dict[str, int]:
 
         result = self._counts_backend.run([circuit.circuit], shots=num_shots).result()

quick/circuit/__init__.py

@@ -16,6 +16,7 @@
     "dag",
     "gate_matrix",
     "from_framework",
+    "Ansatz",
     "Circuit",
     "CirqCircuit",
     "PennylaneCircuit",
@@ -32,5 +33,6 @@
 from quick.circuit.pennylanecircuit import PennylaneCircuit
 from quick.circuit.quimbcircuit import QuimbCircuit
 from quick.circuit.tketcircuit import TKETCircuit
+from quick.circuit.ansatz import Ansatz
 import quick.circuit.from_framework as from_framework
 import quick.circuit.dag as dag