pyproject.toml

# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
#
# SPDX-License-Identifier: MPL-2.0

[build-system]
requires = [
    "scikit-build-core",
    "pgm-build-dependencies@https://github.com/PowerGridModel/pgm-build-dependencies/releases/latest/download/pgm_build_dependencies-0.1.0-py3-none-any.whl",
]
build-backend = "scikit_build_core.build"

[project]
name = "power-grid-model"
authors = [
    { name = "Contributors to the Power Grid Model project", email = "powergridmodel@lfenergy.org" },
]
description = "Python/C++ library for distribution power system analysis"
readme = "README.md"
license = "MPL-2.0"
classifiers = [
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: C++",
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS",
    "Topic :: Scientific/Engineering :: Physics",
]
requires-python = ">=3.12"
dependencies = ["numpy>=2.0.0"]
dynamic = ["version"]

[dependency-groups]

test = ["pytest", "pytest-cov", "msgpack"]

lint = [
    "pre-commit",
    "ruff",
    "mypy",
    "numpy",                # needed for mypy
    "gersemi",              # CMake linter
    "clang-format ~= 18.0", # C++ formatter
]

example = ["ipykernel"]

dev = [
    { include-group = "test" },
    { include-group = "lint" },
    { include-group = "example" },
]

code-generation = ["dataclasses_json", "jinja2"]

doc = [
    "sphinx",
    "breathe",
    "myst_nb",
    "sphinx_rtd_theme",
    "readthedocs-sphinx-search",
    "sphinxcontrib-mermaid>=1.0.0",
    "sphinxcontrib-tikz",
    "numpydoc",
    "pandas",
    "gitpython",
    "pylint",
]

[project.urls]
Home-page = "https://lfenergy.org/projects/power-grid-model/"
GitHub = "https://github.com/PowerGridModel/power-grid-model"
Documentation = "https://power-grid-model.readthedocs.io/en/stable/"
Mailing-list = "https://lists.lfenergy.org/g/powergridmodel"
Discussion = "https://github.com/orgs/PowerGridModel/discussions"

[project.entry-points."cmake.root"]
power_grid_model = "power_grid_model._core.power_grid_model_c"

[tool.scikit-build]
logging.level = "INFO"

cmake.version = ">=3.23"
cmake.build-type = "Release"
cmake.args = ["-GNinja"]

build-dir = "build"

search.site-packages = false

ninja.version = ">=1.10"
ninja.make-fallback = false

wheel.install-dir = "power_grid_model/_core/power_grid_model_c"
wheel.py-api = "py3"

[tool.scikit-build.metadata.version]
provider = "scikit_build_core.metadata.regex"
input = "VERSION"
regex = "^\\s*(?P<version>[^\\s]+)\\s*$"
result = "{version}"

# when build in CI, force single thread to avoid out of memory errors
[[tool.scikit-build.overrides]]
if.any.env.CIBUILDWHEEL = true
if.any.env.GITHUB_ACTIONS = true
if.any.env.READTHEDOCS = true
build.tool-args = ["-j1"]

[tool.pytest.ini_options]
testpaths = ["tests/unit"]
addopts = [
    "--cov=power_grid_model",
    "--cov-report=term",
    "--cov-report=html:python_cov_html",
    "--cov-report=xml:python_coverage.xml",
    "--cov-fail-under=95",
]
xfail_strict = true

[tool.ruff]
# Same as Black.
line-length = 120
indent-width = 4
show-fixes = true

# Assume Python 3.12
target-version = "py312"

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

[tool.ruff.lint]
select = [
    # pycodestyle
    "E",
    # Pyflakes
    "F",
    # isort
    "I",
    "SIM",
    "YTT",
    "BLE",
    "PERF",
    "Q",
    "ICN",
    "ISC",
    "G",
    "LOG",
    "EXE",
    "FA",
    "FURB",
    "FLY",
    "SLOT",
    "PL",
    "NPY",
    "W",
    "PTH",
    "TID",
    "ARG",
    "RET",
    "PIE",
    "SLF",
    "UP",
    "RSE",
    "RUF",
    "S",
    "FBT003",
    "TRY002",
    "PT",
]

ignore = [
    "PT019", # flags false positives
]

[tool.ruff.lint.isort]
# Imports that are imported using keyword "as" and are from the same source - are combined.
combine-as-imports = true

[tool.ruff.lint.per-file-ignores]
# Ignore `F811` (redefinition violations) in all examples notebooks since we use redefinition.
"docs/examples/*.ipynb" = ["F811", "E402"]
# Pylint was only run in src directory before moving to Ruff
"tests/*" = ["PLR0915", "PLR0912", "PLR0913", "S"]
# Ignore private member access: _model_ptr, _all_component_count...
"src/power_grid_model/_core/*.py" = ["SLF001"]
"tests/unit/test_error_handling.py" = ["SLF001"]

[tool.mypy]
follow_imports = "silent"
ignore_missing_imports = true
show_column_numbers = true
non_interactive = true
install_types = true

# CI build options
[tool.cibuildwheel]
build-frontend = "build[uv]"
build-verbosity = 1
test-groups = ["test"]
test-command = "pytest {package}/tests"
# we do not support 
#    PyPy
#    musllinux in aarch64
#    disable Python 3.14 for now until it is released
skip = ["pp*", "*-musllinux_aarch64"]

[tool.cibuildwheel.linux]
archs = ["x86_64", "aarch64"]
environment = { CC = "gcc", CXX = "g++" }
manylinux-x86_64-image = "manylinux_2_28"
manylinux-aarch64-image = "manylinux_2_28"
musllinux-x86_64-image = "musllinux_1_2"

[tool.cibuildwheel.macos]
archs = ["x86_64", "arm64"]
environment = { CC = "clang", CXX = "clang++", MACOSX_DEPLOYMENT_TARGET = "13.4" }

[tool.cibuildwheel.windows]
archs = ["AMD64"]