Skip to content

Commit f061b2e

Browse files
committed
Add docs to Readme and pyproject.toml
1 parent b4a290b commit f061b2e

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# flixOpt: Energy and Material Flow Optimization Framework
22

3+
[![πŸ“š Documentation](https://img.shields.io/badge/πŸ“š_docs-online-brightgreen.svg)](https://flixopt.github.io/flixopt/)
4+
[![CI](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml/badge.svg)](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)
5+
[![PyPI version](https://badge.fury.io/py/flixopt.svg)](https://badge.fury.io/py/flixopt)
6+
[![Python Versions](https://img.shields.io/pypi/pyversions/flixopt.svg)](https://pypi.org/project/flixopt/)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
39
**flixOpt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP). Combining flexibility and efficiency, it provides a powerful platform for both dispatch and investment optimization challenges.
410

511
---
@@ -22,6 +28,10 @@ We recommend installing flixOpt with all dependencies, which enables interactive
2228

2329
---
2430

31+
## πŸ“š Documentation
32+
33+
Full documentation is available at [https://flixopt.github.io/flixopt/](https://flixopt.github.io/flixopt/)
34+
2535
## 🌟 Key Features and Concepts
2636

2737
### πŸ’‘ High-level Interface...

β€Žpyproject.tomlβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ docs = [
7171
[project.urls]
7272
homepage = "https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt"
7373
repository = "https://github.com/flixOpt/flixopt"
74+
documentation = "https://flixopt.github.io/flixopt/"
7475

7576
[tool.setuptools.packages.find]
7677
where = ["."]

0 commit comments

Comments
Β (0)