pyproject.toml

[build-system]
requires = ["hatchling>=1.29.0", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "mcerp"
dynamic = ["version"]
description = "Real-time latin-hypercube-sampling-based Monte Carlo Error Propagation for Python"
authors = [
    { name = "Abraham Lee", email = "tisimst@gmail.com" },
]
maintainers = [
    { name = "Saud Zahir", email = "m.saud.zahir@gmail.com" },
    { name = "M Laraib Ali", email = "laraibg786@outlook.com" }
]
readme = "README.md"
license = "BSD-3-Clause"

keywords = [
    "monte carlo",
    "latin hypercube",
    "sampling calculator",
    "error propagation",
    "uncertainty",
    "risk analysis",
    "error",
    "real-time",
]

classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Education",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Developers",
    "Intended Audience :: Customer Service",
    "Intended Audience :: Financial and Insurance Industry",
    "Intended Audience :: Healthcare Industry",
    "Intended Audience :: Manufacturing",
    "License :: OSI Approved :: BSD License",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: 3 :: Only",
    "Topic :: Education",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Software Development",
    "Topic :: Software Development :: Libraries",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Utilities",
    "Operating System :: OS Independent",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: POSIX",
    "Operating System :: Unix",
    "Operating System :: MacOS",
]

dependencies = [
    "numpy",
    "scipy"
]

requires-python = ">=3.10"

[project.urls]
homepage = "https://eggzec.github.io/mcerp/"
documentation = "https://eggzec.github.io/mcerp/"
source = "https://github.com/eggzec/mcerp"
releasenotes = "https://github.com/eggzec/mcerp/releases/latest"
issues = "https://github.com/eggzec/mcerp/issues"

[dependency-groups]
dev = [
  {include-group = "docs"},
  {include-group = "lint"},
  {include-group = "test"}
]
docs = [
    "zensical>=0.0.23"
]
lint = [
    "ruff>=0.15,<0.17",
]
test = [
    "pytest>=8.3.5",
    "pytest-cov>=7.0.0",
    "pytest-xdist>=3.6.1",
]

[project.optional-dependencies]
plot = [
    "matplotlib"
]
all = [
    "matplotlib"
]

[tool.hatch.version]
source = "vcs"

[tool.hatch.build.targets.wheel]
include = [
  "/mcerp"
]

[tool.ruff]
line-length = 80
indent-width = 4
preview = true

# Output serialization format for violations. The default serialization
# format is "full" [env: RUFF_OUTPUT_FORMAT=] [possible values:
# concise, full, json, json-lines, junit, grouped, github, gitlab,
# pylint, rdjson, azure, sarif]
output-format = "grouped"

[tool.ruff.lint]
isort.lines-after-imports = 2
isort.split-on-trailing-comma = false

select = [
    "ANN", # flake8-annotations (required strict type annotations for public functions)
    "S",   # flake8-bandit (checks basic security issues in code)
    "BLE", # flake8-blind-except (checks the except blocks that do not specify exception)
    "FBT", # flake8-boolean-trap (ensure that boolean args can be used with kw only)
    "E",   # pycodestyle errors (PEP 8 style guide violations)
    "W",   # pycodestyle warnings (e.g., extra spaces, indentation issues)
    "DOC", # pydoclint issues (e.g., extra or missing return, yield, warnings)
    "A",   # flake8-buitins (check variable and function names to not shadow builtins)
    "N",   # Naming convention checks (e.g., PEP 8 variable and function names)
    "F",   # Pyflakes errors (e.g., unused imports, undefined variables)
    "I",   # isort (Ensures imports are sorted properly)
    "B",   # flake8-bugbear (Detects likely bugs and bad practices)
    "TID", # flake8-tidy-imports (Checks for banned or misplaced imports)
    "UP",  # pyupgrade (Automatically updates old Python syntax)
    "YTT", # flake8-2020 (Detects outdated Python 2/3 compatibility issues)
    "FLY", # flynt (Converts old-style string formatting to f-strings)
    "PIE", # flake8-pie
    "PL",  # pylint
    "RUF", # Ruff-specific rules (Additional optimizations and best practices)
]

ignore = [
    "invalid-argument-name",      # [pep8-naming](https://docs.astral.sh/ruff/rules/invalid-argument-name/)
    "non-lowercase-variable-in-function",      # [pep8-naming](https://docs.astral.sh/ruff/rules/non-lowercase-variable-in-function/)
    "magic-value-comparison",   # [pylint](https://docs.astral.sh/ruff/rules/magic-value-comparison/)
    "suspicious-non-cryptographic-random-usage",      # [flake8-bandit](https://docs.astral.sh/ruff/rules/suspicious-non-cryptographic-random-usage/)
]


# Ignore strict naming rules for mcerp scientific code, but keep them for other modules.
[tool.ruff.lint.per-file-ignores]
"tests/*.py" = [
    "missing-type-function-argument",     # [flake8-annotations](https://docs.astral.sh/ruff/rules/missing-type-function-argument/)
    "missing-return-type-undocumented-public-function",     # [flake8-annotations](https://docs.astral.sh/ruff/rules/missing-return-type-undocumented-public-function/)
    "missing-return-type-private-function",     # [flake8-annotations](https://docs.astral.sh/ruff/rules/missing-return-type-private-function/)
    "assert",       # [flake8-bandit](https://docs.astral.sh/ruff/rules/assert/)
    "no-self-use",    # [pylint](https://docs.astral.sh/ruff/rules/no-self-use/)
]

[tool.ruff.format]
docstring-code-format = true
skip-magic-trailing-comma = true

[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py"]