pyproject.toml

[build-system]
# Minimum requirements for the build system to execute.
requires = ["setuptools>=64", "wheel", "setuptools_scm>=8"]

build-backend = "setuptools.build_meta"

[project]
name = "pds"
authors = [
  {name = "PDS Developers"},
  {name = "Mike Sanders", email = "msanders@ignitioncomputing.com"},
  {name = "Daan van Vugt", email = "dvanvugt@ignitioncomputing.com"},
  {name = "Mireille Schneider", email = "Mireille.Schneider@iter.org"},
]
description = "Pulse Design Simulator to simulate and prepare experiments"
readme = {file = "README.md", content-type = "text/markdown"}
requires-python = ">=3.11"
license = {file = "LICENSE.md"}
classifiers = [
    "Development Status :: 3 - Alpha",
    "Environment :: Console",
    "Environment :: Plugins",
    "Framework :: Pytest",
    "Framework :: Sphinx",
# Custom trove classifiers are not allowed, and newer versions of python setuptools will fail to build
# when classifiers other than those listed on: https://pypi.org/classifiers/ are included
#    "Framework :: IMAS",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Intended Audience :: System Administrators",
    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
    "Natural Language :: English",
    "Operating System :: POSIX",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Unix Shell",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Software Development :: Libraries",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: System",
    "Topic :: System :: Software Distribution",
    "Topic :: Utilities",
]
dynamic = ["version"]
dependencies = [
    "packaging",
    "imas-python",
    "muscle3",
]

[project.optional-dependencies]
# these self-dependencies are available since pip 21.2
all = [
    "pds[docs,test,linting,visualization]"
]
docs = [
    "sphinx>=7.0.0,<9.0.0",
    "sphinx_immaterial>=0.13.0,<0.14",
    # Lets the workflow READMEs be included into the docs as-is, so they cannot
    # drift from a hand-written paraphrase.
    "myst-parser>=2.0",
    # Grid and card directives, used by the case gallery.
    "sphinx-design>=0.5",
    # conf.py's coupling-diagram directive renders the workflow ymmsl files as SVG,
    # so the diagrams cannot drift from the couplings they document.
    "ymmsl2svg @ git+https://github.com/multiscale/ymmsl2svg.git@efba05b798889dbe863c3e4e201b2fe3a5196b70",
]
test = [
    "pytest>=5.4.1",
    "pytest-cov>=0.6",
    "pytest-xdist",
    "pytest-randomly",
]
linting = [
    "ruff",
    "ty",
]
# Used by the standalone scripts under visualization/, not by the pds package itself.
visualization = [
    "holoviews",
    "panel",
    "param",
    "imas_muscle3 @ git+https://github.com/iterorganization/IMAS-MUSCLE3.git@develop",
]

[project.urls]
homepage = "https://github.com/iterorganization/IMAS-PDS"
repository = "https://github.com/iterorganization/IMAS-PDS"

[tool.setuptools.packages.find]
where = ["."]
include = ["pds*"]

[tool.setuptools_scm]

[tool.pytest.ini_options]
minversion = "6.0"
addopts = "--strict-markers"
testpaths = "tests"

[tool.ruff]
line-length = 88

[tool.ruff.lint]
select = [
    # pycodestyle
    "E",
    # Pyflakes
    "F",
    # pyupgrade
    "UP",
    # flake8-bugbear
    "B",
    # flake8-simplify
    "SIM",
    # isort
    "I",
    # flake8-comprehensions
    "C4",
    # flake8-logging
    "LOG",
    # flake8-logging-format
    "G",
    # flake8-tidy-imports
    "TID",
    # flake8-use-pathlib
    "PTH",
    # Refurb
    "FURB",
    # Ruff specific rules
    "RUF",
]
ignore = [
    "E701",
    "E501",
]

[tool.ruff.lint.per-file-ignores]
"pds_validation_tests/**" = ["F821"]
"visualization/*.py" = ["BLE001"]
"workflows/torax_nice_utils/plot_validation.py" = ["BLE001"]

[[tool.ty.overrides]]
include = ["pds_validation_tests/**"]
[tool.ty.overrides.rules]
unresolved-reference = "ignore"

[[tool.ty.overrides]]
include = ["visualization/*.py"]
[tool.ty.overrides.rules]
unresolved-attribute = "ignore"