pyproject.toml

[project]
name = "pleque"
version = "0.0.9"
description = "PLEQUE is a Python module allowing simple visualisation and manipulation of tokamak plasma equilibria."
authors = [{ name = "Lukáš Kripner", email = "kripner@ipp.cas.cz" }]
license = "MIT"
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
    "h5py>=3.8.0,<4",
    "matplotlib>=3.7.1,<4",
    "netcdf4>=1.6.3,<2",
    "numpy>=1.24,<2.3",
    "pydantic>=2.13.4,<3",
    "pydantic-settings[toml]>=2.10.1,<3",
    "scikit-image>0.20.0,<0.26",
    "shapely>=2.0.1,<3",
    "scipy>=1.10,<1.16",
    "setuptools>=67,<82",
    "xarray>=2023.3.0",
]

[project.urls]
Repository = "https://github.com/kripnerl/pleque"
Documentation = "https://github.com/kripnerl/pleque"

[dependency-groups]
dev = [
    "cython>=3.0.11,<4",
    "ipykernel>=7,<8",
    "ipython>=7.34.0,<8",
    "jupyter>=1.1.1,<2",
    "nbsphinx-link>=1.3.0,<2",
    "pytest>=7.2.2,<8",
    "pytest-cov>=4,<5",
    "ruff>=0.15,<0.16",
    "ty>=0.0.1",
]
compass = [
    "decorator>=5.1.1,<6",
    "pycdb-compass @ git+https://repo.tok.ipp.cas.cz/compass-tokamak/CDB.git",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.ruff]
line-length = 120
target-version = "py310"

[tool.ruff.lint]
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort
    "B",   # flake8-bugbear
    "UP",  # pyupgrade
    "RUF", # ruff-specific rules
]
ignore = [
    "E501",  # line too long - handled by formatter; long docstrings are exempt
    "B905",  # zip() without explicit strict= - caller intent is clear in physics code
    "UP028", # yield-in-for-loop - readability preference
]

[tool.ruff.lint.per-file-ignores]
"pleque/core/__init__.py" = ["F401", "I001"] # import order is load-order-dependent due to circular imports
"pleque/io/__init__.py" = ["F401"]           # public API re-exports (read_geqdsk, write_geqdsk, ...)
"pleque/io/jet/__init__.py" = ["F401"]
"pleque/__init__.py" = ["F401", "F403"]
"tests/**/*.py" = ["F841"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"

[tool.ty.environment]
# Ty is advisory because the legacy codebase is largely unannotated.
python-version = "3.10"