User Guide¶
Welcome to the flixOpt User Guide! This guide will help you master energy and material flow optimization with flixOpt.
What is flixOpt?¶
flixOpt is a comprehensive framework for modeling and optimizing energy and material flow systems. It supports:
- Operational Optimization - Dispatch optimization with fixed capacities
- Investment Optimization - Capacity expansion planning with binary or continuous sizing
- Multi-Period Planning - Sequential investment decisions across multiple periods
- Scenario Analysis - Stochastic modeling with weighted scenarios
Key Features¶
-
Flexible Components
Flow, Bus, Storage, LinearConverter - build any system topology
-
Advanced Modeling
Investment decisions, On/Off states, Piecewise linearization
-
Multiple Solvers
HiGHS (default), Gurobi, CPLEX - choose what fits your needs
-
Built-in Analysis
Plotting, export, and result exploration tools
Learning Path¶
This guide follows a sequential learning path:
| Step | Section | What You'll Learn |
|---|---|---|
| 1 | Core Concepts | Fundamental building blocks: FlowSystem, Bus, Flow, Components, Effects |
| 2 | Building Models | How to construct models step by step |
| 3 | Running Optimizations | Solver configuration and execution |
| 4 | Analyzing Results | Extracting and visualizing outcomes |
| 5 | Mathematical Notation | Deep dive into the math behind each element |
| 6 | Recipes | Common patterns and solutions |
Quick Links¶
Getting Started¶
- Quick Start - Build your first model in 5 minutes
- Minimal Example - Simplest possible model
- Core Concepts - Understand the fundamentals
Reference¶
- Mathematical Notation - Detailed specifications
- API Reference - Complete class documentation
- Examples - Working code to learn from
Help¶
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
- Community - Get help from the community
Use Cases¶
flixOpt handles any flow-based optimization problem:
Energy Systems: Power dispatch, CHP optimization, renewable integration, battery storage, district heating
Industrial Applications: Process optimization, multi-commodity networks, supply chains, resource allocation