mqt-ddsim 2.6.0__tar.gz

mqt_ddsim-2.6.0/.clang-format

@@ -0,0 +1,4 @@
+BasedOnStyle: LLVM
+IncludeBlocks: Regroup
+PointerAlignment: Left
+Standard: c++20

mqt_ddsim-2.6.0/.clang-tidy

@@ -0,0 +1,76 @@
+FormatStyle: file
+
+Checks: |
+  bugprone-*,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-unchecked-optional-access,
+  clang-analyzer-*,
+  -clang-analyzer-core.NullDereference,
+  clang-diagnostic-*,
+  cppcoreguidelines-*,
+  -cppcoreguidelines-non-private-member-variables-in-classes,
+  -cppcoreguidelines-special-member-functions,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-macro-usage,
+  -cppcoreguidelines-pro-type-reinterpret-cast,
+  -cppcoreguidelines-pro-bounds-constant-array-index,
+  -cppcoreguidelines-avoid-do-while,
+  google-*,
+  -google-readability-todo,
+  -google-build-using-namespace,
+  misc-*,
+  -misc-no-recursion,
+  -misc-non-private-member-variables-in-classes,
+  modernize-*,
+  -modernize-use-trailing-return-type,
+  performance-*,
+  -performance-no-int-to-ptr,
+  portability-*,
+  readability-*,
+  -readability-identifier-length,
+  -readability-magic-numbers,
+  -readability-function-cognitive-complexity
+
+CheckOptions:
+  - key: readability-identifier-naming.ClassCase
+    value: CamelCase
+  - key: readability-identifier-naming.ClassIgnoredRegexp
+    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*"
+  - key: readability-identifier-naming.ConstantParameterCase
+    value: camelBack
+  - key: readability-identifier-naming.EnumCase
+    value: CamelCase
+  - key: readability-identifier-naming.EnumConstantCase
+    value: CamelCase
+  - key: readability-identifier-naming.FunctionCase
+    value: camelBack
+  - key: readability-identifier-naming.FunctionIgnoredRegexp
+    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*"
+  - key: readability-identifier-naming.GlobalConstantCase
+    value: UPPER_CASE
+  - key: readability-identifier-naming.IgnoreMainLikeFunctions
+    value: "true"
+  - key: readability-identifier-naming.LocalConstantCase
+    value: camelBack
+  - key: readability-identifier-naming.LocalVariableCase
+    value: camelBack
+  - key: readability-identifier-naming.MemberCase
+    value: camelBack
+  - key: readability-identifier-naming.MemberIgnoredRegexp
+    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*"
+  - key: readability-identifier-naming.MethodCase
+    value: camelBack
+  - key: readability-identifier-naming.ParameterCase
+    value: camelBack
+  - key: readability-identifier-naming.ParameterIgnoredRegexp
+    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*|.*_"
+  - key: readability-identifier-naming.ConstantParameterIgnoredRegexp
+    value: ".*ZX.*|.*SWAP.*|.*CEX.*|.*DD.*|.*EQ.*|.*_"
+  - key: readability-identifier-naming.NamespaceCase
+    value: lower_case
+  - key: readability-identifier-naming.StaticConstantCase
+    value: UPPER_CASE
+  - key: readability-identifier-naming.StructCase
+    value: CamelCase
+  - key: readability-identifier-naming.VariableCase
+    value: camelBack

mqt_ddsim-2.6.0/.cmake-format.yaml

@@ -0,0 +1,7 @@
+format:
+  line_width: 100
+  keyword_case: "upper"
+  autosort: true
+
+markup:
+  first_comment_is_literal: true

mqt_ddsim-2.6.0/.git_archival.txt

@@ -0,0 +1,3 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$

mqt_ddsim-2.6.0/.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

mqt_ddsim-2.6.0/.gitignore

@@ -0,0 +1,91 @@
+# 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.
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Packaging
+/build/
+/dist/
+.eggs/
+*.egg
+*.egg-info/
+/_skbuild/
+/wheelhouse/
+
+# Testing
+.coverage
+.coverage.*
+.hypothesis/
+.nox/
+.pytest_cache/
+.tox/
+*.cover
+*.profraw
+coverage.xml
+htmlcov/
+
+# Documentation
+docs/_build/
+docs/**/build/
+docs/api/
+
+# Environments
+.env
+.env.*
+!.env.example
+!.env.*.example
+.venv/
+env/
+venv/
+
+# Tool caches
+.cache/
+.mypy_cache/
+.pyre/
+.pytype/
+.ruff_cache/
+.rumdl_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Versioning
+python/**/_version.py
+src/**/_version.py
+
+# CMake
+.ccache/
+/build_*/
+/cmake-build-*/
+/out/build/
+test/**/build/
+CMakeCache.txt
+CMakeFiles/
+CMakeUserPresets.json
+CTestTestfile.cmake
+cmake_install.cmake
+compile_commands.json
+
+# Editors
+.idea/
+.vs/
+.vscode/
+*.swp
+*~
+
+# Claude
+.claude/
+CLAUDE.md
+
+# Operating systems
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Thumbs.db
+ehthumbs.db

mqt_ddsim-2.6.0/.license-tools-config.json

@@ -0,0 +1,42 @@
+{
+  "author": {
+    "name": "Chair for Design Automation, TUM\nCopyright (c) 2025 - 2026 Munich Quantum Software Company GmbH",
+    "years": [2023, 2026]
+  },
+  "force_author": true,
+  "force_license": true,
+  "license": "MIT",
+  "title": false,
+  "include": ["**/*"],
+  "style_override_for_suffix": {
+    ".pyi": "DOCSTRING_STYLE",
+    ".in": "POUND_STYLE",
+    ".mlir": "SLASH_STYLE",
+    ".td": "SLASH_STYLE",
+    ".yaml": "POUND_STYLE",
+    ".toml": "POUND_STYLE",
+    ".yml": "POUND_STYLE"
+  },
+  "exclude": [
+    "^\\.[^/]+",
+    "/\\.[^/]+",
+    ".*\\.qasm",
+    ".*\\.md",
+    ".*\\.bib",
+    ".*\\.cff",
+    ".*\\.css",
+    ".*\\.ipynb",
+    ".*\\.json",
+    ".*\\.html",
+    ".*\\.tfc",
+    ".*\\.qc",
+    ".*\\.real",
+    ".*\\.rst",
+    ".*\\.tex",
+    ".*\\.profile",
+    "uv\\.lock",
+    "py\\.typed",
+    ".*build.*",
+    "(^|/)LICENSE$"
+  ]
+}

mqt_ddsim-2.6.0/.pre-commit-config.yaml

@@ -0,0 +1,172 @@
+# To run all pre-commit checks, use:
+#
+#     uvx prek run -a
+#
+# To install pre-commit hooks that run every time you commit:
+#
+#     uv tool install prek
+#     prek install
+#
+
+ci:
+  autoupdate_commit_msg: "⬆️🪝 update pre-commit hooks"
+  autoupdate_schedule: quarterly
+  autofix_commit_msg: "🎨 pre-commit fixes"
+  skip: [ty]
+
+repos:
+  ## Standard hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+        priority: 0
+      - id: end-of-file-fixer
+        priority: 1
+      - id: trailing-whitespace
+        priority: 2
+
+  ## Check JSON schemata
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.38.0
+    hooks:
+      - id: check-codecov
+        priority: 0
+      - id: check-github-workflows
+        priority: 0
+      - id: check-readthedocs
+        priority: 0
+
+  ## Check for security issues in GitHub Actions workflows
+  - repo: https://github.com/zizmorcore/zizmor-pre-commit
+    rev: v1.30.1
+    hooks:
+      - id: zizmor
+        priority: 0
+
+  ## Check best practices for scientific Python code
+  - repo: https://github.com/scientific-python/cookie
+    rev: 2026.08.14
+    hooks:
+      - id: sp-repo-review
+        additional_dependencies: ["repo-review[cli]"]
+        priority: 0
+
+  ## Check pyproject.toml file
+  - repo: https://github.com/henryiii/validate-pyproject-schema-store
+    rev: 2026.09.11
+    hooks:
+      - id: validate-pyproject
+        priority: 0
+
+  ## Ensure uv.lock is up to date
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.12.13
+    hooks:
+      - id: uv-lock
+        priority: 0
+
+  ## Check for common capitalization mistakes
+  - repo: local
+    hooks:
+      - id: disallow-caps
+        name: Disallow improper capitalization
+        language: pygrep
+        entry: \b(Nanobind|Numpy|Cmake|CCache|Github|PyTest|Mqt|Tum)\b
+        exclude: ^(\.pre-commit-config\.yaml)$
+        priority: 0
+
+  ## Check for typos
+  - repo: https://github.com/adhtruong/mirrors-typos
+    rev: v1.50.1
+    hooks:
+      - id: typos
+        priority: 3
+
+  ## Check license headers
+  - repo: https://github.com/emzeat/mz-lictools
+    rev: v2.9.0
+    hooks:
+      - id: license-tools
+        priority: 4
+
+  ## Format BibTeX files with bibtex-tidy
+  - repo: https://github.com/FlamingTempura/bibtex-tidy
+    rev: v1.14.0
+    hooks:
+      - id: bibtex-tidy
+        args:
+          [
+            "--align=20",
+            "--curly",
+            "--months",
+            "--blank-lines",
+            "--sort",
+            "--strip-enclosing-braces",
+            "--sort-fields",
+            "--trailing-commas",
+            "--remove-empty-fields",
+          ]
+        priority: 5
+
+  ## Format configuration files with prettier
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.9.6
+    hooks:
+      - id: prettier
+        types_or: [yaml, html, css, scss, javascript, json, json5]
+        priority: 5
+
+    ## Format Markdown files with rumdl
+  - repo: https://github.com/rvben/rumdl-pre-commit
+    rev: v0.2.72
+    hooks:
+      - id: rumdl
+        args: [--fix]
+        priority: 5
+      - id: rumdl-fmt
+        priority: 6
+
+  ## Format pyproject.toml with pyproject-fmt
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: v2.29.4
+    hooks:
+      - id: pyproject-fmt
+        priority: 5
+
+  ## Format CMake files with cmake-format
+  - repo: https://github.com/cheshirekow/cmake-format-precommit
+    rev: v0.6.13
+    hooks:
+      - id: cmake-format
+        additional_dependencies: [pyyaml]
+        types: [file]
+        files: (\.cmake|CMakeLists.txt)(.in)?$
+        priority: 5
+
+  ## Format C++ files with clang-format
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v23.1.1
+    hooks:
+      - id: clang-format
+        types_or: [c++, c, cuda]
+        priority: 5
+
+  ## Format and lint Python files with ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.16.7
+    hooks:
+      - id: ruff-check
+        require_serial: true
+        priority: 6
+      - id: ruff-format
+        types_or: [python, pyi, jupyter, markdown]
+        priority: 7
+
+  ## Check Python types with ty
+  - repo: https://github.com/astral-sh/ty-pre-commit
+    rev: v0.0.80
+    hooks:
+      - id: ty
+        args: [--only-dev]
+        priority: 8

mqt_ddsim-2.6.0/.readthedocs.yaml

@@ -0,0 +1,28 @@
+version: 2
+
+formats:
+  - htmlzip
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.14"
+  apt_packages:
+    - cmake
+    - doxygen
+    - graphviz
+  jobs:
+    pre_build:
+      # Build the C++ API docs before Sphinx starts
+      - cd docs && mkdir -p _build/doxygen && doxygen
+      - cd docs && mkdir -p api/cpp && uv run --no-sync --no-dev breathe-apidoc -o api/cpp -m -f -g file _build/doxygen/xml/
+
+python:
+  install:
+    - method: uv
+      command: sync
+      groups:
+        - docs

mqt_ddsim-2.6.0/.rumdl.toml

@@ -0,0 +1,21 @@
+[per-file-ignores]
+# The PR template is not a Markdown document in that sense
+"**/pull_request_template.md" = ["MD013", "MD041"]
+# The docs files may include HTML and do not need to start with a top-level heading
+"docs/**" = ["MD033", "MD041"]
+# The README may include HTML and does not need to start with a top-level heading
+"README.md" = ["MD033", "MD041"]
+
+[per-file-flavor]
+"docs/**" = "myst"
+
+[MD013]
+line-length = 80
+code-blocks = false
+headings = false
+reflow = true
+reflow-mode = "normalize"
+
+[MD060]
+enabled = true
+style = "aligned"

mqt_ddsim-2.6.0/AGENTS.md

@@ -0,0 +1,190 @@
+<!--- 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. -->
+
+# MQT DDSIM
+
+## C++
+
+- Configure: `cmake --preset release`
+- Build: `cmake --build --preset release`
+- Test: `ctest --preset release`
+- Single test binary: `./build/release/test/path/to/binary`
+- For debug builds, replace `release` with `debug`.
+- For more presets, see `CMakePresets.json`.
+
+## Python
+
+- Set up build and test dependencies:
+  `uv sync --inexact --only-group build --only-group test`
+- Install package without build isolation (fast rebuilds):
+  `uv sync --inexact --no-dev --no-build-isolation-package mqt-ddsim`
+- Run tests: `uv run --no-sync pytest`
+- Nox test shortcuts: `uvx nox -s tests`, `uvx nox -s minimums`
+- Python 3.14 variants: `uvx nox -s tests-3.14`, `uvx nox -s minimums-3.14`
+
+## Documentation
+
+- Sources: `docs/`
+- Build docs locally: `uvx nox --non-interactive -s docs`
+- Link check: `uvx nox -s docs -- -b linkcheck`
+
+## Tech Stack
+
+### General
+
+- `prek` for pre-commit hooks
+
+### C++
+
+- Targets Linux (glibc 2.28+), macOS (11.0+), and Windows on x86_64 and arm64
+  architectures
+- C++20
+- CMake 3.28+
+- `FetchContent` for dependency management (configured in
+  `cmake/ExternalDependencies.cmake`)
+- `clang-format` and `clang-tidy` for formatting/linting (see `.clang-format`
+  and `.clang-tidy`)
+- GoogleTest for unit tests (located in `test/`)
+
+### Python
+
+- Python 3.11+
+- Split-mode Stable ABI wheels: `cp311-abi3` for GIL-enabled CPython 3.11+ and
+  `cp315-abi3t` for free-threaded CPython 3.15+
+- `scikit-build-core` as build backend
+- `nanobind` for bindings
+- `uv` for installation, packaging, and tooling
+- `ruff` for formatting/linting (configured in `pyproject.toml`)
+- `ty` for type checking
+- `pytest` for unit tests (located in `test/python/`)
+- `nox` for task orchestration (tests, linting, docs)
+
+### Documentation
+
+- `sphinx`
+- MyST (Markdown)
+- Furo theme
+- `breathe` for C++ API docs
+
+## Development Guidelines
+
+### General
+
+- MUST read and follow `docs/ai_usage.md`. A human must review and understand
+  all AI-assisted work. AI assistance must not be used for contributions to
+  issues labeled `good first issue`.
+- MUST run `uvx nox -s lint` after every batch of changes. This runs the full
+  `prek` hook set from `.pre-commit-config.yaml` (including `ruff`, `typos`,
+  `ty`, formatting, and metadata checks). All hooks must pass before submitting.
+- MUST add or update tests for every code change, even if not explicitly
+  requested.
+- MUST write tests that protect intended behavior or reproduce a concrete
+  regression. NEVER test provisional implementation choices that are not part of
+  the supported contract.
+- MUST place tests in the repository's corresponding test tree, organized by the
+  component that owns the behavior. NEVER place tests or test fixtures in
+  production source or tool directories. Reserve tool- or CLI-level subprocess
+  tests for contracts that cannot be exercised meaningfully through a lower-
+  level public API. Normal test targets and dependencies belong in the test
+  build; avoid promoting an otherwise optional production tool into the default
+  build solely for subprocess testing.
+- MUST follow existing code style by checking neighboring files for patterns.
+- MUST write code comments, documentation, tests, changelog entries, and public
+  text for the final design. NEVER preserve prompts, review chronology, former
+  names, or abandoned approaches unless they remain necessary user-facing
+  context.
+- MUST apply
+  [Orwell's six rules for writing](https://www.orwellfoundation.com/the-orwell-foundation/orwell/essays-and-other-works/politics-and-the-english-language/)
+  to every category of prose, including reasoning, descriptions, commit
+  messages, documentation, docstrings, comments, test text, diagnostics, and
+  handoffs:
+
+  1. Do not use a familiar metaphor, simile, or other figure of speech.
+  2. Use a short word when it has the same meaning as a long word.
+  3. Remove every word that does not add meaning.
+  4. Use active voice when possible.
+  5. Use everyday English instead of a foreign phrase, scientific word, or
+     jargon term when this does not reduce precision.
+  6. Break a rule before it makes the text unclear, incorrect, or needlessly
+     difficult to read.
+
+- MUST apply the relevant principles of
+  [ASD-STE100 Simplified Technical English](https://www.asd-ste100.org/): use
+  short, direct sentences; give each sentence one main idea; use one term for
+  one meaning; and use explicit nouns instead of vague pronouns. These are
+  mandatory style rules, not a claim of formal ASD-STE100 compliance.
+- MUST base terminology and phrasing on existing usage in the repository and on
+  established precedents in the communities the repository draws from. Use the
+  established term that most precisely matches the concept. If communities use
+  different terms, explain the mapping once. NEVER invent synonyms for variety.
+- MUST remove obsolete scaffolding and diagnostic suppressions before handoff.
+  Keep a workaround or suppression only when it is still necessary, scope it as
+  narrowly as possible, and document the technical reason.
+- MUST update `CHANGELOG.md` and `UPGRADING.md` when changes are user-facing,
+  breaking, or otherwise noteworthy.
+- MUST format changelog entries with the pull request reference and every
+  contributing author, for example `([#123]) ([**@username**])`, and define the
+  corresponding links at the bottom of `CHANGELOG.md`.
+- AI assistance MUST be disclosed in the PR description.
+- Commit-level `Assisted-by: [Model Name] via [Tool Name]` trailers are
+  recommended, not required. For example:
+  `Assisted-by: Claude Sonnet 4.6 via GitHub Copilot`. Do not rewrite otherwise
+  valid history solely to add one.
+- NEVER modify files that start with "This file has been generated from an
+  external template. Please do not modify it directly." These files are managed
+  by
+  [the MQT templates action](https://github.com/munich-quantum-toolkit/templates)
+  and changes will be overwritten.
+- PREFER running targeted tests over the full test suite during development.
+
+### GitHub Issues and Pull Requests
+
+- MAY create, submit, and edit pull requests; create and manage issues; and
+  comment on issues or pull requests when the task explicitly authorizes that
+  external action. A single authorization may cover a clearly scoped task;
+  per-message approval is not required. Actions outside that scope require fresh
+  authorization. The human remains responsible for reviewing all submitted work.
+- MUST use the repository's pull request template when one is present.
+- Every agent-authored or agent-edited public text body MUST begin with
+  `🤖 *AI text below* 🤖` on its first line. This applies to issue and pull
+  request descriptions, review bodies, inline review comments, issue comments,
+  replies, and other submitted text bodies; titles are exempt.
+- When editing human-authored public text, preserve its original content and add
+  the disclosure at the beginning of the edited field.
+- MUST keep external communication accurate, specific, and non-repetitive; do
+  not post low-quality or unsolicited comments.
+- When reviewing a contribution, MUST focus findings on substantive correctness,
+  contracts, maintainability, tests, documentation, licensing, and validation.
+  NEVER report a missing optional AI-attribution trailer as a review finding.
+
+### C++
+
+- MUST use Doxygen-style comments.
+- MUST use `#pragma once` for header guards.
+- MUST regenerate stubs via `uvx nox -s stubs` when files in `bindings/` are
+  added or modified.
+- NEVER edit `.pyi` files in `python/mqt/ddsim/` manually; they are
+  auto-generated by `nanobind.stubgen`.
+- PREFER C++20 STL features over custom implementations.
+
+### Python
+
+- MUST use Google-style docstrings
+- PREFER running a single Python version over the full test suite during
+  development.
+- PREFER fixing reported warnings over suppressing them (e.g., with `# noqa`
+  comments for ruff); only add ignore rules when necessary and document why.
+- PREFER fixing typing issues reported by `ty` before adding suppression
+  comments (`# ty: ignore[code]`); suppressions are sometimes necessary for
+  incompletely typed libraries (e.g., Qiskit).
+
+## Self-Review Checklist
+
+- Did `uvx nox -s lint` pass without errors?
+- Are all changes covered by at least one automated test?
+- Were any agent-authored issue or pull request texts explicitly authorized and
+  marked with the required visible disclosure?
+- Were Python stubs regenerated via `uvx nox -s stubs` if bindings were
+  modified?
+- Are `CHANGELOG.md` and `UPGRADING.md` updated when changes are user-facing,
+  breaking, or otherwise noteworthy?