pyproject.toml

# Copyright (c) 2026 Chair for Design Automation, TUM
# Copyright (c) 2026 Munich Quantum Software Company GmbH
# All rights reserved.
#
# SPDX-License-Identifier: MIT
#
# Licensed under the MIT License

[build-system]
build-backend = "scikit_build_core.build"
requires = [
  "nanobind~=3.1.0",
  "scikit-build-core>=1.0.3",
  "vcs-versioning>=2.3",
]


[project]
name = "mqt-scpd"
description = "Physical Design for Superconducting Quantum Chips"
readme = "README.md"
keywords = [ "design-automation", "MQT", "quantum-computing" ]
license = "MIT"
license-files = [ "LICENSE" ]
requires-python = ">=3.11"
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Information Technology",
  "Intended Audience :: Science/Research",
  "Natural Language :: English",
  "Operating System :: MacOS",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX :: Linux",
  "Programming Language :: C++",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Programming Language :: Python :: 3.15",
  "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
  "Topic :: Scientific/Engineering :: Quantum Computing",
  "Typing :: Typed",
]
dynamic = [ "version" ]
dependencies = [
  # The same version as FLATBUFFERS_VERSION in cmake/ExternalDependencies.cmake, which generates the code
  "flatbuffers~=25.12.19",
  "nanobind-backend>=1",
]

[[project.authors]]
name = "Michael Feldmeier"
email = "michael.feldmeier@tum.de"

[project.optional-dependencies]
# KLayout writes GDSII and OASIS. It is an extra because it ships no wheels for Windows on ARM.
# 0.30.6 is the first release with wheels for CPython 3.14 on every platform the CI covers; the
# upper bound keeps a new minor release of KLayout from breaking the adapter unnoticed.
klayout = [ "klayout~=0.30.6" ]

[project.urls]
Homepage = "https://github.com/munich-quantum-toolkit/scpd"
Documentation = "https://mqt.readthedocs.io/projects/scpd"
Issues = "https://github.com/munich-quantum-toolkit/scpd/issues"
Discussions = "https://github.com/munich-quantum-toolkit/scpd/discussions"

[project.scripts]
mqt-scpd = "mqt.scpd.cli:main"


[dependency-groups]
dev = [
  { include-group = "build" },
  { include-group = "test" },
  "nox>=2025.11.12",
]
test = [
  "flatbuffers~=25.12.19",
  # KLayout ships no wheels for Windows on ARM or for CPython 3.15; the export tests skip without it.
  "klayout~=0.30.6; python_version<'3.15' and (sys_platform!='win32' or platform_machine!='ARM64')",
  "pytest>=9.0.1",
  "pytest-cov>=7.1",
  "pytest-sugar>=1.1.1",
  "pytest-xdist>=3.8",
]
docs = [
  "breathe>=4.36",
  "furo>=2025.12.19",
  "ipywidgets>=8.1.7",
  "myst-nb>=1.4",
  "sphinx>=9",
  "sphinx-autoapi>=3.6",
  "sphinx-copybutton>=0.5.2",
  "sphinx-design>=0.7",
  "sphinx-llm>=1",
  "sphinxcontrib-bibtex>=2.7",
  "sphinxext-opengraph>=0.13",
]
build = [
  "cmake>=4.4.1",
  "nanobind~=3.1.0",
  "scikit-build-core>=1.0.3",
  "vcs-versioning>=2.3",
]


[tool.scikit-build]
# Protect the configuration against future changes in scikit-build-core
minimum-version = "build-system.requires"
# Setuptools-style build caching in a local directory
build-dir = "build/{wheel_tag}/{build_type}"

[tool.scikit-build.build]

# Only build the Python bindings target
targets = [
  "mqt-scpd-bindings",
]

[tool.scikit-build.cmake]

# CMake 4.4 detects free-threaded Python and supplies Py_GIL_DISABLED on Windows
version = ">=4.4.1"

[tool.scikit-build.cmake.define]
BUILD_MQT_SCPD_TESTS = "OFF"
BUILD_MQT_SCPD_BINDINGS = "ON"

[tool.scikit-build.ninja]

# Set required Ninja version
version = ">=1.10"

[tool.scikit-build.sdist]
include = [ "python/mqt/scpd/_version.py" ]
exclude = [
  "**/.github",
  "**/doc",
  "**/docs",
  "**/eval",
  "**/meta",
  "**/plots",
  "**/test",
  "**/tests",
]

[tool.scikit-build.wheel]

# Set the wheel install directory
install-dir = "mqt/scpd"

# Explicitly set the package directory
packages = [ "python/mqt" ]

# Build one split-mode Stable ABI wheel for GIL-enabled CPython 3.11+
py-api = "cp311"

[tool.scikit-build.install]

# Only install the Python package component
components = [ "mqt-scpd_Python" ]

[[tool.scikit-build.overrides]]
if.python-version = ">=3.15"
if.abi-flags = "t"
wheel.py-api = "cp315t"


[tool.uv]
required-version = ">=0.5.20"
cache-keys = [
  { file = "pyproject.toml" },
  { git = { commit = true, tags = true } },
  { file = "bindings/**/*.cpp" },
  { file = "python/mqt/scpd/flatbuffers/**/*.py" },
]

[tool.uv.sources]
mqt-scpd = { workspace = true }


[tool.cibuildwheel]
build = "cp3*"
skip = [ "*-musllinux_*", "cp314t-*" ]
archs = "auto64"
build-frontend = "uv"
test-command = "pytest {project}/test/python"
test-groups = [ "test" ]

[tool.cibuildwheel.linux]
environment = { DEPLOY = "ON" }

[tool.cibuildwheel.macos]
environment = { MACOSX_DEPLOYMENT_TARGET = "13.3" }

[tool.cibuildwheel.windows]
repair-wheel-command = "delvewheel repair -w {dest_dir} {wheel} --namespace-pkg mqt --ignore-existing"
before-test = "uv pip install --group test"
# cibuildwheel 4.2 passes expanded dependency groups through cmd.exe, which interprets version
# operators as redirections. Let uv resolve the group itself.
test-groups = []


[tool.ruff]
line-length = 120
namespace-packages = [ "mqt" ]
src = [ "python" ]
# The schema-generated modules are regenerated by `nox -s schemas` and are not formatted or linted.
extend-exclude = [ "python/mqt/scpd/flatbuffers" ]
force-exclude = true
preview = true
fix = true
unsafe-fixes = true
show-fixes = true

[tool.ruff.format]
preview = true
docstring-code-format = true

[tool.ruff.lint.per-file-ignores]
"test/python/**" = [ "INP001", "T20" ]
"python/mqt/scpd/cli.py" = [ "T20" ]  # the command line prints its output
"docs/**" = [ "INP001", "T20" ]
"noxfile.py" = [ "T20", "TID251" ]
"*.pyi" = [ "D301", "D418", "E501", "PYI021" ]
"*.ipynb" = [
  "D",    # pydocstyle
  "E402", # Allow imports to appear anywhere in Jupyter notebooks
  "I002", # Allow missing `from __future__ import annotations` import
]

[tool.ruff.lint.isort]
known-first-party = [ "mqt.scpd" ]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint]
select = [ "ALL" ]
ignore = [
  "C90",     # <...> too complex
  "COM812",  # Conflicts with formatter
  "PLR09",   # Too many <...>
  "PLR2004", # Magic value used in comparison
  "S101",    # Use of assert detected
  "S404",    # `subprocess` module is possibly insecure
  "TID252"  # Prefer absolute imports over relative imports from parent modules
]
future-annotations = true


[tool.repo-review.ignore]
GH200 = "We use Renovate instead of Dependabot"
PC160 = "We use a mirror of crate-ci/typos"
PC170 = "We do not use rST files anymore"


[tool.check-sdist]
sdist-only = [ "python/mqt/scpd/_version.py" ]
git-only = [
  "docs/*",
  "eval/*",
  "extern/*",
  "test/*",
  ".idea/*",
]


[tool.check-wheel-contents]
ignore = [ "W002" ]  # Triggers on __init__.py's


[tool.pyproject-fmt]
generate_python_version_classifiers = false
table_format = "long"
sub_table_spacing = "\n"
separate_root_table = "\n\n"


[tool.typos]

[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-identifiers]
countr_zero = "countr_zero"

[tool.typos.default.extend-words]
wille = "wille"
anc = "anc"
optin = "optin"
aer = "aer"
iy = "iy"
iz = "iz"
ket = "ket"

[tool.typos.files]
extend-exclude = [ "tableaus\\.json" ]


[tool.ty.src]
exclude = [
  "docs/**",
  "python/mqt/scpd/flatbuffers/**",
]

[tool.ty.terminal]
# Error if ty emits any warning-level diagnostics.
error-on-warning = true


[tool.pytest]
addopts = [
  "-ra",
  "--showlocals",
  "--numprocesses=auto", # Automatically use all available CPU cores for parallel testing
]
filterwarnings = [
  "error",
]
log_level = "INFO"
minversion = "9.0"
strict = true
testpaths = [ "test/python" ]


[tool.coverage]

[tool.coverage.run]
source = [ "mqt.scpd" ]
omit = [
  "*/_compat/*",
  "*/flatbuffers/*",
  "*/visualization/*",
]
parallel = true
disable_warnings = [
  "no-sysmon",
]
core = "sysmon"

[tool.coverage.report]
exclude_also = [
  "@overload",                 # Overloads are only for static typing
  '\.\.\.',
  "def __dir__()",             # Ignore __dir__ method that exists mainly for better IDE support
  "if TYPE_CHECKING:",
  "raise AssertionError",
  "raise NotImplementedError"
]


[[tool.dynamic-metadata]]
provider = "vcs_versioning"


[tool.vcs-versioning]
write_to = "python/mqt/scpd/_version.py"