pyproject.toml

[build-system]
requires = [
    "setuptools>=61.0.0",
    "setuptools-scm>=8.0",
]
build-backend = "setuptools.build_meta"

[project]
name = 'pySSMF'
description = 'A Python package to solve the Slave-Spin Mean-Field equations for tight-binding models in strongly correlated systems'
authors = [
    { name = "Jose M. Pizarro", email = "jose.pizarro@physik.hu-berlin.de" }
]
maintainers = [
    { name = "Jose M. Pizarro", email = "jose.pizarro@physik.hu-berlin.de" }
]
dynamic = ["version"]
license = { file = "LICENSE" }
requires-python = ">=3.9"
readme = "README.md"
dependencies = [
    "nomad-lab~=1.2.0",
    "pandas<2.0.0",
    "h5py~=3.11.0",
]

[project.urls]
"Homepage" = "https://github.com/JosePizarro3/pySSMF"
"Bug Tracker" = "https://github.com/JosePizarro3/pySSMF/issues"
"Documentation" = "https://josepizarro3.github.io/pySSMF/"

[project.optional-dependencies]
dev = [
    'mypy==1.5.1',
    'pytest',
    'pytest-timeout',
    'pytest-cov',
    'ruff',
    "structlog==22.3.0",
    "lxml_html_clean>=0.1.0",
]

[tool.ruff]
include = ["src/pyssmf/*.py", "tests/*.py"]
lint.select = [
    "E", # pycodestyle
    "W", # pycodestyle
    "PL", # pylint
]
lint.ignore = [
    "E501", # Line too long ({width} > {limit} characters)
    "E701", # Multiple statements on one line (colon)
    "E731", # Do not assign a lambda expression, use a def
    "E402",  # Module level import not at top of file
    "PLR0911", # Too many return statements
    "PLR0912", # Too many branches
    "PLR0913", # Too many arguments in function definition
    "PLR0915", # Too many statements
    "PLR2004", # Magic value used instead of constant
    "PLW0603", # Using the global statement
    "PLW2901", # redefined-loop-name
    "PLR1714", # consider-using-in
    "PLR5501", # else-if-used
]
lint.fixable = ["ALL"]

# Same as Black.
line-length = 88
indent-width = 4

[tool.ruff.format]
# use single quotes for strings.
quote-style = "single"

# indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

[tool.setuptools.packages.find]
where = ["src"]