flixOpt · FBumann · Nov 30, 2025 · Nov 19, 2025 · Nov 19, 2025 · Nov 19, 2025
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,7 @@ venv/
 .DS_Store
 lib/
 temp-plot.html
+.cache
+site/
+*.egg-info
+uv.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,7 +16,7 @@ This contains all commits, PRs, and contributors.
 Therefore, the Changelog should focus on the user-facing changes.
 
 Please remove all irrelevant sections before releasing.
-Please keep the format of the changelog consistent with the other releases, so the extraction for mkdocs works.
+Please keep the format of the changelog consistent: ## [VERSION] - YYYY-MM-DD
 ---
 
 ## [Template] - ????-??-??
@@ -49,11 +49,11 @@ If upgrading from v2.x, see the [v3.0.0 release notes](https://github.com/flixOp
 
 ---
 
-## [Unreleased] - ????-??-??
+Until here -->
 
-**Summary**: Renamed OnOff terminology to Status terminology for better alignment with PyPSA and unit commitment standards. **All deprecated items from v4.x have been removed.**
+## [Upcoming]
 
-### ✨ Added
+**Summary**: Renamed OnOff terminology to Status terminology for better alignment with PyPSA and unit commitment standards. **All deprecated items from v4.x have been removed.**
 
 ### 💥 Breaking Changes
 
@@ -212,22 +212,14 @@ A partial backwards compatibility wrapper would be misleading, so we opted for a
 - Flow parameters: `Q_fu` → use `fuel_flow`, `P_el` → use `electrical_flow`, `Q_th` → use `thermal_flow`, `Q_ab` → use `heat_source_flow`
 - Efficiency parameters: `eta` → use `thermal_efficiency`, `eta_th` → use `thermal_efficiency`, `eta_el` → use `electrical_efficiency`, `COP` → use `cop`
 
-### 🐛 Fixed
-
-### 🔒 Security
-
-### 📦 Dependencies
 
 ### 📝 Docs
+- Improve documentation from the ground up
 
-### 👷 Development
-
-### 🚧 Known Issues
+This is not yet publicly released!
 
 ---
 
-Until here -->
-
 ## [4.3.5] - 2025-11-29
 
 **Summary**: Fix zenodo again

diff --git a/README.md b/README.md
@@ -96,7 +96,7 @@ boiler = fx.Boiler("Boiler", eta=0.9, ...)
 ### Key Features
 
 **Multi-criteria optimization:** Model costs, emissions, resource use - any custom metric. Optimize single objectives or use weighted combinations and ε-constraints.
-→ [Effects documentation](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/effects-penalty-objective/)
+→ [Effects documentation](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/effects-and-dimensions/)
 
 **Performance at any scale:** Choose optimization modes without changing your model - Optimization, SegmentedOptimization, or ClusteredOptimization (using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam)).
 → [Optimization modes](https://flixopt.github.io/flixopt/latest/api-reference/optimization/)

diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/home/citing.md b/docs/home/citing.md
@@ -0,0 +1,29 @@
+# Citing flixOpt
+
+If you use flixOpt in your research, please cite it.
+
+## Citation
+
+When referencing flixOpt in academic publications, please use look here: [flixopt citation](https://zenodo.org/records/17756895)
+
+## Publications
+
+If you've published research using flixOpt, please let us know! We'd love to feature it here.
+
+### List of Publications
+
+*Coming soon: A list of academic publications that have used flixOpt*
+
+## Contributing Back
+
+If flixOpt helped your research:
+
+- Share your model as an example
+- Report issues or contribute code
+- Improve documentation
+
+See the [Contributing Guide](../contribute.md).
+
+## License
+
+flixOpt is released under the MIT License. See [License](license.md) for details.
diff --git a/docs/home/installation.md b/docs/home/installation.md
@@ -0,0 +1,91 @@
+# Installation
+
+This guide covers installing flixOpt and its dependencies.
+
+
+## Basic Installation
+
+Install flixOpt directly into your environment using pip:
+
+```bash
+pip install flixopt
+```
+
+This provides the core functionality with the HiGHS solver included.
+
+## Full Installation
+
+For all features including interactive network visualizations and time series aggregation:
+
+```bash
+pip install "flixopt[full]"
+```
+
+## Development Installation
+
+If you want to contribute to flixOpt or work with the latest development version:
+
+```bash
+git clone https://github.com/flixOpt/flixopt.git
+cd flixopt
+pip install -e ".[full,dev,docs]"
+```
+
+## Solver Installation
+
+### HiGHS (Included)
+
+The HiGHS solver is included with flixOpt and works out of the box. No additional installation is required.
+
+### Gurobi (Optional)
+
+For academic use, Gurobi offers free licenses:
+
+1. Register for an academic license at [gurobi.com](https://www.gurobi.com/academia/)
+2. Install Gurobi:
+   ```bash
+   pip install gurobipy
+   ```
+3. Activate your license following Gurobi's instructions
+
+## Verification
+
+Verify your installation by running:
+
+```python
+import flixopt
+print(flixopt.__version__)
+```
+
+## Logging Configuration
+
+flixOpt uses Python's standard logging module with optional colored output via [colorlog](https://github.com/borntyping/python-colorlog). Logging is silent by default but can be easily configured:
+
+```python
+from flixopt import CONFIG
+
+# Enable colored console logging
+CONFIG.Logging.enable_console('INFO')
+
+# Or use a preset configuration for exploring
+CONFIG.exploring()
+```
+
+Since flixOpt uses Python's standard logging, you can also configure it directly:
+
+```python
+import logging
+
+# Get the flixopt logger and configure it
+logger = logging.getLogger('flixopt')
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.StreamHandler())
+```
+
+For more details on logging configuration, see the [`CONFIG.Logging`][flixopt.config.CONFIG.Logging] documentation.
+
+## Next Steps
+
+- Follow the [Quick Start](quick-start.md) guide
+- Explore the [Minimal Example](../examples/00-Minimal Example.md)
+- Read about [Core Concepts](../user-guide/core-concepts.md)
diff --git a/docs/home/license.md b/docs/home/license.md
@@ -0,0 +1,43 @@
+# License
+
+flixOpt is released under the MIT License.
+
+## MIT License
+
+```
+MIT License
+
+Copyright (c) 2022 Chair of Building Energy Systems and Heat Supply - TU Dresden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+## What This Means
+
+The MIT License is a permissive open-source license that allows you to:
+
+✅ **Use** flixOpt for any purpose, including commercial applications
+✅ **Modify** the source code to fit your needs
+✅ **Distribute** copies of flixOpt
+✅ **Sublicense** under different terms
+✅ **Use privately** without making your modifications public
+
+## Contributing
+
+By contributing to flixOpt, you agree that your contributions will be licensed under the MIT License. See our [Contributing Guide](../contribute.md) for more information.