physXAI/pyproject.toml at main · RWTH-EBC/physXAI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
[build-system]
requires = ["setuptools>=80.9", "setuptools-scm>=8.3"]
build-backend = "setuptools.build_meta"

[project]
name = "physXAI"
authors = [
    { name = "Patrick Henkel", email = "ebc-tools@eonerc.rwth-aachen.de" }
]
description = "Framework for development and execution of physics-guided machine learning for application in Model Predictive Control (MPC) of Building Energy Systems (BES)"
readme = "README.md"
requires-python = ">=3.11"
keywords = [
    "physics-guided", "physics-informed", "machine-learning", "mpc", "model-predictive-control", "building-energy-systems",
]
license = { text = "BSD-3-Clause" }
classifiers = [
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: BSD License",
    "Programming Language :: Python :: 3",
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Programming Language :: Python :: 3.13',
]
dependencies = [
    "numpy>=2.0",
    "pandas>=2.2.3",
    "scikit-learn>=1.6.1",
    "keras>=3.15.0",  # older versions have known vulnerabilities in loading models
    "tensorflow>=2.19.0",
    "GitPython>=3.2.1",
    "pydantic>=2.11.4",
    "plotly>=6.0.1",
]

dynamic = ["version"]

[project.optional-dependencies]
dev = [
    "pytest>=8.4.1",
    "pytest-cov>=6.2.1",
    "anybadge>=1.16.0"
]
gh-pages = [
    "mkdocs-material>=9.6.15",
    "mkdocstrings[python]>=0.30.0",
]

[project.urls]
homepage = "https://github.com/RWTH-EBC/physXAI"
repository = "https://github.com/RWTH-EBC/physXAI"
documentation = "https://github.com/RWTH-EBC/physXAI/blob/main/README.md"
"Bug Tracker" = "https://github.com/RWTH-EBC/physXAI/issues"

[tool.setuptools.packages.find]
where = ["."]
include = ["physXAI*"]
exclude = ["unittests*", "executables*", "data*", "build*", "docs*"]

[tool.setuptools_scm]
write_to = "physXAI/_version.py"

[tool.pytest.ini_options]
cache_dir = "build/.pytest_cache"

[tool.coverage.run]
source = ["physXAI/"]
data_file = "build/.coverage"
branch = true
omit = [
    "conftest.py",
    "unittests/*",
    "*/__init__.py",
    "executables/*"
]

[tool.coverage.report]
show_missing = true
exclude_lines = [
    "pragma: no cover",
    "raise NotImplementedError",
    "@abstractmethod",
    "if Logger._logger is None:",
    "Logger.setup_logger()"
]

[tool.coverage.xml]
output = "build/reports/coverage.xml"

[tool.coverage.html]
directory = "build/reports/coverage_html"