pyproject.toml

[build-system]
requires = [
    "scikit-build-core>=1.1",
    # Stubs are generated during the build, see python_bindings_jupedsim/CMakeLists.txt
    "pybind11-stubgen>=3.0,<4",
    # pybind11-stubgen imports shapely to resolve the shapely.Polygon annotation
    "shapely>=2.0",
    # pybind11-stubgen imports the jupedsim package, which imports the HDF5 writer
    "h5py~=3.11",
    "hdf5plugin~=7.0",
]
build-backend = "scikit_build_core.build"

[project]
name = "jupedsim"
dynamic = ["version"]
description = "JuPedSim is an open source pedestrian dynamics simulator"
readme = "pypi-readme.md"
license = "LGPL-3.0-or-later"
license-files = ["LICENSE"]
maintainers = [
    { name = "JuPedSim Development Core Team", email = "dev@jupedsim.org" },
]
requires-python = ">=3.12,<3.15"
dependencies = [
    "numpy~=2.2",
    "shapely~=2.0",
    "h5py~=3.11",
    "hdf5plugin~=7.0",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: Unix",
    "Operating System :: MacOS",
    "Natural Language :: English",
    "Programming Language :: C++",
    "Programming Language :: C",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
]

[project.urls]
Homepage = "https://www.jupedsim.org"
Documentation = "https://www.jupedsim.org"
Source = "https://github.com/PedestrianDynamics/jupedsim"
Tracker = "https://github.com/PedestrianDynamics/jupedsim/issues"

[tool.scikit-build]
minimum-version = "build-system.requires"
cmake.version = ">=3.22"
cmake.build-type = "Release"
wheel.packages = { jupedsim = "python_modules/jupedsim/jupedsim" }
install.components = ["python"]
sdist.inclusion-mode = "explicit"
sdist.include = [
    "/CMakeLists.txt",
    "/pyproject.toml",
    "/README.md",
    "/pypi-readme.md",
    "/LICENSE",
    "/cmake_modules/",
    "/cmake_templates/",
    "/libcommon/",
    "/libfloorfield/",
    "/libsimulator/",
    "/python_bindings_jupedsim/",
    "/python_modules/jupedsim/",
    "/third-party/",
]
sdist.exclude = [
    "/libfloorfield/target/",
    "/python_modules/jupedsim/tests/",
    "__pycache__/",
    ".git",
    "*.pdf",
    "*.html",
    "*.off",
    "*.png",
    "*.dat",
    "*.bff",
    "/third-party/**/examples/",
    "/third-party/**/doc/",
    "/third-party/**/test/",
    "/third-party/**/benchmark/",
    "/third-party/**/demo/",
    "/third-party/**/Data/data/",
    "/third-party/**/Documentation/",
    "/third-party/**/tests/",
    "/third-party/**/docs/",
    "/third-party/**/Maintenance/",
    "/third-party/**/.github/",
    "/third-party/**/testbed/",
    "/third-party/**/unittest/",
]
messages.after-failure = """
Building JuPedSim from source failed. The output above names the missing
prerequisite and how to install it. If you only want to use JuPedSim, install
a prebuilt wheel instead:
    pip install --only-binary=jupedsim jupedsim
Building from source: https://github.com/PedestrianDynamics/jupedsim#building-from-source
"""

[[tool.dynamic-metadata]]
provider = "scikit_build_core.metadata.regex"
field = "version"
input = "CMakeLists.txt"
regex = 'project\(JuPedSim\s+VERSION\s+(?P<value>[0-9]+\.[0-9]+\.[0-9]+)'

[tool.pytest.ini_options]
addopts = "--import-mode=importlib"

[tool.ruff]
extend-exclude = ["third-party", "jupedsim.org/docs"]
line-length = 80
indent-width = 4
target-version = "py312"
extend-include = ["*.ipynb"]

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
# select = ["E4", "E7", "E9", "F"]
select = [
    "E", # pycodestyle
    "F", # Pyflakes
    "I", # isort
    "N", # Naming conventions for variables, functions, and attributes
]
ignore = ["E501"]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

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

[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, 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"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = false

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"

# Ignore naming issues for camelCase deprecated properties
[tool.ruff.lint.pep8-naming]
extend-ignore-names = ["desiredSpeed", "reactionTime", "agentScale", "obstacleScale", "forceDistance", "bodyForce", "IncorrectTrajectory", "IncorrectTrajectoryError"]

[tool.ruff.lint.per-file-ignores]
"test_perftests.py" = ["N"]
"**{jupedsim_vis}/*" = ["N"]
"serialization.py" = ["N"]
"journey.ipynb" = ["N"]

[tool.basedpyright]
typeCheckingMode = "basic"
# Oldest supported Python (requires-python), so newer-only APIs are flagged
pythonVersion = "3.12"