Skip to content

Commit 9cef222

Browse files
committed
Merge remote-tracking branch 'origin/main' into feature/plots-with-faceting-and-animations
# Conflicts: # CHANGELOG.md
2 parents 55dfde9 + 84ab912 commit 9cef222

File tree

5 files changed

+750
-73
lines changed

5 files changed

+750
-73
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,23 @@ If upgrading from v2.x, see the [Migration Guide](https://flixopt.github.io/flix
6565
- **Selection behavior**: Changed default selection behavior in plotting methods - no longer automatically selects first value for non-time dimensions. Use `select` parameter for explicit selection
6666
- **Improved error messages**: Enhanced error messages when using matplotlib engine with multidimensional data, providing clearer guidance on dimension requirements
6767
- Improved `scenario_example.py`
68+
- Improved error handling in `plot_heatmap()` method for better dimension validation
6869
6970
### 🗑️ Deprecated
7071
- **`indexer` parameter**: The `indexer` parameter in all plotting methods is deprecated in favor of the new `select` parameter with enhanced functionality
7172
7273
### 🔥 Removed
7374
7475
### 🐛 Fixed
75-
- Fixed error handling in `plot_heatmap()` method for better dimension validation
76+
- Add error handling for empty buses to prevent cryptic errors
77+
- Add early validation for non-existent periods when using linked periods with tuples
7678
7779
### 🔒 Security
7880
7981
### 📦 Dependencies
8082
8183
### 📝 Docs
84+
- Improve docs visually with new Material theme and enhanced styling
8285
8386
### 👷 Development
8487
- Renamed `_apply_indexer_to_data()` to `_apply_selection_to_data()` for consistency with new API

docs/index.md

Lines changed: 133 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,144 @@
1-
{%
2-
include-markdown "../README.md"
3-
%}
4-
51
---
2+
title: Home
3+
hide:
4+
- navigation
5+
- toc
6+
---
7+
8+
<div class="hero-section">
9+
10+
<h1>flixOpt</h1>
11+
12+
<p class="tagline">Energy and Material Flow Optimization Framework</p>
13+
14+
<p>Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.</p>
15+
16+
<p class="hero-buttons">
17+
<a href="getting-started/" class="md-button md-button--primary">🚀 Get Started</a>
18+
<a href="examples/" class="md-button">💡 View Examples</a>
19+
<a href="https://github.com/flixOpt/flixopt" class="md-button" target="_blank" rel="noopener noreferrer">⭐ GitHub</a>
20+
</p>
21+
22+
</div>
23+
24+
## :material-map-marker-path: Quick Navigation
25+
26+
<div class="quick-links">
27+
<a href="getting-started/" class="quick-link-card">
28+
<h3>🚀 Getting Started</h3>
29+
<p>New to FlixOpt? Start here with installation and your first model</p>
30+
</a>
31+
32+
<a href="examples/" class="quick-link-card">
33+
<h3>💡 Examples Gallery</h3>
34+
<p>Explore real-world examples from simple to complex systems</p>
35+
</a>
636

7-
## Documentation Architecture
37+
<a href="api-reference/" class="quick-link-card">
38+
<h3>📚 API Reference</h3>
39+
<p>Detailed documentation of all classes, methods, and parameters</p>
40+
</a>
41+
42+
<a href="user-guide/recipes/" class="quick-link-card">
43+
<h3>📖 Recipes</h3>
44+
<p>Common patterns and best practices for modeling energy systems</p>
45+
</a>
46+
47+
<a href="user-guide/mathematical-notation/" class="quick-link-card">
48+
<h3>∫ Mathematical Notation</h3>
49+
<p>Understand the mathematical formulations behind the framework</p>
50+
</a>
51+
52+
<a href="roadmap/" class="quick-link-card">
53+
<h3>🛣️ Roadmap</h3>
54+
<p>See what's coming next and contribute to the future of FlixOpt</p>
55+
</a>
56+
</div>
57+
58+
## 🏗️ Framework Architecture
59+
60+
<div class="architecture-section" markdown="1">
861

962
<figure markdown>
1063
![FlixOpt Conceptual Usage](./images/architecture_flixOpt.png)
1164
<figcaption>Conceptual Usage and IO operations of FlixOpt</figcaption>
1265
</figure>
1366

67+
**FlixOpt** provides a complete workflow for energy system optimization:
68+
69+
- **:material-file-code: Define** your system using Python components
70+
- **:material-cog: Optimize** with powerful solvers (HiGHS, Gurobi, CPLEX)
71+
- **:material-chart-box: Analyze** results with built-in visualization tools
72+
- **:material-export: Export** to various formats for further analysis
73+
74+
</div>
75+
76+
## :material-account-group: Community & Support
77+
78+
<div class="feature-grid" markdown="1">
79+
80+
<div class="feature-card" markdown="1">
81+
82+
:fontawesome-brands-github:{ .feature-icon }
83+
84+
### GitHub
85+
86+
Report issues, request features, and contribute to the codebase
87+
88+
[Visit Repository →](https://github.com/flixOpt/flixopt){target="_blank" rel="noopener noreferrer"}
89+
90+
</div>
91+
92+
<div class="feature-card" markdown="1">
93+
94+
:material-forum:{ .feature-icon }
95+
96+
### Discussions
97+
98+
Ask questions and share your projects with the community
99+
100+
[Join Discussion →](https://github.com/flixOpt/flixopt/discussions){target="_blank" rel="noopener noreferrer"}
101+
102+
</div>
103+
104+
<div class="feature-card" markdown="1">
105+
106+
:material-book-open-page-variant:{ .feature-icon }
107+
108+
### Contributing
109+
110+
Help improve FlixOpt by contributing code, docs, or examples
111+
112+
[Learn How →](contribute/){target="_blank" rel="noopener noreferrer"}
113+
114+
</div>
115+
116+
</div>
117+
118+
119+
## :material-file-document-edit: Recent Updates
120+
121+
!!! tip "What's New in v3.0.0"
122+
Major improvements and breaking changes. Check the [Migration Guide](user-guide/migration-guide-v3.md) for upgrading from v2.x.
123+
124+
📋 See the full [Release Notes](changelog/) for detailed version history.
125+
14126
---
15127

16-
## Next Steps
128+
<div style="text-align: center; margin: 3rem 0; padding: 2rem; background: var(--md-code-bg-color); border-radius: 0.75rem;">
129+
130+
<h3>Ready to optimize your energy system?</h3>
131+
132+
<p>
133+
<a href="getting-started/" class="md-button md-button--primary md-button--lg">▶️ Start Building</a>
134+
</p>
17135

18-
- **New to FlixOpt?** Start with the [Getting Started Guide](getting-started.md)
19-
- **Want to see examples?** Check out the [Examples Gallery](examples/index.md)
20-
- **Need API details?** Browse the [API Reference](api-reference/index.md)
21-
- **Looking for advanced patterns?** See [Recipes](user-guide/recipes/index.md)
22-
- **Curious about the future?** Read our [Roadmap](roadmap.md)
136+
</div>
137+
138+
---
139+
140+
{%
141+
include-markdown "../README.md"
142+
start="## Installation"
143+
end="## License"
144+
%}

0 commit comments

Comments
 (0)