pyproject.toml

[build-system]
requires = ["setuptools>=63.0"]
build-backend = "setuptools.build_meta"

[project]
name = "ema_workbench"
authors = [
  { name="Jan Kwakkel", email="j.h.kwakkel@tudelft.nl" },
]
description = "Exploratory modelling in Python"
readme = "README.md"
license = { file="LICENSE.md" }
requires-python = ">=3.12"
classifiers=[
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
]
dependencies = [
    "numpy",
    "pandas",
    "scikit-learn",
    "salib>=1.4.6",
    "platypus-opt>=1.3.0",
    "matplotlib",
    "statsmodels",
    "seaborn",
    "tqdm",
]
dynamic = ["version"] # Version is read from ema_workbench/__init__.py

[project.optional-dependencies]
recommended = ["ema_workbench[jupyter,dev,graph]"]
all = ["ema_workbench[jupyter,dev,cov,docs,graph,parallel]"]

jupyter = ["jupyter", "jupyter_client", "ipython", "ipykernel"]
dev = ["pytest", "pytest-mock", "jupyter_client", "ipyparallel", "ruff"]
cov = ["pytest-cov", "coverage", "coveralls"]
docs = ["sphinx", "sphinx-rtd-theme", "readthedocs-sphinx-search", "nbsphinx", "myst", "pyscaffold", "myst-parser"]
graph = ["altair", "pydot", "graphviz"]
parallel = ["ipyparallel", "traitlets"]

netlogo = ["jpype-1", "pynetlogo"]  # Needs Windows as OS
pysd = ["pysd"]
simio = ["pythonnet"]  # Needs Windows as OS

[project.urls]
"Homepage" = "https://github.com/quaquel/EMAworkbench"
"Documentation" = "https://emaworkbench.readthedocs.io/"
"Bug Tracker" = "https://github.com/quaquel/EMAworkbench/issues"

[tool.ruff]
# See https://github.com/charliermarsh/ruff#rules for error code definitions.
# Hardcode to Python 3.11.
exclude = [
    ".eggs",
    ".git",
    ".github",
    ".idea",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".tox",
    ".venv",
    "__pypackages__",
    "venv",
    "docs",
    "test",
    "build",
]

target-version = "py312"

[tool.ruff.lint]
select = [
  # "ANN", # annotations TODO
  "B",   # bugbear
  "C4",  # comprehensions
  "DTZ", # naive datetime
  "E",   # style errors
  "F",   # flakes
  "I",   # import sorting
  "ISC", # string concatenation
  "N",   # naming
  "PGH", # pygrep-hooks
  "PIE", # miscellaneous
  "PLC", # pylint convention
  "PLE", # pylint error
  # "PLR", # pylint refactor TODO
  "PLW", # pylint warning
  "Q",   # quotes
  "RUF", # Ruff
  "S",   # security
  "SIM", # simplify
  "T10", # debugger
  "UP",  # upgrade
  "W",   # style warnings
  "YTT", # sys.version
  "D",  # docstring
]
# Ignore list taken from https://github.com/psf/black/blob/master/.flake8

extend-ignore = [
  "E501",
  "S101",   # Use of `assert` detected
  "B017",   # `assertRaises(Exception)` should be considered evil TODO
  "PGH004", # Use specific rule codes when using `noqa` TODO
  "B905",   # `zip()` without an explicit `strict=` parameter
  "N802",   # Function name should be lowercase
  "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar` TODO
  "S310",   # Audit URL open for permitted schemes. Allowing use of `file:` or custom schemes is often unexpected.
  "S603",   # `subprocess` call: check for execution of untrusted input
  "ISC001", # ruff format asks to disable this feature
  "S311",   # Standard pseudo-random generators are not suitable for cryptographic purposes
  "SIM105", # I prefer explicit try, pass over contextlib in most cases for readability
  "D401",   # Too restrictive on how docstrings are written
]

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

[tool.setuptools.dynamic]
version = {attr = "ema_workbench.__version__"}

[tool.setuptools.package-data]
"ema_workbench.examples.data" = ["**"]
"ema_workbench.examples.models" = ["**"]