-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathpyproject.toml
118 lines (105 loc) · 3.92 KB
/
pyproject.toml
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
[build-system]
requires = ["setuptools>=61.0.0", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
[project]
name = "flixopt"
dynamic = ["version"]
description = "Vector based energy and material flow optimization framework in Python."
readme = "README.md"
requires-python = ">=3.10, <3.13"
license = { text = "MIT License" }
authors = [
{ name = "Chair of Building Energy Systems and Heat Supply, TU Dresden", email = "[email protected]" },
{ name = "Felix Bumann", email = "[email protected]" },
{ name = "Felix Panitz", email = "[email protected]" },
{ name = "Peter Stange", email = "[email protected]" }
]
maintainers = [
{ name = "Felix Bumann", email = "[email protected]" },
{ name = "Peter Stange", email = "[email protected]" }
]
keywords = ["optimization", "energy systems", "numerical analysis"]
classifiers = [
"Development Status :: 3 - Alpha",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering",
"License :: OSI Approved :: MIT License",
]
dependencies = [
"numpy >= 1.21.5, < 2",
"PyYAML >= 6.0",
"Pyomo >= 6.4.2",
"rich >= 13.0.1",
"highspy >= 1.5.3", # Default solver
"pandas >= 2, < 3", # Used in post-processing
"matplotlib >= 3.5.2", # Used in post-processing
"plotly >= 5.15", # Used in post-processing
"tomli >= 2.0.1" # TOML parser (only needed until python 3.11)
]
[project.optional-dependencies]
dev = [
"pytest",
"ruff",
"pyvis == 0.3.1", # Used for visualizing the FLowSystem
"tsam >= 2.3.1", # Used for time series aggregation
]
full = [
"pyvis == 0.3.1", # Used for visualizing the FLowSystem
"tsam >= 2.3.1", # Used for time series aggregation
]
docs = [
"mkdocs-material>=9.0.0",
"mkdocstrings-python",
"mkdocs-table-reader-plugin",
"mkdocs-gen-files",
"mkdocs-include-markdown-plugin",
"mkdocs-literate-nav",
"markdown-include",
"pymdown-extensions",
"pygments"
]
[project.urls]
homepage = "https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt"
repository = "https://github.com/flixOpt/flixopt"
documentation = "https://flixopt.github.io/flixopt/"
[tool.setuptools.packages.find]
where = ["."]
exclude = ["tests", "docs", "examples", "examples.*", "Tutorials", ".git", ".vscode", "build", ".venv", "venv/"]
[tool.setuptools.package-data]
"flixOpt" = ["config.yaml"]
[tool.setuptools_scm]
version_scheme = "post-release"
[tool.ruff]
# Files or directories to exclude (e.g., virtual environments, cache, build artifacts)
exclude = [
"venv", # Virtual environments
"build", # Build artifacts
"dist", # Distribution files
"__pycache__", # Bytecode cache
".git", # Git folder
".mypy_cache", # MyPy cache
]
line-length = 120
[tool.ruff.lint]
select = ["E", "F", "W", "I", "B", "N"] # Enable linting rules by category (e.g., error, warnings, unused imports)
ignore = [ # Ignore specific rules
"E501", # Ignore line-length checks (use Black for formatting)
"F401", # Allow unused imports in some cases (use __all__)
"N813", # Allow importing of flixOpt as fx (lowercase)
"N999", # Allow module Name flixOpt
]
extend-fixable = ["B"] # Enable fix for flake8-bugbear (`B`), on top of any rules specified by `fixable`.
# Apply rule exceptions to specific files or directories
[tool.ruff.lint.per-file-ignores]
"tests/*.py" = ["S101"] # Ignore assertions in test files
"tests/test_integration.py" = ["N806"] # Ignore NOT lowercase names in test files
"flixOpt/linear_converters.py" = ["N803"] # Parameters with NOT lowercase names
[tool.ruff.format]
quote-style = "single"
indent-style = "space"
docstring-code-format = true