flixopt 3.0.1__py3-none-any.whl → 3.0.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of flixopt might be problematic. Click here for more details.
- flixopt-3.0.2.dist-info/METADATA +272 -0
- {flixopt-3.0.1.dist-info → flixopt-3.0.2.dist-info}/RECORD +5 -5
- flixopt-3.0.1.dist-info/METADATA +0 -209
- {flixopt-3.0.1.dist-info → flixopt-3.0.2.dist-info}/WHEEL +0 -0
- {flixopt-3.0.1.dist-info → flixopt-3.0.2.dist-info}/licenses/LICENSE +0 -0
- {flixopt-3.0.1.dist-info → flixopt-3.0.2.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: flixopt
|
|
3
|
+
Version: 3.0.2
|
|
4
|
+
Summary: Vector based energy and material flow optimization framework in Python.
|
|
5
|
+
Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
|
|
6
|
+
Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>
|
|
7
|
+
License-Expression: MIT
|
|
8
|
+
Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
|
|
9
|
+
Project-URL: repository, https://github.com/flixOpt/flixopt
|
|
10
|
+
Project-URL: documentation, https://flixopt.github.io/flixopt/
|
|
11
|
+
Keywords: optimization,energy systems,numerical analysis
|
|
12
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Intended Audience :: Science/Research
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: numpy<3,>=1.21.5
|
|
24
|
+
Requires-Dist: pandas<3,>=2.0.0
|
|
25
|
+
Requires-Dist: xarray<2026.0,>=2024.2.0
|
|
26
|
+
Requires-Dist: linopy<0.6,>=0.5.1
|
|
27
|
+
Requires-Dist: h5netcdf<2,>=1.0.0
|
|
28
|
+
Requires-Dist: pyyaml<7,>=6.0.0
|
|
29
|
+
Requires-Dist: rich<15,>=13.0.0
|
|
30
|
+
Requires-Dist: tomli<3,>=2.0.1; python_version < "3.11"
|
|
31
|
+
Requires-Dist: highspy<2,>=1.5.3
|
|
32
|
+
Requires-Dist: matplotlib<4,>=3.5.2
|
|
33
|
+
Requires-Dist: plotly<7,>=5.15.0
|
|
34
|
+
Requires-Dist: numexpr<2.14,>=2.8.4; python_version < "3.11"
|
|
35
|
+
Provides-Extra: network-viz
|
|
36
|
+
Requires-Dist: dash<4,>=3.0.0; extra == "network-viz"
|
|
37
|
+
Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "network-viz"
|
|
38
|
+
Requires-Dist: dash-daq<1,>=0.6.0; extra == "network-viz"
|
|
39
|
+
Requires-Dist: networkx<4,>=3.0.0; extra == "network-viz"
|
|
40
|
+
Requires-Dist: werkzeug<4,>=3.0.0; extra == "network-viz"
|
|
41
|
+
Requires-Dist: flask<4,>=3.0.0; extra == "network-viz"
|
|
42
|
+
Provides-Extra: full
|
|
43
|
+
Requires-Dist: pyvis==0.3.2; extra == "full"
|
|
44
|
+
Requires-Dist: tsam<3,>=2.3.1; extra == "full"
|
|
45
|
+
Requires-Dist: scipy<2,>=1.15.1; extra == "full"
|
|
46
|
+
Requires-Dist: gurobipy<13,>=10.0.0; extra == "full"
|
|
47
|
+
Requires-Dist: dash<4,>=3.0.0; extra == "full"
|
|
48
|
+
Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "full"
|
|
49
|
+
Requires-Dist: dash-daq<1,>=0.6.0; extra == "full"
|
|
50
|
+
Requires-Dist: networkx<4,>=3.0.0; extra == "full"
|
|
51
|
+
Requires-Dist: werkzeug<4,>=3.0.0; extra == "full"
|
|
52
|
+
Requires-Dist: flask<4,>=3.0.0; extra == "full"
|
|
53
|
+
Provides-Extra: dev
|
|
54
|
+
Requires-Dist: pytest==8.4.2; extra == "dev"
|
|
55
|
+
Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
|
|
56
|
+
Requires-Dist: nbformat==5.10.4; extra == "dev"
|
|
57
|
+
Requires-Dist: ruff==0.13.3; extra == "dev"
|
|
58
|
+
Requires-Dist: pre-commit==4.3.0; extra == "dev"
|
|
59
|
+
Requires-Dist: pyvis==0.3.2; extra == "dev"
|
|
60
|
+
Requires-Dist: tsam==2.3.9; extra == "dev"
|
|
61
|
+
Requires-Dist: scipy==1.15.1; extra == "dev"
|
|
62
|
+
Requires-Dist: gurobipy==12.0.3; extra == "dev"
|
|
63
|
+
Requires-Dist: dash==3.0.0; extra == "dev"
|
|
64
|
+
Requires-Dist: dash-cytoscape==1.0.2; extra == "dev"
|
|
65
|
+
Requires-Dist: dash-daq==0.6.0; extra == "dev"
|
|
66
|
+
Requires-Dist: networkx==3.0.0; extra == "dev"
|
|
67
|
+
Requires-Dist: werkzeug==3.0.0; extra == "dev"
|
|
68
|
+
Provides-Extra: docs
|
|
69
|
+
Requires-Dist: mkdocs-material==9.6.21; extra == "docs"
|
|
70
|
+
Requires-Dist: mkdocstrings-python==1.18.2; extra == "docs"
|
|
71
|
+
Requires-Dist: mkdocs-table-reader-plugin==3.1.0; extra == "docs"
|
|
72
|
+
Requires-Dist: mkdocs-gen-files==0.5.0; extra == "docs"
|
|
73
|
+
Requires-Dist: mkdocs-include-markdown-plugin==7.1.7; extra == "docs"
|
|
74
|
+
Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "docs"
|
|
75
|
+
Requires-Dist: markdown-include==0.8.1; extra == "docs"
|
|
76
|
+
Requires-Dist: pymdown-extensions==10.16.1; extra == "docs"
|
|
77
|
+
Requires-Dist: pygments==2.19.2; extra == "docs"
|
|
78
|
+
Requires-Dist: mike==2.1.3; extra == "docs"
|
|
79
|
+
Dynamic: license-file
|
|
80
|
+
|
|
81
|
+
# FlixOpt: Energy and Material Flow Optimization Framework
|
|
82
|
+
|
|
83
|
+
[](https://flixopt.github.io/flixopt/latest/)
|
|
84
|
+
[](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
|
|
85
|
+
[](https://pypi.org/project/flixopt/)
|
|
86
|
+
[](https://pypi.org/project/flixopt/)
|
|
87
|
+
[](https://pypi.org/project/flixopt/)
|
|
88
|
+
[](https://opensource.org/licenses/MIT)
|
|
89
|
+
[](https://pypi.org/project/flixopt/)
|
|
90
|
+
[](https://github.com/flixOpt/flixopt/commits/main)
|
|
91
|
+
[](https://github.com/flixOpt/flixopt/issues)
|
|
92
|
+
[](https://results.pre-commit.ci/latest/github/flixOpt/flixopt/main)
|
|
93
|
+
[](https://github.com/astral-sh/ruff)
|
|
94
|
+
[](https://github.com/PyPSA/linopy/)
|
|
95
|
+
[](https://xarray.dev/)
|
|
96
|
+
[](https://doi.org/10.18086/eurosun.2022.04.07)
|
|
97
|
+
[](https://github.com/flixOpt/flixopt/stargazers)
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
**FlixOpt is a Python framework for optimizing energy and material flow systems** - from district heating networks to industrial production lines, from renewable energy portfolios to supply chain logistics.
|
|
102
|
+
|
|
103
|
+
**Start simple, scale complex:** Build a working optimization model in minutes, then progressively add detail - multi-period investments, stochastic scenarios, custom constraints - without rewriting your code.
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## 🚀 Quick Start
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
pip install flixopt
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
That's it! FlixOpt comes with the [HiGHS](https://highs.dev/) solver included. You're ready to optimize.
|
|
114
|
+
|
|
115
|
+
**The basic workflow:**
|
|
116
|
+
|
|
117
|
+
```python
|
|
118
|
+
import flixopt as fx
|
|
119
|
+
|
|
120
|
+
# 1. Define your system structure
|
|
121
|
+
flow_system = fx.FlowSystem(timesteps)
|
|
122
|
+
flow_system.add_elements(buses, components, effects)
|
|
123
|
+
|
|
124
|
+
# 2. Create and solve
|
|
125
|
+
calculation = fx.FullCalculation("MyModel", flow_system)
|
|
126
|
+
calculation.solve()
|
|
127
|
+
|
|
128
|
+
# 3. Analyze results
|
|
129
|
+
calculation.results.solution
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Get started with real examples:**
|
|
133
|
+
- 📚 [Full Documentation](https://flixopt.github.io/flixopt/latest/)
|
|
134
|
+
- 💡 [Examples Gallery](https://flixopt.github.io/flixopt/latest/examples/) - Complete working examples from simple to complex
|
|
135
|
+
- 🔧 [API Reference](https://flixopt.github.io/flixopt/latest/api-reference/)
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 🌟 Why FlixOpt?
|
|
140
|
+
|
|
141
|
+
### Progressive Enhancement - Your Model Grows With You
|
|
142
|
+
|
|
143
|
+
**Start simple:**
|
|
144
|
+
```python
|
|
145
|
+
# Basic single-period model
|
|
146
|
+
flow_system = fx.FlowSystem(timesteps)
|
|
147
|
+
boiler = fx.Boiler("Boiler", eta=0.9, ...)
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**Add complexity incrementally:**
|
|
151
|
+
- **Investment decisions** → Add `InvestParameters` to components
|
|
152
|
+
- **Multi-period planning** → Add `periods` dimension to FlowSystem
|
|
153
|
+
- **Uncertainty modeling** → Add `scenarios` dimension with probabilities
|
|
154
|
+
- **Custom constraints** → Extend with native linopy syntax
|
|
155
|
+
|
|
156
|
+
**No refactoring required.** Your component definitions stay the same - periods, scenarios, and features are added as dimensions and parameters.
|
|
157
|
+
|
|
158
|
+
→ [Learn more about multi-period and stochastic modeling](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/dimensions/)
|
|
159
|
+
|
|
160
|
+
### For Everyone
|
|
161
|
+
|
|
162
|
+
- **Beginners:** High-level components that "just work"
|
|
163
|
+
- **Experts:** Full access to modify models with linopy
|
|
164
|
+
- **Researchers:** Quick prototyping with customization options
|
|
165
|
+
- **Engineers:** Reliable, tested components without black boxes
|
|
166
|
+
- **Students:** Clear, Pythonic interfaces for learning optimization
|
|
167
|
+
|
|
168
|
+
### Key Features
|
|
169
|
+
|
|
170
|
+
**Multi-criteria optimization:** Model costs, emissions, resource use - any custom metric. Optimize single objectives or use weighted combinations and ε-constraints.
|
|
171
|
+
→ [Effects documentation](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/effects-penalty-objective/)
|
|
172
|
+
|
|
173
|
+
**Performance at any scale:** Choose calculation modes without changing your model - Full, Segmented, or Aggregated (using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam)).
|
|
174
|
+
→ [Calculation modes](https://flixopt.github.io/flixopt/latest/api-reference/calculation/)
|
|
175
|
+
|
|
176
|
+
**Built for reproducibility:** Self-contained NetCDF result files with complete model information. Load results months later - everything is preserved.
|
|
177
|
+
→ [Results documentation](https://flixopt.github.io/flixopt/latest/api-reference/results/)
|
|
178
|
+
|
|
179
|
+
**Flexible data operations:** Transform FlowSystems with xarray-style operations (`sel()`, `resample()`) for multi-stage optimization.
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## 🎯 What is FlixOpt?
|
|
184
|
+
|
|
185
|
+
### A General-Purpose Flow Optimization Framework
|
|
186
|
+
|
|
187
|
+
FlixOpt models **any system involving flows and conversions:**
|
|
188
|
+
|
|
189
|
+
- **Energy systems:** District heating/cooling, microgrids, renewable portfolios, sector coupling
|
|
190
|
+
- **Material flows:** Supply chains, production lines, chemical processes
|
|
191
|
+
- **Integrated systems:** Water-energy nexus, industrial symbiosis
|
|
192
|
+
|
|
193
|
+
While energy systems are our primary focus, the same foundation applies universally. This enables coupling different system types within integrated models.
|
|
194
|
+
|
|
195
|
+
### Modern Foundations
|
|
196
|
+
|
|
197
|
+
Built on [linopy](https://github.com/PyPSA/linopy/) and [xarray](https://github.com/pydata/xarray), FlixOpt delivers **performance** and **transparency**. Full access to variables, constraints, and model structure. Extend anything with native linopy syntax.
|
|
198
|
+
|
|
199
|
+
### Our Position
|
|
200
|
+
|
|
201
|
+
We bridge the gap between high-level strategic models (like [FINE](https://github.com/FZJ-IEK3-VSA/FINE)) and low-level dispatch tools - similar to [PyPSA](https://docs.pypsa.org/latest/). FlixOpt is the sweet spot for detailed operational planning and long-term investment analysis in the **same framework**.
|
|
202
|
+
|
|
203
|
+
### Academic Roots
|
|
204
|
+
|
|
205
|
+
Originally developed at [TU Dresden](https://github.com/gewv-tu-dresden) for the SMARTBIOGRID project (funded by the German Federal Ministry for Economic Affairs and Energy, FKZ: 03KB159B). FlixOpt evolved from the MATLAB-based flixOptMat framework while incorporating best practices from [oemof/solph](https://github.com/oemof/oemof-solph).
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 🛣️ Roadmap
|
|
210
|
+
|
|
211
|
+
**FlixOpt aims to be the most accessible, flexible, and universal Python framework for energy and material flow optimization.** We believe optimization modeling should be approachable for beginners yet powerful for experts, minimizing context switching between different planning horizons.
|
|
212
|
+
|
|
213
|
+
**Current focus:**
|
|
214
|
+
- Enhanced component library (sector coupling, hydrogen, thermal networks)
|
|
215
|
+
- Examples showcasing multi-period and stochastic modeling
|
|
216
|
+
- Advanced result analysis and visualization
|
|
217
|
+
|
|
218
|
+
**Future vision:**
|
|
219
|
+
- Modeling to generate alternatives (MGA) for robust decision-making
|
|
220
|
+
- Advanced stochastic optimization (two-stage, CVaR)
|
|
221
|
+
- Community ecosystem of user-contributed components
|
|
222
|
+
|
|
223
|
+
→ [Full roadmap and vision](https://flixopt.github.io/flixopt/latest/roadmap/)
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## 🛠️ Installation
|
|
228
|
+
|
|
229
|
+
### Basic Installation
|
|
230
|
+
|
|
231
|
+
```bash
|
|
232
|
+
pip install flixopt
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
Includes the [HiGHS](https://highs.dev/) solver - you're ready to optimize immediately.
|
|
236
|
+
|
|
237
|
+
### Full Installation
|
|
238
|
+
|
|
239
|
+
For additional features (interactive network visualization, time series aggregation):
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
pip install "flixopt[full]"
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Solver Support
|
|
246
|
+
|
|
247
|
+
FlixOpt supports many solvers via linopy: **HiGHS** (included), **Gurobi**, **CPLEX**, **CBC**, **GLPK**, and more.
|
|
248
|
+
|
|
249
|
+
→ [Installation guide](https://flixopt.github.io/flixopt/latest/getting-started/)
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
## 🤝 Contributing
|
|
254
|
+
|
|
255
|
+
FlixOpt thrives on community input. Whether you're fixing bugs, adding components, improving docs, or sharing use cases - **we welcome your contributions.**
|
|
256
|
+
|
|
257
|
+
→ [Contribution guide](https://flixopt.github.io/flixopt/latest/contribute/)
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## 📖 Citation
|
|
262
|
+
|
|
263
|
+
If FlixOpt supports your research or project, please cite:
|
|
264
|
+
|
|
265
|
+
- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)
|
|
266
|
+
- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## 📄 License
|
|
271
|
+
|
|
272
|
+
MIT License - See [LICENSE](https://github.com/flixopt/flixopt/blob/main/LICENSE) for details.
|
|
@@ -19,8 +19,8 @@ flixopt/results.py,sha256=rgyYJTcgF1DOxYSvKM__BTfVU13o13DwSBjvA4o4gdM,77773
|
|
|
19
19
|
flixopt/solvers.py,sha256=m38Smc22MJfHYMiqfNf1MA3OmvbTRm5OWS9nECkDdQk,2355
|
|
20
20
|
flixopt/structure.py,sha256=ntLoj--zTnaZwNYKw-WkJTNxY0ef4zDp4S0iiSxyyxE,47707
|
|
21
21
|
flixopt/utils.py,sha256=CtCMBjvq31upz7i-_1nbPnSe-1CoRoOWlPkucwiSo5Q,2930
|
|
22
|
-
flixopt-3.0.
|
|
23
|
-
flixopt-3.0.
|
|
24
|
-
flixopt-3.0.
|
|
25
|
-
flixopt-3.0.
|
|
26
|
-
flixopt-3.0.
|
|
22
|
+
flixopt-3.0.2.dist-info/licenses/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
|
|
23
|
+
flixopt-3.0.2.dist-info/METADATA,sha256=MsB1fHqlBp77Oq6chiSXuQLLdio1kwZwmu992Td3Tf4,12682
|
|
24
|
+
flixopt-3.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
25
|
+
flixopt-3.0.2.dist-info/top_level.txt,sha256=fanTzb9NylIXfv6Ic7spU97fVmRgGDPKvI_91tw4S3E,8
|
|
26
|
+
flixopt-3.0.2.dist-info/RECORD,,
|
flixopt-3.0.1.dist-info/METADATA
DELETED
|
@@ -1,209 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: flixopt
|
|
3
|
-
Version: 3.0.1
|
|
4
|
-
Summary: Vector based energy and material flow optimization framework in Python.
|
|
5
|
-
Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
|
|
6
|
-
Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>
|
|
7
|
-
License-Expression: MIT
|
|
8
|
-
Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
|
|
9
|
-
Project-URL: repository, https://github.com/flixOpt/flixopt
|
|
10
|
-
Project-URL: documentation, https://flixopt.github.io/flixopt/
|
|
11
|
-
Keywords: optimization,energy systems,numerical analysis
|
|
12
|
-
Classifier: Development Status :: 3 - Alpha
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
-
Classifier: Intended Audience :: Developers
|
|
18
|
-
Classifier: Intended Audience :: Science/Research
|
|
19
|
-
Classifier: Topic :: Scientific/Engineering
|
|
20
|
-
Requires-Python: >=3.10
|
|
21
|
-
Description-Content-Type: text/markdown
|
|
22
|
-
License-File: LICENSE
|
|
23
|
-
Requires-Dist: numpy<3,>=1.21.5
|
|
24
|
-
Requires-Dist: pandas<3,>=2.0.0
|
|
25
|
-
Requires-Dist: xarray<2026.0,>=2024.2.0
|
|
26
|
-
Requires-Dist: linopy<0.6,>=0.5.1
|
|
27
|
-
Requires-Dist: h5netcdf<2,>=1.0.0
|
|
28
|
-
Requires-Dist: pyyaml<7,>=6.0.0
|
|
29
|
-
Requires-Dist: rich<15,>=13.0.0
|
|
30
|
-
Requires-Dist: tomli<3,>=2.0.1; python_version < "3.11"
|
|
31
|
-
Requires-Dist: highspy<2,>=1.5.3
|
|
32
|
-
Requires-Dist: matplotlib<4,>=3.5.2
|
|
33
|
-
Requires-Dist: plotly<7,>=5.15.0
|
|
34
|
-
Requires-Dist: numexpr<2.14,>=2.8.4; python_version < "3.11"
|
|
35
|
-
Provides-Extra: network-viz
|
|
36
|
-
Requires-Dist: dash<4,>=3.0.0; extra == "network-viz"
|
|
37
|
-
Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "network-viz"
|
|
38
|
-
Requires-Dist: dash-daq<1,>=0.6.0; extra == "network-viz"
|
|
39
|
-
Requires-Dist: networkx<4,>=3.0.0; extra == "network-viz"
|
|
40
|
-
Requires-Dist: werkzeug<4,>=3.0.0; extra == "network-viz"
|
|
41
|
-
Requires-Dist: flask<4,>=3.0.0; extra == "network-viz"
|
|
42
|
-
Provides-Extra: full
|
|
43
|
-
Requires-Dist: pyvis==0.3.2; extra == "full"
|
|
44
|
-
Requires-Dist: tsam<3,>=2.3.1; extra == "full"
|
|
45
|
-
Requires-Dist: scipy<2,>=1.15.1; extra == "full"
|
|
46
|
-
Requires-Dist: gurobipy<13,>=10.0.0; extra == "full"
|
|
47
|
-
Requires-Dist: dash<4,>=3.0.0; extra == "full"
|
|
48
|
-
Requires-Dist: dash-cytoscape<2,>=1.0.0; extra == "full"
|
|
49
|
-
Requires-Dist: dash-daq<1,>=0.6.0; extra == "full"
|
|
50
|
-
Requires-Dist: networkx<4,>=3.0.0; extra == "full"
|
|
51
|
-
Requires-Dist: werkzeug<4,>=3.0.0; extra == "full"
|
|
52
|
-
Requires-Dist: flask<4,>=3.0.0; extra == "full"
|
|
53
|
-
Provides-Extra: dev
|
|
54
|
-
Requires-Dist: pytest==8.4.2; extra == "dev"
|
|
55
|
-
Requires-Dist: pytest-xdist==3.8.0; extra == "dev"
|
|
56
|
-
Requires-Dist: nbformat==5.10.4; extra == "dev"
|
|
57
|
-
Requires-Dist: ruff==0.13.3; extra == "dev"
|
|
58
|
-
Requires-Dist: pre-commit==4.3.0; extra == "dev"
|
|
59
|
-
Requires-Dist: pyvis==0.3.2; extra == "dev"
|
|
60
|
-
Requires-Dist: tsam==2.3.9; extra == "dev"
|
|
61
|
-
Requires-Dist: scipy==1.15.1; extra == "dev"
|
|
62
|
-
Requires-Dist: gurobipy==12.0.3; extra == "dev"
|
|
63
|
-
Requires-Dist: dash==3.0.0; extra == "dev"
|
|
64
|
-
Requires-Dist: dash-cytoscape==1.0.2; extra == "dev"
|
|
65
|
-
Requires-Dist: dash-daq==0.6.0; extra == "dev"
|
|
66
|
-
Requires-Dist: networkx==3.0.0; extra == "dev"
|
|
67
|
-
Requires-Dist: werkzeug==3.0.0; extra == "dev"
|
|
68
|
-
Provides-Extra: docs
|
|
69
|
-
Requires-Dist: mkdocs-material==9.6.21; extra == "docs"
|
|
70
|
-
Requires-Dist: mkdocstrings-python==1.18.2; extra == "docs"
|
|
71
|
-
Requires-Dist: mkdocs-table-reader-plugin==3.1.0; extra == "docs"
|
|
72
|
-
Requires-Dist: mkdocs-gen-files==0.5.0; extra == "docs"
|
|
73
|
-
Requires-Dist: mkdocs-include-markdown-plugin==7.1.7; extra == "docs"
|
|
74
|
-
Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "docs"
|
|
75
|
-
Requires-Dist: markdown-include==0.8.1; extra == "docs"
|
|
76
|
-
Requires-Dist: pymdown-extensions==10.16.1; extra == "docs"
|
|
77
|
-
Requires-Dist: pygments==2.19.2; extra == "docs"
|
|
78
|
-
Requires-Dist: mike==2.1.3; extra == "docs"
|
|
79
|
-
Dynamic: license-file
|
|
80
|
-
|
|
81
|
-
# FlixOpt: Energy and Material Flow Optimization Framework
|
|
82
|
-
|
|
83
|
-
[](https://flixopt.github.io/flixopt/latest/)
|
|
84
|
-
[](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
|
|
85
|
-
[](https://pypi.org/project/flixopt/)
|
|
86
|
-
[](https://pypi.org/project/flixopt/)
|
|
87
|
-
[](https://opensource.org/licenses/MIT)
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## 🎯 Vision
|
|
92
|
-
|
|
93
|
-
**FlixOpt aims to be the most accessible and flexible Python framework for energy and material flow optimization.**
|
|
94
|
-
|
|
95
|
-
We believe that optimization modeling should be **approachable for beginners** yet **powerful for experts**. Too often, frameworks force you to choose between ease of use and flexibility. FlixOpt refuses this compromise.
|
|
96
|
-
|
|
97
|
-
### Where We're Going
|
|
98
|
-
|
|
99
|
-
**Short-term goals:**
|
|
100
|
-
- **Multi-dimensional modeling**: Full support for multi-period investments and scenario-based stochastic optimization (periods and scenarios are in active development)
|
|
101
|
-
- **Enhanced component library**: More pre-built, domain-specific components (sector coupling, hydrogen systems, thermal networks, demand-side management)
|
|
102
|
-
|
|
103
|
-
**Medium-term vision:**
|
|
104
|
-
- **Modeling to generate alternatives (MGA)**: Built-in support for exploring near-optimal solution spaces to produce more robust, diverse solutions under uncertainty
|
|
105
|
-
- **Interactive tutorials**: Browser-based, reactive tutorials for learning FlixOpt without local installation
|
|
106
|
-
- **Standardized cost calculations**: Align with industry standards (VDI 2067) for CAPEX/OPEX calculations
|
|
107
|
-
- **Advanced result analysis**: Time-series aggregation, automated reporting, and rich visualization options
|
|
108
|
-
|
|
109
|
-
**Long-term vision:**
|
|
110
|
-
- **Showcase universal applicability**: FlixOpt already handles any flow-based system (supply chains, water networks, production planning, chemical processes) - we need more examples and domain-specific component libraries to demonstrate this
|
|
111
|
-
- **Seamless integration**: First-class support for coupling with simulation tools, databases, existing energy system models, and GIS data
|
|
112
|
-
- **Robust optimization**: Built-in uncertainty quantification and stochastic programming capabilities
|
|
113
|
-
- **Community ecosystem**: Rich library of user-contributed components, examples, and domain-specific extensions
|
|
114
|
-
- **Model validation tools**: Automated checks for physical plausibility, data consistency, and common modeling errors
|
|
115
|
-
|
|
116
|
-
### Why FlixOpt Exists
|
|
117
|
-
|
|
118
|
-
FlixOpt is a **general-purpose framework for modeling any system involving flows and conversions** - energy, materials, fluids, goods, or data. While energy systems are our primary focus, the same mathematical foundation applies to supply chains, water networks, production lines, and more.
|
|
119
|
-
|
|
120
|
-
We bridge the gap between high-level strategic models (like [FINE](https://github.com/FZJ-IEK3-VSA/FINE)) for long-term planning and low-level dispatch tools for operations. FlixOpt is the **sweet spot** for:
|
|
121
|
-
|
|
122
|
-
- **Researchers** who need to prototype quickly but may require deep customization later
|
|
123
|
-
- **Engineers** who want reliable, tested components without black-box abstractions
|
|
124
|
-
- **Students** learning optimization who benefit from clear, Pythonic interfaces
|
|
125
|
-
- **Practitioners** who need to move from model to production-ready results
|
|
126
|
-
- **Domain experts** from any field where things flow, transform, and need optimizing
|
|
127
|
-
|
|
128
|
-
Built on modern foundations ([linopy](https://github.com/PyPSA/linopy/) and [xarray](https://github.com/pydata/xarray)), FlixOpt delivers both **performance** and **transparency**. You can inspect everything, extend anything, and trust that your model does exactly what you designed.
|
|
129
|
-
|
|
130
|
-
Originally developed at [TU Dresden](https://github.com/gewv-tu-dresden) for the SMARTBIOGRID project (funded by the German Federal Ministry for Economic Affairs and Energy, FKZ: 03KB159B), FlixOpt has evolved from the Matlab-based flixOptMat framework while incorporating the best ideas from [oemof/solph](https://github.com/oemof/oemof-solph).
|
|
131
|
-
|
|
132
|
-
---
|
|
133
|
-
|
|
134
|
-
## 🌟 What Makes FlixOpt Different
|
|
135
|
-
|
|
136
|
-
### Start Simple, Scale Complex
|
|
137
|
-
Define a working model in minutes with high-level components, then drill down to fine-grained control when needed. No rewriting, no framework switching.
|
|
138
|
-
|
|
139
|
-
```python
|
|
140
|
-
import flixopt as fx
|
|
141
|
-
|
|
142
|
-
# Simple start
|
|
143
|
-
boiler = fx.Boiler("Boiler", eta=0.9, ...)
|
|
144
|
-
|
|
145
|
-
# Advanced control when needed - extend with native linopy
|
|
146
|
-
boiler.model.add_constraints(custom_constraint, name="my_constraint")
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
### Multi-Criteria Optimization Done Right
|
|
150
|
-
Model costs, emissions, resource use, and any custom metric simultaneously as **Effects**. Optimize any single Effect, use weighted combinations, or apply ε-constraints:
|
|
151
|
-
|
|
152
|
-
```python
|
|
153
|
-
costs = fx.Effect('costs', '€', 'Total costs',
|
|
154
|
-
share_from_temporal={'CO2': 180}) # 180 €/tCO2
|
|
155
|
-
co2 = fx.Effect('CO2', 'kg', 'Emissions', maximum_periodic=50000)
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Performance at Any Scale
|
|
159
|
-
Choose the right calculation mode for your problem:
|
|
160
|
-
- **Full** - Maximum accuracy for smaller problems
|
|
161
|
-
- **Segmented** - Rolling horizon for large time series
|
|
162
|
-
- **Aggregated** - Typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam) for massive models
|
|
163
|
-
|
|
164
|
-
### Built for Reproducibility
|
|
165
|
-
Every result file is self-contained with complete model information. Load it months later and know exactly what you optimized. Export to NetCDF, share with colleagues, archive for compliance.
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
## 🚀 Quick Start
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
pip install flixopt
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
That's it. FlixOpt comes with the [HiGHS](https://highs.dev/) solver included - you're ready to optimize.
|
|
176
|
-
Many more solvers are supported (gurobi, cplex, cbc, glpk, ...)
|
|
177
|
-
|
|
178
|
-
For additional features (interactive network visualization, time series aggregation):
|
|
179
|
-
```bash
|
|
180
|
-
pip install "flixopt[full]"
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
**Next steps:**
|
|
184
|
-
- 📚 [Full Documentation](https://flixopt.github.io/flixopt/latest/)
|
|
185
|
-
- 💡 [Examples](https://flixopt.github.io/flixopt/latest/examples/)
|
|
186
|
-
- 🔧 [API Reference](https://flixopt.github.io/flixopt/latest/api-reference/)
|
|
187
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
## 🤝 Contributing
|
|
191
|
-
|
|
192
|
-
FlixOpt thrives on community input. Whether you're fixing bugs, adding components, improving docs, or sharing use cases - we welcome your contributions.
|
|
193
|
-
|
|
194
|
-
See our [contribution guide](https://flixopt.github.io/flixopt/latest/contribute/) to get started.
|
|
195
|
-
|
|
196
|
-
---
|
|
197
|
-
|
|
198
|
-
## 📖 Citation
|
|
199
|
-
|
|
200
|
-
If FlixOpt supports your research or project, please cite:
|
|
201
|
-
|
|
202
|
-
- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)
|
|
203
|
-
- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## 📄 License
|
|
208
|
-
|
|
209
|
-
MIT License - See [LICENSE](https://github.com/flixopt/flixopt/blob/main/LICENSE) for details.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|