pyproject.toml

[build-system]
requires = ["setuptools>=63.4.2", "setuptools_scm[toml]>=7.1.0"]
build-backend = "setuptools.build_meta"

[project]
name = "iterative_ensemble_smoother"
description="A library for the iterative ensemble smoother algorithm."
requires-python = ">=3.12, <3.15"
readme = "README.md"
classifiers=[
    "Development Status :: 1 - Planning",
    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
]
dependencies = ["numpy", "scipy", "joblib", "networkx", "scikit-learn"]
dynamic=["version"] # setuptools_scm extracts Python package versions from git

authors = [
    {name="Equinor", email="fg_sib-scout@equinor.com"},
]

maintainers = [
    {name="Eivind Jahren", email="ejah@equinor.com"},
    {name="Feda Curic", email="fcur@equinor.com"},
]

[project.license]
text = "GPL-3.0"

[project.urls]
"Homepage" = "https://github.com/equinor/iterative_ensemble_smoother"
"Repository" = "https://github.com/equinor/iterative_ensemble_smoother"
"Bug Tracker" = "https://github.com/equinor/iterative_ensemble_smoother/issues"
"Documentation" = "https://iterative_ensemble_smoother.readthedocs.io/en/stable/"

[project.optional-dependencies]
doc = [
    "sphinx",
    "setuptools",
    "docutils",
    "pydata_sphinx_theme",
    "jupyter_sphinx",
    "nbconvert>=7.17.1",
    "sphinxcontrib.bibtex",
    "matplotlib",
    "pygments",
    "jupytext",
    "pandas",
    "p_tqdm",
    "ipykernel",
    "ipywidgets",
    "numpydoc",
    "scipy",
    "jinja2",
    "myst_nb",
    "lxml_html_clean"
]
dev = [
    "pytest",
    "pytest-snapshot",
    "pytest-memray",
    "tox",
    "pre-commit",
    "matplotlib",
    "scipy",
    "mypy",
    "pandas",
    "p_tqdm",
    "pylint",
    "gaussianfft"
]
# 'scikit-sparse' version and SuiteSparse must match (depends on Ubuntu)
sparse = ["scikit-sparse==0.4.16"]
# setuptools_scm also writes the version to a file so that one can use the
# __version__ attribute from the package
[tool.setuptools_scm]
write_to = "src/iterative_ensemble_smoother/_version.py"

[tool.pytest.ini_options]
testpaths = [
    "tests"
]
markers = [
    "suitesparse: marks tests that require libsuitesparse to be installed",
]


[tool.ruff]
src = ["src", "tests", "docs"]
line-length = 88

[tool.ruff.lint]
select = [
    "A",
    "AIR",
    "ASYNC",
    "BLE",
    "DJ",
    "E",
    "EXE",
    "F",
    "FA",
    "FAST",
    "FLY",
    "FURB",
    "G",
    "I",
    "ICN",
    "INT",
    "ISC",
    "LOG",
    "NPY",
    "PD",
    "PERF",
    "PIE",
    "PLC",
    "PLE",
    "PLW",
    "PT",
    "PTH",
    "PYI",
    "Q",
    "RET",
    "RSE",
    "SIM",
    "SLF",
    "SLOT",
    "T",
    "TC",
    "TID",
    "UP",
    "W",
    "YTT",
]
ignore = [
    "G004",  # Logging statement uses f-string
]
preview = true

# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.lint.per-file-ignores]
"tests/**" = ["T"]
"docs/**" = ["T"]

[tool.ruff.lint.mccabe]
# Unlike Flake8, default to a complexity level of 10.
max-complexity = 10

[tool.uv]
fork-strategy = "requires-python"
exclude-newer = "7 days"

[tool.codespell]
skip = "*.pyc,*.gif,*.png,*.jpg,*.ply, ./bibliography.bib,*.ipynb"
ignore-words-list = "lod,byteorder,flem,parm,doubleclick,revered,inout,fro,nd,sies,hist,ans"
quiet-level = 3