mqt.problemsolver 0.4__tar.gz → 0.5.0__tar.gz

mqt_problemsolver-0.5.0/.github/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+<!--- This file has been generated from an external template. Please do not modify it directly. -->
+<!--- Changes should be contributed to https://github.com/munich-quantum-toolkit/templates. -->
+
+# Contributing
+
+Thank you for your interest in contributing to MQT ProblemSolver! An extensive
+contribution guide is available in our
+[documentation](https://mqt.readthedocs.io/projects/problemsolver/en/latest/contributing.html).

mqt_problemsolver-0.5.0/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,53 @@
+# This file has been generated from an external template. Please do not modify it directly.
+# Changes should be contributed to https://github.com/munich-quantum-toolkit/templates.
+
+name: 🐛 Bug Report
+description: Report a problem or unexpected behavior
+title: "🐛 <brief description of the issue>"
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        **Thanks for taking the time to report an issue!**
+
+        ⚠ Before submitting:
+        1. Search [existing issues](https://github.com/munich-quantum-toolkit/problemsolver/search?q=is%3Aissue&type=issues) to avoid duplicates
+        2. For questions or discussions, please use our [discussions forum](https://github.com/munich-quantum-toolkit/problemsolver/discussions)
+
+  - type: textarea
+    attributes:
+      label: System and Environment Information
+      description: Provide details about your environment.
+      placeholder: |
+        - Operating system and version:
+        - MQT ProblemSolver version:
+        - Language versions (e.g., C++, Python, Rust, ...):
+        - Compiler or build tool versions (e.g., Clang, GCC, rustc, ...):
+        - Any relevant dependencies and their versions:
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Bug Description
+      description: Provide a clear and detailed explanation of the issue you are experiencing.
+      placeholder: |
+        What happened?
+        What did you expect to happen instead?
+        Include any error messages or unexpected behavior you observed.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Provide specific steps to reproduce this issue.
+      placeholder: |
+        1. Set up environment with '...'
+        2. Configure workflow using '...'
+        3. Execute command '...'
+        4. Observe error/issue: '...'
+
+        Include any relevant code snippets, workflow configurations, or input files that help demonstrate the problem.
+    validations:
+      required: true

mqt_problemsolver-0.5.0/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,39 @@
+# This file has been generated from an external template. Please do not modify it directly.
+# Changes should be contributed to https://github.com/munich-quantum-toolkit/templates.
+
+name: ✨ Feature request
+description: Suggest a new feature or improvement
+title: "✨ <title>"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Thanks for helping improve this project by suggesting a feature!**
+
+        ⚠ Before submitting:
+        - Search [existing feature requests](https://github.com/munich-quantum-toolkit/problemsolver/search?q=is%3Aissue&type=issues) to avoid duplicates
+        - One feature per issue helps us track and implement ideas effectively
+
+  - type: textarea
+    attributes:
+      label: Problem Statement
+      description: >-
+        Describe the problem you are facing and why it needs to be solved. What limitations are you encountering?
+      placeholder: >-
+        Currently, when I try to [action/task], I am unable to [blockers/limitations].
+        This creates problems because [impact/consequences].
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed Solution
+      description: >
+        Describe your ideal solution. What would the feature look like? How would it work?
+      placeholder: >-
+        I'd like to see [feature/change] that would:
+        - [benefit 1]
+        - [benefit 2]
+        - [example usage/scenario]
+    validations:
+      required: true

mqt_problemsolver-0.5.0/.github/SECURITY.md

@@ -0,0 +1,22 @@
+<!--- This file has been generated from an external template. Please do not modify it directly. -->
+<!--- Changes should be contributed to https://github.com/munich-quantum-toolkit/templates. -->
+
+# Security Policy
+
+## Supported Versions
+
+Security updates are applied only to the most recent releases.
+
+## Reporting a Vulnerability
+
+To report vulnerabilities, you can privately report a potential security issue
+via the GitHub security vulnerabilities feature. This can be done here:
+
+<https://github.com/munich-quantum-toolkit/problemsolver/security/advisories>
+
+Please do **not** open a public issue about a potential security vulnerability.
+
+You can find more details on the security vulnerability feature in the GitHub
+documentation here:
+
+<https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability>

mqt_problemsolver-0.5.0/.github/SUPPORT.md

@@ -0,0 +1,22 @@
+<!--- This file has been generated from an external template. Please do not modify it directly. -->
+<!--- Changes should be contributed to https://github.com/munich-quantum-toolkit/templates. -->
+
+# Support
+
+If you are stuck with a problem using MQT ProblemSolver or have questions,
+please get in touch at our [Issues] or [Discussions]. We'd love to help.
+
+You can save time by following this procedure when reporting a problem:
+
+- Do try to solve the problem on your own first.
+- Search through past [Issues] and [Discussions] to see if someone else already
+  had the same problem.
+- Before filing a bug report, try to create a minimal reproducible example (MRE)
+  that reproduces the problem. It is much easier to identify the cause for the
+  problem if a handful of lines suffice to show that something is not working.
+
+You can also always reach us at
+[quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de).
+
+[Issues]: https://github.com/munich-quantum-toolkit/problemsolver/issues
+[Discussions]: https://github.com/munich-quantum-toolkit/problemsolver/discussions

{mqt_problemsolver-0.4 → mqt_problemsolver-0.5.0}/.github/codecov.yml

@@ -1,6 +1,5 @@
 ignore:
   - "tests/**/*"
-  - "resource_estimation/**/*"
 
 coverage:
   range: 60..90

mqt_problemsolver-0.5.0/.github/pull_request_template.md

@@ -0,0 +1,31 @@
+## Description
+
+Please include a summary of the change and, if applicable, which issue is fixed.
+Please also include relevant motivation and context.
+List any dependencies that are required for this change.
+
+<!---
+Replace `(issue)` with the issue number fixed by this pull request.
+If this PR does not fix an issue, please remove the line.
+-->
+
+Fixes #(issue)
+
+## Checklist
+
+<!---
+This checklist serves as a reminder of a couple of things that ensure your pull request will be merged swiftly.
+-->
+
+- [ ] The pull request only contains commits that are focused and relevant to this change.
+- [ ] I have added appropriate tests that cover the new/changed functionality.
+- [ ] I have updated the documentation to reflect these changes.
+- [ ] The changes follow the project's style guidelines and introduce no new warnings.
+- [ ] The changes are fully tested and pass the CI checks.
+- [ ] I have reviewed my own code changes.
+
+**If PR contains AI-assisted content:**
+
+- [ ] I have disclosed the use of AI tools in the PR description as per our [AI Usage Guidelines](https://github.com/munich-quantum-toolkit/problemsolver/blob/main/docs/ai_usage.md).
+- [ ] AI-assisted commits include an `Assisted-by: [Model Name] via [Tool Name]` footer.
+- [ ] I confirm that I have personally reviewed and understood all AI-generated content, and accept full responsibility for it.

{mqt_problemsolver-0.4 → mqt_problemsolver-0.5.0}/.github/release-drafter.yml

@@ -1,13 +1,19 @@
+# This file has been generated from an external template. Please do not modify it directly.
+# Changes should be contributed to https://github.com/munich-quantum-toolkit/templates.
+
 name-template: "MQT ProblemSolver $RESOLVED_VERSION Release"
 tag-template: "v$RESOLVED_VERSION"
 categories:
   - title: "🚀 Features and Enhancements"
     labels:
+      - "enhancement"
       - "feature"
+      - "refactor"
       - "usability"
   - title: "🐛 Bug Fixes"
     labels:
       - "bug"
+      - "fix"
   - title: "📄 Documentation"
     labels:
       - "documentation"
@@ -17,14 +23,22 @@ categories:
   - title: "📦 Packaging"
     labels:
       - "packaging"
+  - title: "🧹 Code Quality"
+    labels:
+      - "code quality"
   - title: "⬆️ Dependencies"
     collapse-after: 5
     labels:
       - "dependencies"
+      - "github-actions"
+      - "pre-commit"
       - "submodules"
-      - "github_actions"
-change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+change-template: "- $TITLE ([#$NUMBER]($URL)) (**@$AUTHOR**)"
 change-title-escapes: '\<*_&'
+exclude-labels:
+  - "skip-changelog"
+  - "backport"
+  - "release-prep"
 version-resolver:
   major:
     labels:
@@ -36,14 +50,8 @@ version-resolver:
     labels:
       - "patch"
   default: patch
-autolabeler:
-  - label: "dependencies"
-    title:
-      - "/update pre-commit hooks/i"
 
 template: |
-  ## What Changed 👀
-
   $CHANGES
 
   **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

mqt_problemsolver-0.5.0/.github/renovate.json5

@@ -0,0 +1,99 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  suppressNotifications: ["prEditedNotification"],
+  minimumReleaseAge: "7 days",
+  extends: [
+    "config:recommended",
+    ":gitSignOff",
+    "helpers:pinGitHubActionDigestsToSemver",
+    ":automergeDigest",
+    ":automergeStableNonMajor",
+    ":combinePatchMinorReleases",
+    ":configMigration",
+    ":enablePreCommit",
+    ":prConcurrentLimitNone",
+    ":prHourlyLimitNone",
+  ],
+  enabledManagers: [
+    "cargo",
+    "github-actions",
+    "npm",
+    "pep621",
+    "pip_requirements",
+    "pre-commit",
+  ],
+  lockFileMaintenance: {
+    enabled: true,
+    automerge: true,
+  },
+  labels: ["dependencies"],
+  schedule: ["every weekend"],
+  packageRules: [
+    {
+      matchManagers: ["cargo"],
+      addLabels: ["rust"],
+      commitMessagePrefix: "⬆\uFE0F\uD83E\uDD80",
+    },
+    {
+      matchManagers: ["github-actions"],
+      addLabels: ["github-actions"],
+      commitMessagePrefix: "⬆\uFE0F\uD83D\uDC68\u200D\uD83D\uDCBB",
+    },
+    {
+      matchManagers: ["npm"],
+      addLabels: ["javascript"],
+      commitMessagePrefix: "⬆\uFE0F\uD83D\uDCDC",
+    },
+    {
+      matchManagers: ["pep621", "pip_requirements"],
+      addLabels: ["python"],
+      commitMessagePrefix: "⬆\uFE0F\uD83D\uDC0D",
+    },
+    {
+      matchManagers: ["pre-commit"],
+      addLabels: ["pre-commit"],
+      commitMessagePrefix: "⬆\uFE0F\uD83E\uDE9D",
+      versioning: "pep440",
+    },
+    {
+      matchUpdateTypes: ["lockFileMaintenance"],
+      commitMessagePrefix: "⬆\uFE0F\uD83D\uDD12\uFE0F",
+    },
+    {
+      description: "Group and auto-merge all patch updates",
+      groupName: "patch updates",
+      matchUpdateTypes: ["patch"],
+      matchCurrentVersion: "!/^0\.0/",
+      commitMessagePrefix: "⬆\uFE0F\uD83E\uDE79",
+      automerge: true,
+    },
+    {
+      description: "Group and auto-merge minor updates of stable dependencies",
+      groupName: "minor stable updates",
+      matchUpdateTypes: ["minor"],
+      matchCurrentVersion: "!/^0\./",
+      matchPackageNames: [
+        "!munich-quantum-toolkit/*",
+        "!munich-quantum-software/*",
+        "!nanobind",
+      ],
+      commitMessagePrefix: "⬆\uFE0F\uD83E\uDE79",
+      automerge: true,
+    },
+    {
+      description: "Disable minimum release age checks for our own GitHub actions",
+      matchManagers: ["github-actions"],
+      matchPackageNames: [
+        "munich-quantum-toolkit/*",
+        "munich-quantum-software/*",
+      ],
+      minimumReleaseAge: null,
+    },
+    {
+      description: "Disable minimum release age checks for our own Python packages",
+      matchDatasources: ["pypi"],
+      matchPackageNames: ["mqt*"],
+      minimumReleaseAge: null,
+    },
+  ],
+}

mqt_problemsolver-0.5.0/.github/workflows/cd.yml

@@ -0,0 +1,45 @@
+name: CD
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - .github/workflows/cd.yml
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build-sdist:
+    name: 🐍 Packaging
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+
+  build-wheel:
+    name: 🐍 Packaging
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+
+  deploy:
+    if: github.event_name == 'release' && github.event.action == 'published'
+    name: 🚀 Deploy to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mqt.problemsolver
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    needs: [build-sdist, build-wheel]
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - name: Generate artifact attestation for sdist and wheel(s)
+        uses: actions/attest@59d89421af93a897026c735860bf21b6eb4f7b26 # v4.1.0
+        with:
+          subject-path: "dist/*"
+      - uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0

mqt_problemsolver-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,94 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  merge_group:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  id-token: write
+  security-events: write
+
+jobs:
+  change-detection:
+    name: 🔍 Change
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-change-detection.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+
+  python-tests:
+    name: 🐍 Test
+    needs: change-detection
+    if: fromJSON(needs.change-detection.outputs.run-python-tests)
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on: [ubuntu-24.04, ubuntu-24.04-arm, macos-26, windows-2025]
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-tests.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+    with:
+      runs-on: ${{ matrix.runs-on }}
+
+  python-coverage:
+    name: 🐍 Coverage
+    needs: [change-detection, python-tests]
+    if: fromJSON(needs.change-detection.outputs.run-python-tests)
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-coverage.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+    permissions:
+      contents: read
+      id-token: write
+
+  python-linter:
+    name: 🐍 Lint
+    needs: change-detection
+    if: fromJSON(needs.change-detection.outputs.run-python-linter)
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-linter.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+    with:
+      enable-ty: true
+      enable-mypy: false
+
+  build-sdist:
+    name: 🚀 CD
+    needs: change-detection
+    if: fromJSON(needs.change-detection.outputs.run-cd)
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-sdist.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+
+  build-wheel:
+    name: 🚀 CD
+    needs: change-detection
+    if: fromJSON(needs.change-detection.outputs.run-cd)
+    uses: munich-quantum-toolkit/workflows/.github/workflows/reusable-python-packaging-wheel-build.yml@e7f84f39ce2d3b6c5d1d04526b8f94f98e455143 # v2.2.0
+
+  required-checks-pass: # This job does nothing and is only used for branch protection
+    name: 🚦 Check
+    if: always()
+    needs:
+      - change-detection
+      - python-tests
+      - python-coverage
+      - python-linter
+      - build-sdist
+      - build-wheel
+    runs-on: ubuntu-slim
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
+        with:
+          allowed-skips: >-
+            ${{
+              !fromJSON(needs.change-detection.outputs.run-python-tests)
+              && 'python-tests,python-coverage,' || ''
+            }}
+            ${{
+              !fromJSON(needs.change-detection.outputs.run-python-linter)
+              && 'python-linter,' || ''
+            }}
+            ${{
+              !fromJSON(needs.change-detection.outputs.run-cd)
+              && 'build-sdist,build-wheel' || ''
+            }}
+          jobs: ${{ toJSON(needs) }}

mqt_problemsolver-0.5.0/.github/workflows/nextjs.yml

@@ -0,0 +1,75 @@
+# Sample workflow for building and deploying a Next.js site to GitHub Pages
+#
+# To get started with Next.js see: https://nextjs.org/docs/getting-started
+#
+name: Deploy Next.js site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
+        with:
+          static_site_generator: next
+
+      - name: Setup Node
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version: "24"
+          cache: "npm"
+          # Point cache to the package-lock.json in your subdirectory
+          cache-dependency-path: webpage/package-lock.json
+
+      - name: Install dependencies
+        # Run commands inside your subdirectory
+        working-directory: ./webpage
+        run: npm ci
+
+      - name: Build with Next.js
+        # Run commands inside your subdirectory
+        working-directory: ./webpage
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          # The build output is now located at webpage/out
+          path: ./webpage/out
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

mqt_problemsolver-0.5.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,17 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+permissions: {}
+
+jobs:
+  update_release_draft:
+    name: Run
+    permissions:
+      contents: write
+    runs-on: ubuntu-slim
+    steps:
+      - uses: release-drafter/release-drafter@4d75298e00d9e34c483e5ff8c68d0ea1c1940c1e # v7.5.1

mqt_problemsolver-0.5.0/.github/workflows/templating.yml

@@ -0,0 +1,31 @@
+name: Templating
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - ".github/workflows/templating.yml"
+  workflow_dispatch: # Allow manual triggering
+
+jobs:
+  render-template:
+    name: Render template
+    runs-on: ubuntu-slim
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - id: create-token
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
+        with:
+          client-id: ${{ secrets.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
+      - uses: munich-quantum-toolkit/templates@6b796f4c0404f74be469f32a3dcac05ef61d7b72 # v1.3.3
+        with:
+          token: ${{ steps.create-token.outputs.token }}
+          name: ProblemSolver
+          organization: ${{ github.repository_owner }}
+          project-type: pure-python
+          repository: ${{ github.event.repository.name }}
+          has-changelog-and-upgrade-guide: false

{mqt_problemsolver-0.4 → mqt_problemsolver-0.5.0}/.gitignore

@@ -1,5 +1,7 @@
 ./idea
 .DS_Store
+.vscode
+_version.py
 
 # Created by https://www.toptal.com/developers/gitignore/api/pycharm+all,python,jupyternotebooks
 # Edit at https://www.toptal.com/developers/gitignore?templates=pycharm+all,python,jupyternotebooks
@@ -179,6 +181,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/api/
 
 # PyBuilder
 .pybuilder/
@@ -266,3 +269,18 @@ cython_debug/
 #.idea/
 
 # End of https://www.toptal.com/developers/gitignore/api/pycharm+all,python,jupyternotebooks
+
+# Claude
+CLAUDE.md
+.claude/
+
+# OS specific stuff
+.DS_Store
+.DS_Store?
+.Spotlight-V100
+.Trashes
+._*
+Thumbs.db
+editor.swp
+editor~
+ehthumbs.db