Skip to content

Commit e8d4175

Browse files
committed
Add missing examples to docs
1 parent d0acacc commit e8d4175

4 files changed

Lines changed: 20 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOp
7272
### 📦 Dependencies
7373
7474
### 📝 Docs
75+
- Added missing examples to docs.
7576
7677
### 👷 Development
7778

docs/examples/04-Scenarios.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Scenario example
2+
3+
```python
4+
{! ../examples/04_Scenarios/scenario_example.py !}
5+
```
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Two-stage optimization
2+
3+
```python
4+
{! ../examples/05_Two-stage-optimization/two_stage_optimization.py !}
5+
```

docs/examples/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,12 @@
33
Here you can find a collection of examples that demonstrate how to use FlixOpt.
44

55
We work on improving this gallery. If you have something to share, please contact us!
6+
7+
## Available Examples
8+
9+
1. [Minimal Example](00-Minimal Example.md) - The simplest possible FlixOpt model
10+
2. [Simple Example](01-Basic Example.md) - A basic example with more features
11+
3. [Complex Example](02-Complex Example.md) - A comprehensive example with result saving and loading
12+
4. [Calculation Modes](03-Calculation Modes.md) - Comparison of different calculation modes
13+
5. [Scenarios](04-Scenarios.md) - Working with scenarios in FlixOpt
14+
6. [Two-stage Optimization](05-Two-stage-optimization.md) - Two-stage optimization approach

0 commit comments

Comments
 (0)