Energy and Material Flow Optimization Framework
+Progressive Flow System Optimization
Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index f1b7c03d5..2f95b6d4e 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,5 +1,5 @@ /* ============================================================================ - flixOpt Custom Styling with Custom Palette + FlixOpt Custom Styling with Custom Palette ========================================================================= */ /* Root variables for easy customization */ diff --git a/mkdocs.yml b/mkdocs.yml index 61d33e233..0adba464d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -# flixOpt Documentation Configuration +# FlixOpt Documentation Configuration # https://mkdocstrings.github.io/python/usage/configuration/docstrings/ # https://squidfunk.github.io/mkdocs-material/setup/ @@ -278,10 +278,10 @@ extra: social: - icon: fontawesome/brands/github link: https://github.com/flixOpt/flixopt - name: flixOpt on GitHub + name: FlixOpt on GitHub - icon: fontawesome/brands/python link: https://pypi.org/project/flixopt/ - name: flixOpt on PyPI + name: FlixOpt on PyPI analytics: provider: google diff --git a/pyproject.toml b/pyproject.toml index 0c6bcb951..258b0ab7f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "flixopt" dynamic = ["version"] -description = "Vector based energy and material flow optimization framework in Python." +description = "Progressive flow system optimization in Python - start simple, scale to complex." readme = "README.md" requires-python = ">=3.10" license = "MIT" From 1f2bc7d8f17e62b4472818a66bfd00546e38971c Mon Sep 17 00:00:00 2001 From: PStange <60431226+PStange@users.noreply.github.com> Date: Tue, 18 Nov 2025 08:15:19 +0100 Subject: [PATCH 10/19] Update .zenodo.json grant no. added --- .zenodo.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.zenodo.json b/.zenodo.json index 116d2edcc..2163b3963 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -51,6 +51,10 @@ "xarray" ], "language": "eng", + "grants": [ + { "id": ""grants": [ + {"id": "03KB159B"} + ] "related_identifiers": [ { "identifier": "https://github.com/flixOpt/flixopt", From 0eb4126cfe51343cd0f7a37d8af4b9ab7f0a9805 Mon Sep 17 00:00:00 2001 From: PStange <60431226+PStange@users.noreply.github.com> Date: Tue, 18 Nov 2025 08:20:33 +0100 Subject: [PATCH 11/19] Update .zenodo.json --- .zenodo.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.zenodo.json b/.zenodo.json index 2163b3963..e1d19e68a 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -52,8 +52,7 @@ ], "language": "eng", "grants": [ - { "id": ""grants": [ - {"id": "03KB159B"} + {"id": "03KB159B"} ] "related_identifiers": [ { From 863b4016270c4e12f0bf17851861cc5d05870691 Mon Sep 17 00:00:00 2001 From: PStange <60431226+PStange@users.noreply.github.com> Date: Tue, 18 Nov 2025 08:25:29 +0100 Subject: [PATCH 12/19] Update .zenodo.json --- .zenodo.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.zenodo.json b/.zenodo.json index e1d19e68a..f40ba2361 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -53,7 +53,7 @@ "language": "eng", "grants": [ {"id": "03KB159B"} - ] + ], "related_identifiers": [ { "identifier": "https://github.com/flixOpt/flixopt", From c0cd7fcd21fc2c6162dc4a47056cda1038c2267b Mon Sep 17 00:00:00 2001 From: Felix Panitz+ Flexible โข Low-entry โข Investment โข X-sector โข OPTimization +
+ ++ Adaptable to different systems ยท Easy to prototype ยท Investment planning focus ยท Sector coupling ยท Mathematical optimization +
+ [](https://flixopt.github.io/flixopt/latest/) [](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml) [](https://pypi.org/project/flixopt/) diff --git a/docs/index.md b/docs/index.md index 3cfc21805..f7ce6a650 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,9 @@ hide:Progressive Flow System Optimization
+Flexible ยท Low-entry ยท Investment ยท X-sector ยท OPTimization
+ +Adaptable to different systems ยท Easy to prototype ยท Investment planning focus ยท Sector coupling ยท Mathematical optimization
Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 2f95b6d4e..2992267b6 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -526,10 +526,30 @@ .hero-section .tagline { font-size: 1.5rem; color: var(--md-default-fg-color--light); - margin-bottom: 2rem; + margin-bottom: 1rem; font-weight: 300; } +/* Backronym styling */ +.hero-section .backronym { + font-size: 1.3rem; + font-weight: 500; + letter-spacing: 0.05em; + margin-bottom: 0.5rem; +} + +.hero-section .backronym .letter { + color: var(--md-primary-fg-color); + font-weight: 700; +} + +.hero-section .backronym-desc { + font-size: 0.95rem; + color: var(--md-default-fg-color--light); + margin-bottom: 2rem; + opacity: 0.85; +} + .hero-buttons { display: flex; gap: 1rem; From b6778655f5ec66e1a9c886e5bfb9730e8c1e5345 Mon Sep 17 00:00:00 2001 From: FBumann <117816358+FBumann@users.noreply.github.com> Date: Wed, 26 Nov 2025 16:56:07 +0100 Subject: [PATCH 16/19] Change backronym translation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c40691ab0..59ac17e1d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@- Adaptable to different systems ยท Easy to prototype ยท Investment planning focus ยท Sector coupling ยท Mathematical optimization + Model more than costs ยท Easy to prototype ยท Based on dispatch ยท Sector coupling ยท Mathematical optimization
[](https://flixopt.github.io/flixopt/latest/) From fa9aabe6083b2a73eba96ce394b6869f1ebe8e3b Mon Sep 17 00:00:00 2001 From: FBumann <117816358+FBumann@users.noreply.github.com> Date: Wed, 26 Nov 2025 16:59:57 +0100 Subject: [PATCH 17/19] Change backronym translation --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f7ce6a650..3467bb394 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ hide:Flexible ยท Low-entry ยท Investment ยท X-sector ยท OPTimization
-Adaptable to different systems ยท Easy to prototype ยท Investment planning focus ยท Sector coupling ยท Mathematical optimization
+Model more than costs ยท Easy to prototype ยท Based on dispatch ยท Sector coupling ยท Mathematical optimization
Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.
From a8e13ef4f356f06552ff3570dfac8fed1a87b0ba Mon Sep 17 00:00:00 2001 From: FBumann <117816358+FBumann@users.noreply.github.com> Date: Wed, 26 Nov 2025 22:07:32 +0100 Subject: [PATCH 18/19] Add workflow to update the citation version and date --- .github/workflows/python-app.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/python-app.yaml b/.github/workflows/python-app.yaml index 014c2554e..d397d2be5 100644 --- a/.github/workflows/python-app.yaml +++ b/.github/workflows/python-app.yaml @@ -181,6 +181,18 @@ jobs: with: python-version: ${{ env.PYTHON_VERSION }} + - name: Update CITATION.cff + run: | + VERSION=${GITHUB_REF#refs/tags/v} + DATE=$(date +%Y-%m-%d) + sed -i "s/^version: .*/version: $VERSION/" CITATION.cff + sed -i "s/^date-released: .*/date-released: $DATE/" CITATION.cff + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + git add CITATION.cff + git commit -m "Update CITATION.cff to $VERSION" || true + git push origin HEAD:main + - name: Extract release notes run: | VERSION=${GITHUB_REF#refs/tags/v} From c0ede5d3a7b6530ab779ae2a4ffec132575fdab7 Mon Sep 17 00:00:00 2001 From: FBumann <117816358+FBumann@users.noreply.github.com> Date: Wed, 26 Nov 2025 22:11:20 +0100 Subject: [PATCH 19/19] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 59ac17e1d..6d049819d 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ **FlixOpt is a Python framework for progressive flow system optimization** - from district heating networks to industrial production lines, from renewable energy portfolios to supply chain logistics. -**Start simple, scale complex:** Build a working optimization model in minutes, then progressively add detail - multi-period investments, stochastic scenarios, custom constraints - without rewriting your code. +Build simple models quickly, then incrementally add investment decision, multi-period planning, stochastic scenarios, and custom constraints without refactoring. ---