Merge remote-tracking branch 'upstream/main'

Author: TeWas

.github/workflows/cd.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   python-packaging:
     name: 🐍 Packaging
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-python-packaging.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-python-packaging.yml@v1.3
 
   deploy:
     if: github.event_name == 'release' && github.event.action == 'published'

.github/workflows/ci.yml

@@ -14,13 +14,13 @@ concurrency:
 jobs:
   change-detection:
     name: 🔍 Change
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-change-detection.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-change-detection.yml@v1.3
 
   cpp-tests:
     name: 🇨‌ Test
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-cpp-tests)
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-cpp-ci.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-cpp-ci.yml@v1.3
     with:
       cmake-args: ""
       cmake-args-ubuntu: -G Ninja
@@ -31,21 +31,21 @@ jobs:
     name: 🇨‌ Lint
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-cpp-linter)
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-cpp-linter.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-cpp-linter.yml@v1.3
 
   python-tests:
     name: 🐍 Test
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-python-tests)
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-python-ci.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-python-ci.yml@v1.3
     with:
       skip-testing-latest-python: true
 
   code-ql:
     name: 📝 CodeQL
     needs: change-detection
     if: fromJSON(needs.change-detection.outputs.run-code-ql)
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-code-ql.yml@v1.2.1
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-code-ql.yml@v1.3
 
   required-checks-pass: # This job does nothing and is only used for branch protection
     name: 🚦 Check

.github/workflows/update-mqt-core.yml

@@ -21,6 +21,6 @@ concurrency:
 jobs:
   update-mqt-core:
     name: ⬆️ Update MQT Core
-    uses: cda-tum/mqt-workflows/.github/workflows/reusable-mqt-core-update.yml@v1.1.5
+    uses: cda-tum/mqt-workflows/.github/workflows/reusable-mqt-core-update.yml@v1.3
     with:
-      update-to-head: ${{ fromJSON(github.event.inputs.update-to-head) || false }}
+      update-to-head: ${{ github.event.inputs.update-to-head || false }}

.pre-commit-config.yaml

@@ -56,7 +56,7 @@ repos:
 
   # Python linting and formatting using ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.6
+    rev: v0.5.7
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
@@ -107,11 +107,10 @@ repos:
           - pytest
 
   # Check for spelling
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.23.6
     hooks:
-      - id: codespell
-        args: ["-L", "wille,linz", "--skip", "*.ipynb"]
+      - id: typos
 
   # Catch common capitalization mistakes
   - repo: local
@@ -128,3 +127,17 @@ repos:
     hooks:
       - id: sp-repo-review
         additional_dependencies: ["repo-review[cli]"]
+
+  # Check JSON schemata
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.29.1
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-readthedocs
+
+  # Check the pyproject.toml file
+  - repo: https://github.com/henryiii/validate-pyproject-schema-store
+    rev: 2024.08.08
+    hooks:
+      - id: validate-pyproject

cmake/ExternalDependencies.cmake

@@ -20,9 +20,9 @@ if(BUILD_MQT_QCEC_BINDINGS)
 endif()
 
 # cmake-format: off
-set(MQT_CORE_VERSION 2.5.1
+set(MQT_CORE_VERSION 2.6.0
     CACHE STRING "MQT Core version")
-set(MQT_CORE_REV "35e06ca3067ca3cf36bda1f0c38edf5bd7456fb6"
+set(MQT_CORE_REV "2a7a92951fb67d0c4e795afbd17449063aa42d20"
     CACHE STRING "MQT Core identifier (tag, branch or commit hash)")
 set(MQT_CORE_REPO_OWNER "cda-tum"
 	CACHE STRING "MQT Core repository owner (change when using a fork)")

docs/source/ParameterizedCircuits.ipynb

@@ -11,7 +11,7 @@
     "\n",
     "Variational quantum algorithms are a family of mixed quantum-classical algorithms that try to achieve a quantum advantage via low-depth circuits. This is achieved by offloading a substantial amount of computational work to a classical processor. The quantum circuits employed by variational quantum algorithms involve *parameterized gates* which depend on some a-priori uninstantiated variable.\n",
     "\n",
-    "Variational quantum algorithms try to optimize the circuit's parameters in each iteration with the classical post-processor while the quantum circuit is used to compute the cost function that is being optimized. Because recompiling the quantum circuit in each of these iterations is a costly procedure, the circuit is usually compiled in *paramterized* form in which the parameters tuned by the classical optimization routine are not bound to specific values.\n",
+    "Variational quantum algorithms try to optimize the circuit's parameters in each iteration with the classical post-processor while the quantum circuit is used to compute the cost function that is being optimized. Because recompiling the quantum circuit in each of these iterations is a costly procedure, the circuit is usually compiled in *parameterized* form in which the parameters tuned by the classical optimization routine are not bound to specific values.\n",
     "\n",
     "As is the case with parameter-free circuits, errors can be made during the compilation process. Therefore, verifying the correctness of compilations of parameterized quantum circuits is an important task for near-term quantum computing.\n",
     "\n",

docs/source/PartialEquivalence.ipynb

@@ -103,7 +103,7 @@
    "id": "10fff8c7-f36c-422e-8deb-796cc7637e45",
    "metadata": {},
    "source": [
-    "Aditionally, consider the following circuit, which only acts on two qubits."
+    "Additionally, consider the following circuit, which only acts on two qubits."
    ]
   },
   {

noxfile.py

@@ -26,7 +26,7 @@
 # and get better caching performance. This only concerns dependencies that are
 # not available via wheels on PyPI (i.e., only as source distributions).
 BUILD_REQUIREMENTS = [
-    "scikit-build-core[pyproject]>=0.8.1",
+    "scikit-build-core[pyproject]>=0.10.1",
     "setuptools_scm>=7",
     "pybind11>=2.13",
     "wheel>=0.40",  # transitive dependency of pytest on Windows

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["scikit-build-core>=0.8.1", "setuptools-scm>=7", "pybind11>=2.13"]
+requires = ["scikit-build-core>=0.10.1", "setuptools-scm>=7", "pybind11>=2.13"]
 build-backend = "scikit_build_core.build"
 
 [project]
@@ -71,23 +71,22 @@ Discussions = "https://github.com/cda-tum/mqt-qcec/discussions"
 
 [tool.scikit-build]
 # Protect the configuration against future changes in scikit-build-core
-minimum-version = "0.8.1"
+minimum-version = "build-system.requires"
 
 # Set the wheel install directory
 wheel.install-dir = "mqt/qcec"
 
-# Set required CMake and Ninja versions
-cmake.version = ">=3.19"
+# Set required Ninja version
 ninja.version = ">=1.10"
 
 # Setuptools-style build caching in a local directory
-build-dir = "build/{wheel_tag}"
+build-dir = "build/{build_type}"
 
 # Explicitly set the package directory
 wheel.packages = ["src/mqt"]
 
 # Only build the Python bindings target
-cmake.targets = ["pyqcec"]
+build.targets = ["pyqcec"]
 
 # Only install the Python package component
 install.components = ["mqt-qcec_Python"]
@@ -257,8 +256,21 @@ isort.required-imports = ["from __future__ import annotations"]
 convention = "google"
 
 
+[tool.typos]
+default.extend-ignore-re = [
+  '"id": ".*",',
+  "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",  # ignore line
+  "(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on" # ignore block
+]
+[tool.typos.default.extend-words]
+wille = "wille"
+anc = "anc"
+aer = "aer"
+
+
 [tool.repo-review]
 ignore = [
+  "PC160", # "Uses codespell" -> switched to https://github.com/crate-ci/typos
   "PC180", # "Uses prettier" -> switched to different prettier-mirror that is not recognized by the check
 ]
 
@@ -281,4 +293,4 @@ environment = { MACOSX_DEPLOYMENT_TARGET = "10.15" }
 [tool.cibuildwheel.windows]
 before-build = "pip install delvewheel>=1.7.3"
 repair-wheel-command = "delvewheel repair -v -w {dest_dir} {wheel} --namespace-pkg mqt"
-environment = { CMAKE_ARGS = "-T ClangCL" }
+environment = { CMAKE_ARGS = "-T ClangCL", SKBUILD_CMAKE_ARGS="--fresh" }

src/checker/EquivalenceChecker.cpp

@@ -10,7 +10,7 @@
 #include <nlohmann/json.hpp>
 
 // this function is mainly placed here in order to have an out-of-line
-// virtual method definition which avoids emitting the classe's vtable in
+// virtual method definition which avoids emitting the classes' vtable in
 // every translation unit.
 void ec::EquivalenceChecker::json(nlohmann::basic_json<>& j) const noexcept {
   j["equivalence"] = toString(equivalence);

src/mqt/qcec/compilation_flow_profiles.py

@@ -265,7 +265,7 @@ def create_gate_profile_data(
                 cost = compute_cost(qc, basis_gates, optimization_level)
 
                 # add the cost to the profile data
-                profile_data[(gate, control)] = cost
+                profile_data[gate, control] = cost
     return profile_data
 
 
@@ -360,7 +360,7 @@ def find_continuation(
         if next_term >= prediction_cutoff:
             break
         sequence.append(next_term)
-        profile_data[(gate, max_control + i + 1)] = next_term
+        profile_data[gate, max_control + i + 1] = next_term
 
 
 gate_collection_for_mode = {

test/python/test_symbolic.py

@@ -138,15 +138,15 @@ def test_non_equivalent_phase_rz_commute(
     assert result.equivalence == qcec.EquivalenceCriterion.not_equivalent
 
 
-def test_equivalent_roation_gate_fuse(
+def test_equivalent_rotation_gate_fuse(
     rotation_gate_fuse_lhs: QuantumCircuit, rotation_gate_fuse_rhs_correct: QuantumCircuit
 ) -> None:
     """Test a rotation gate fusion rule."""
     result = qcec.verify(rotation_gate_fuse_lhs, rotation_gate_fuse_rhs_correct)
     assert result.equivalence == qcec.EquivalenceCriterion.equivalent
 
 
-def test_non_equivalent_roation_gate_fuse(
+def test_non_equivalent_rotation_gate_fuse(
     rotation_gate_fuse_lhs: QuantumCircuit, rotation_gate_fuse_rhs_incorrect: QuantumCircuit
 ) -> None:
     """Test an invalid rotation gate fusion rule."""

test/test_partial_equivalence.cpp

@@ -103,8 +103,8 @@ void addStandardOperationToCircuit(QuantumComputation& circuit,
 }
 
 std::vector<qc::Qubit>
-fiveDiffferentRandomNumbers(const qc::Qubit min, const qc::Qubit max,
-                            std::mt19937_64& randomGenerator) {
+fiveDifferentRandomNumbers(const qc::Qubit min, const qc::Qubit max,
+                           std::mt19937_64& randomGenerator) {
   std::vector<qc::Qubit> numbers;
 
   for (qc::Qubit i = min; i < max; i++) {
@@ -202,7 +202,7 @@ StandardOperation
 makeRandomStandardOperation(const qc::Qubit nrQubits, const qc::Qubit min,
                             std::mt19937_64& randomGenerator) {
   const auto randomNumbers =
-      fiveDiffferentRandomNumbers(min, min + nrQubits, randomGenerator);
+      fiveDifferentRandomNumbers(min, min + nrQubits, randomGenerator);
 
   // choose one of the non-compound operations, but not "None", and also
   // not GPhase or I or Barrier