openstef 4.0.1__tar.gz → 4.1.1.dev0__tar.gz

openstef-4.1.1.dev0/.github/ISSUE_TEMPLATE/openstef-project-story.md

@@ -0,0 +1,38 @@
+---
+name: OpenSTEF Project Story
+about: Describe a new feature or improvement for OpenSTEF
+title: ''
+labels: 'OpenSTEF 4'
+assignees: ''
+---
+
+As
+I want to
+So that I
+
+🌍 Background
+
+> [!IMPORTANT]
+> Changes should be done by forking [main branch](https://github.com/OpenSTEF/openstef/tree/main) (`main`) and then make a PR back onto `main` branch.
+> Please read the [contributing guide](https://openstef.github.io/openstef/contribute/index.html) before you start.
+
+❗Priority (What if we don't do this?/Are there any deadlines? etc.)
+
+Definition of Done:
+
+✅ Acceptance criteria
+- [ ]
+
+📄 Documentation criteria:
+Update relevant documentation pages
+
+🧪 Test criteria:
+Unit tests written and passed
+
+⌛ Dependencies:
+N/A
+
+🚀 Releasing:
+N/A
+
+Other information:

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/dependabot.yml

@@ -4,6 +4,12 @@
 # Dependabot configuration for the OpenSTEF uv workspace.
 #
 #  - Patch/minor updates are grouped into daily PRs; majors stay individual.
+#  - lockfile-only: updates touch uv.lock only, never widen pyproject.toml
+#    constraints, so no "update X requirement from A to B" PRs.
+#  - Linters/formatters (ruff, ty, pyproject-fmt) are isolated in their own group:
+#    their releases routinely add rules/checks or restyle files and fail the quality
+#    gate, so they land in a dedicated PR rather than blocking unrelated library or
+#    security updates.
 #  - Cooldown delays brand-new releases by a few days as supply-chain protection.
 #  - Security advisories are in their own group, exempt from cooldown.
 
@@ -24,6 +30,7 @@ updates:
       time: "06:00"
       timezone: Europe/Amsterdam
     open-pull-requests-limit: 10
+    versioning-strategy: lockfile-only
     commit-message:
       prefix: "chore(deps)"
       include: scope
@@ -39,8 +46,13 @@ updates:
       python-security:
         applies-to: security-updates
         update-types: [patch, minor]
+      python-linters:
+        applies-to: version-updates
+        patterns: ["ruff", "ty", "pyproject-fmt"]
+        update-types: [patch, minor]
       python-versions:
         applies-to: version-updates
+        exclude-patterns: ["ruff", "ty", "pyproject-fmt"]
         update-types: [patch, minor]
 
   - package-ecosystem: github-actions

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/workflows/_job_quality_check.yaml

@@ -20,18 +20,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout # Must be done before using composite actions
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
+          fetch-depth: 0 # full history gives Sonar accurate new-code / blame info
           show-progress: false # very verbose for not much
       - name: Install uv
-        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         # uv is needed for qa and deploy, so is kinda always needed. No need to skip it.
         with:
           activate-environment: true
           enable-cache: true
       - name: Install dependencies
         if: ${{ always() }}
-        run: uv sync --frozen --no-install-project --all-groups --all-extras --all-packages
+        run: uv sync --frozen --no-install-project
 
       # Run quality checks
       - name: reuse
@@ -52,16 +53,28 @@ jobs:
       - name: typing
         if: ${{ ! inputs._SKIP_QUALITY && always() }}
         run: poe type
+      - name: typing tests
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe type-tests
       - name: tests
         if: ${{ ! inputs._SKIP_QUALITY && always() }}
-        run: poe tests
+        run: poe tests --relaxed
       - name: doctests
         if: ${{ ! inputs._SKIP_QUALITY && always() }}
-        run: poe doctests
+        run: poe doctests --relaxed
       - name: notebooks-check
         if: ${{ ! inputs._SKIP_QUALITY && always() }}
         run: poe notebooks-check
 
+      # Upload analysis + coverage.xml (produced by the tests step) to SonarCloud.
+      # Skipped on fork PRs, which cannot access the SONAR_TOKEN secret.
+      - name: SonarCloud scan
+        if: ${{ ! inputs._SKIP_QUALITY && !cancelled() && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) }}
+        uses: SonarSource/sonarqube-scan-action@713881670b6b3676cda39549040e2d88c70d582e # v8.2.0
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: https://sonarcloud.io
+
       - name: Stop if any quality step failed
         # All tests are run with always() not to stop on the first error. This step makes the workflow fail if any quality step failed.
         if: ${{ failure() }}

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/workflows/check.yaml

@@ -10,7 +10,7 @@ on:
   push:
     branches: ['main']
   pull_request:
-    types: [opened, synchronize, reopened, closed]
+    types: [opened, synchronize, reopened]
 
 permissions:
   contents: read
@@ -19,3 +19,4 @@ jobs:
   quality:
     name: Quality Checks
     uses: ./.github/workflows/_job_quality_check.yaml
+    secrets: inherit

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/workflows/citations.yaml

@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
     - name: checkout
-      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
     - name: Install R
       run: |
         sudo apt-get update && sudo apt-get install -y r-base

openstef-4.1.1.dev0/.github/workflows/docs-check.yaml

@@ -0,0 +1,62 @@
+# SPDX-FileCopyrightText: 2026 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+# Builds the documentation on PRs WITHOUT deploying it, so that changes which
+# break the docs build (e.g. a dependency bump that breaks notebook execution
+# or static figure export) are caught before they reach main, where the
+# Deploy Documentation workflow would otherwise fail.
+#
+# The build executes the tutorials, so it is slow. It therefore only runs when
+# a PR touches inputs that can affect the build (dependencies, docs sources,
+# example notebooks), and can also be triggered manually from the Actions tab.
+
+name: Docs Build Check
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    paths:
+      - "uv.lock"
+      - "**/pyproject.toml"
+      - "docs/**"
+      - "examples/**"
+      - ".github/workflows/docs-check.yaml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build-docs:
+    name: Build Documentation (no deploy)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          show-progress: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+        with:
+          activate-environment: true
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --no-install-project
+
+      - name: Build Sphinx documentation
+        run: poe docs
+
+      - name: Upload built docs
+        if: ${{ always() }}
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: docs-html
+          path: docs/build/html
+          retention-days: 7
+          if-no-files-found: ignore

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/workflows/docs.yaml

@@ -21,24 +21,24 @@ jobs:
 
     steps:
       - name: Checkout main
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           show-progress: false
       
       - name: Install uv
-        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
           activate-environment: true
           enable-cache: true
       
       - name: Install dependencies
-        run: uv sync --frozen --no-install-project --all-groups --all-extras
+        run: uv sync --frozen --no-install-project
       
       - name: Build Sphinx documentation
         run: poe docs
       
       - name: Checkout gh-pages branch for deployment
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           ref: gh-pages
           path: gh-pages-repo

{openstef-4.0.1 → openstef-4.1.1.dev0}/.github/workflows/release-v4.yaml

@@ -32,21 +32,23 @@ jobs:
     environment: release
     if: ${{ (startsWith(github.ref, 'refs/tags/v4.') || (github.event_name == 'workflow_dispatch' && startsWith(github.event.inputs.version, 'v4'))) && needs.quality.result == 'success' }}
     permissions:
-      # IMPORTANT: this permission is mandatory for trusted publishing
+      # IMPORTANT: this permission is mandatory for trusted publishing and keyless signing
       id-token: write
+      # Required to attach signed artifacts/bundles to the GitHub Release
+      contents: write
     steps:
       - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           fetch-depth: 0
           show-progress: false
       - name: Install uv
-        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
         with:
           activate-environment: true
           enable-cache: true
       - name: Install build dependencies
-        run: uv sync --frozen --no-install-project --all-groups --all-extras
+        run: uv sync --frozen --no-install-project --no-default-groups --group build
 
       # Start of release steps
       - name: Set version from release
@@ -77,7 +79,18 @@ jobs:
         run: poe version --version "${{ steps.ver.outputs.version }}"
       - name: Build all packages
         run: poe build
+      - name: Sign distributions (PEP 740 attestations, keyless OIDC)
+        run: uv run --no-sync pypi-attestations sign dist/*.whl dist/*.tar.gz
       - name: Publish packages
+        # uv uploads the matching *.publish.attestation alongside each distribution
         run: uv publish --trusted-publishing always
+      - name: Sign distributions (Sigstore bundles for offline verification)
+        run: uv run --no-sync sigstore sign dist/*.whl dist/*.tar.gz
+      - name: Attach signed artifacts to the GitHub Release
+        if: ${{ github.event_name == 'release' }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ github.event.release.tag_name }}
+        run: gh release upload "$TAG" dist/*.whl dist/*.tar.gz dist/*.sigstore.json --clobber
       - name: Summary
-        run: echo "Published version ${{ steps.ver.outputs.version }}"
+        run: echo "Published and signed version ${{ steps.ver.outputs.version }}"

{openstef-4.0.1 → openstef-4.1.1.dev0}/.gitignore

@@ -35,10 +35,6 @@ MANIFEST
 # Ruff
 .ruff_cache/
 
-# Pyright
-.pyright/
-# pyright-report/
-
 # Test, coverage, tox
 .pytest_cache/
 .coverage
@@ -69,6 +65,8 @@ docs/_build/
 docs/source/api/generated/
 docs/source/tutorials/
 docs/source/benchmarks/
+# Community health files materialized from OpenSTEF/.github at build time
+docs/source/contribute/_community/
 docs/source/user_guide/**/quick_start_tutorial.py
 docs/source/user_guide/**/feature_engineering_tutorial.py
 docs/source/user_guide/**/datasets_tutorial.py
@@ -135,6 +133,9 @@ benchmark_results*/
 # Local dataset files
 liander_dataset/
 
+# Deployment example run artifacts (MLflow store, forecasts, dataset, Celery/Airflow state)
+openstef_deployment_runs/
+
 # Mlflow
 /mlflow
 /mlflow_artifacts_local

openstef-4.0.1/README.md → openstef-4.1.1.dev0/PKG-INFO

@@ -1,3 +1,43 @@
+Metadata-Version: 2.4
+Name: openstef
+Version: 4.1.1.dev0
+Summary: Open Short Term Energy forecasting library
+Project-URL: Documentation, https://openstef.github.io/openstef/index.html
+Project-URL: Homepage, https://lfenergy.org/projects/openstef/
+Project-URL: Issues, https://github.com/OpenSTEF/openstef/issues
+Project-URL: Repository, https://github.com/OpenSTEF/openstef
+Author-email: "Alliander N.V" <openstef@lfenergy.org>
+License-Expression: MPL-2.0
+License-File: LICENSE.md
+Keywords: energy,forecasting,machinelearning
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: <4.0,>=3.12
+Requires-Dist: openstef-core==4.1.1.dev0
+Requires-Dist: openstef-models[xgb-cpu]==4.1.1.dev0
+Provides-Extra: all
+Requires-Dist: openstef-beam[all]==4.1.1.dev0; extra == 'all'
+Requires-Dist: openstef-core==4.1.1.dev0; extra == 'all'
+Requires-Dist: openstef-foundation-models[cpu]==4.1.1.dev0; extra == 'all'
+Requires-Dist: openstef-meta==4.1.1.dev0; extra == 'all'
+Requires-Dist: openstef-models[xgb-cpu]==4.1.1.dev0; extra == 'all'
+Provides-Extra: beam
+Requires-Dist: huggingface-hub>=0.35.3; extra == 'beam'
+Requires-Dist: openstef-beam==4.1.1.dev0; extra == 'beam'
+Provides-Extra: core
+Requires-Dist: openstef-core==4.1.1.dev0; extra == 'core'
+Provides-Extra: foundation-models
+Requires-Dist: openstef-foundation-models[cpu]==4.1.1.dev0; extra == 'foundation-models'
+Provides-Extra: meta
+Requires-Dist: openstef-meta==4.1.1.dev0; extra == 'meta'
+Provides-Extra: models
+Requires-Dist: openstef-meta==4.1.1.dev0; extra == 'models'
+Requires-Dist: openstef-models[xgb-cpu]==4.1.1.dev0; extra == 'models'
+Description-Content-Type: text/markdown
+
 <!--
 SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
 
@@ -6,7 +46,7 @@ SPDX-License-Identifier: MPL-2.0
 
 <p align="center">
   <a href="https://www.lfenergy.org/projects/openstef/">
-    <img src="https://raw.githubusercontent.com/OpenSTEF/openstef/main/docs/source/_static/logo.png" alt="OpenSTEF Logo" width="400">
+    <img src="https://raw.githubusercontent.com/OpenSTEF/openstef/main/docs/source/logos/openstef-horizontal-color.svg" alt="OpenSTEF Logo" width="400">
   </a>
 </p>
 
@@ -17,7 +57,16 @@ SPDX-License-Identifier: MPL-2.0
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
 [![License: MPL-2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](LICENSE.md)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
-[![Release](https://img.shields.io/badge/release-v4.0.0-blue.svg)](https://github.com/paula-passet/openstef_Sia/releases/tag/release/v4.0.0)
+![GitHub Release](https://img.shields.io/github/v/release/openstef/openstef)
+
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=alert_status)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=security_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+
 
 ## What is OpenSTEF
 
@@ -42,27 +91,46 @@ OpenSTEF 4.0.0 is organized as a monorepo with specialized packages under the `p
 **Requirements:** Python ≥3.12, 64-bit OS (Windows, macOS, Linux)
 
 ```bash
-# Install the complete framework
+# Minimal-but-runnable convenience layer (core + models with CPU XGBoost)
 pip install openstef
 
+# Everything, CPU flavour
+pip install "openstef[all]"
+
 # Or install individual packages
 pip install openstef-models
 pip install openstef-beam
 pip install openstef-core
 
-# With optional features
+# Optional feature extras (additive)
 pip install "openstef-models[lgbm]"
-pip install "openstef-models[xgb-cpu]"
+pip install "openstef-models[tuning]"
 pip install "openstef-beam[all]"
 ```
 
+**Compute runtimes (pick one per package).** Packages with a heavy runtime ship
+mutually exclusive CPU and GPU builds as conflicting extras — install one, not both:
+
+```bash
+# Foundation models (Chronos-2): CPU everywhere, GPU on CUDA Linux/Windows
+pip install "openstef-foundation-models[cpu]"
+pip install "openstef-foundation-models[gpu]"
+
+# XGBoost models: CPU or GPU
+pip install "openstef-models[xgb-cpu]"
+pip install "openstef-models[xgb-gpu]"
+```
+
+The `openstef` meta-package always ships the CPU builds; for GPU, install the
+component package directly with its `[gpu]` extra.
+
 Using [uv](https://docs.astral.sh/uv/) (recommended for development):
 
 ```bash
 uv add openstef
 ```
 
-For the complete installation guide including troubleshooting, see the [Installation Documentation](https://openstef.github.io/openstef/user_guide/installation.html).
+For the complete installation guide including troubleshooting, see the [Installation Documentation](https://openstef.github.io/openstef/user_guide/getting_started/installation.html).
 
 ## Examples
 
@@ -71,7 +139,7 @@ Tutorials and usage examples are available in the [`examples/`](examples/) folde
 - Forecasting quickstart
 - Feature engineering
 
-Additional tutorials are available in the [online documentation](https://openstef.github.io/openstef/user_guide/tutorials.html).
+Additional tutorials are available in the [online documentation](https://openstef.github.io/openstef/examples.html).
 
 ## License
 
@@ -92,15 +160,18 @@ We welcome contributions to OpenSTEF 4.0!
 ### Quick Development Setup
 
 ```bash
-# Clone and set up for development
+# Clone and set up for development (one command installs the full CPU dev env)
 git clone https://github.com/OpenSTEF/openstef.git
 cd openstef
-uv sync --dev
+uv sync
 
 # Run tests and quality checks
 uv run poe all
 ```
 
+> GPU dev env (CUDA; Linux/Windows): `uv sync --no-default-groups --group dev-gpu`.
+> Do not use `--all-groups`/`--all-extras` — the CPU and GPU runtimes conflict.
+
 **Code of Conduct**: We follow the [Contributor Code of Conduct](https://openstef.github.io/openstef/contribute/code_of_conduct.html) to ensure a welcoming environment for all contributors.
 ## Citations
 
@@ -114,4 +185,4 @@ If you use OpenSTEF in your research or publications, please cite the project. R
 - **Email:** openstef@lfenergy.org
 - **Community meeting:** [OpenSTEF four-weekly community meeting](https://lf-energy.atlassian.net/wiki/spaces/OS/pages/32278358/OpenSTEF+four-weekly+community+meeting)
 - **Issues:** [GitHub Issue Tracker](https://github.com/OpenSTEF/openstef/issues)
-- **Support Guide:** [How to get help](https://openstef.github.io/openstef/project/support.html)
+- **Support Guide:** [How to get help](https://openstef.github.io/openstef/project/support.html)

openstef-4.0.1/PKG-INFO → openstef-4.1.1.dev0/README.md

@@ -1,40 +1,3 @@
-Metadata-Version: 2.4
-Name: openstef
-Version: 4.0.1
-Summary: Open Short Term Energy forecasting library
-Project-URL: Documentation, https://openstef.github.io/openstef/index.html
-Project-URL: Homepage, https://lfenergy.org/projects/openstef/
-Project-URL: Issues, https://github.com/OpenSTEF/openstef/issues
-Project-URL: Repository, https://github.com/OpenSTEF/openstef
-Author-email: "Alliander N.V" <openstef@lfenergy.org>
-License-Expression: MPL-2.0
-License-File: LICENSE.md
-Keywords: energy,forecasting,machinelearning
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: <4.0,>=3.12
-Requires-Dist: openstef-core==4.0.1
-Requires-Dist: openstef-models[xgb-cpu]==4.0.1
-Provides-Extra: all
-Requires-Dist: openstef-beam[all]==4.0.1; extra == 'all'
-Requires-Dist: openstef-core==4.0.1; extra == 'all'
-Requires-Dist: openstef-meta==4.0.1; extra == 'all'
-Requires-Dist: openstef-models[xgb-cpu]==4.0.1; extra == 'all'
-Provides-Extra: beam
-Requires-Dist: huggingface-hub>=0.35.3; extra == 'beam'
-Requires-Dist: openstef-beam==4.0.1; extra == 'beam'
-Provides-Extra: core
-Requires-Dist: openstef-core==4.0.1; extra == 'core'
-Provides-Extra: meta
-Requires-Dist: openstef-meta==4.0.1; extra == 'meta'
-Provides-Extra: models
-Requires-Dist: openstef-meta==4.0.1; extra == 'models'
-Requires-Dist: openstef-models[xgb-cpu]==4.0.1; extra == 'models'
-Description-Content-Type: text/markdown
-
 <!--
 SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
 
@@ -43,7 +6,7 @@ SPDX-License-Identifier: MPL-2.0
 
 <p align="center">
   <a href="https://www.lfenergy.org/projects/openstef/">
-    <img src="https://raw.githubusercontent.com/OpenSTEF/openstef/main/docs/source/_static/logo.png" alt="OpenSTEF Logo" width="400">
+    <img src="https://raw.githubusercontent.com/OpenSTEF/openstef/main/docs/source/logos/openstef-horizontal-color.svg" alt="OpenSTEF Logo" width="400">
   </a>
 </p>
 
@@ -54,7 +17,16 @@ SPDX-License-Identifier: MPL-2.0
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5585/badge)](https://bestpractices.coreinfrastructure.org/projects/5585)
 [![License: MPL-2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](LICENSE.md)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
-[![Release](https://img.shields.io/badge/release-v4.0.0-blue.svg)](https://github.com/paula-passet/openstef_Sia/releases/tag/release/v4.0.0)
+![GitHub Release](https://img.shields.io/github/v/release/openstef/openstef)
+
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=alert_status)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=coverage)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=security_rating)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=OpenSTEF_openstef&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=OpenSTEF_openstef)
+
 
 ## What is OpenSTEF
 
@@ -79,27 +51,46 @@ OpenSTEF 4.0.0 is organized as a monorepo with specialized packages under the `p
 **Requirements:** Python ≥3.12, 64-bit OS (Windows, macOS, Linux)
 
 ```bash
-# Install the complete framework
+# Minimal-but-runnable convenience layer (core + models with CPU XGBoost)
 pip install openstef
 
+# Everything, CPU flavour
+pip install "openstef[all]"
+
 # Or install individual packages
 pip install openstef-models
 pip install openstef-beam
 pip install openstef-core
 
-# With optional features
+# Optional feature extras (additive)
 pip install "openstef-models[lgbm]"
-pip install "openstef-models[xgb-cpu]"
+pip install "openstef-models[tuning]"
 pip install "openstef-beam[all]"
 ```
 
+**Compute runtimes (pick one per package).** Packages with a heavy runtime ship
+mutually exclusive CPU and GPU builds as conflicting extras — install one, not both:
+
+```bash
+# Foundation models (Chronos-2): CPU everywhere, GPU on CUDA Linux/Windows
+pip install "openstef-foundation-models[cpu]"
+pip install "openstef-foundation-models[gpu]"
+
+# XGBoost models: CPU or GPU
+pip install "openstef-models[xgb-cpu]"
+pip install "openstef-models[xgb-gpu]"
+```
+
+The `openstef` meta-package always ships the CPU builds; for GPU, install the
+component package directly with its `[gpu]` extra.
+
 Using [uv](https://docs.astral.sh/uv/) (recommended for development):
 
 ```bash
 uv add openstef
 ```
 
-For the complete installation guide including troubleshooting, see the [Installation Documentation](https://openstef.github.io/openstef/user_guide/installation.html).
+For the complete installation guide including troubleshooting, see the [Installation Documentation](https://openstef.github.io/openstef/user_guide/getting_started/installation.html).
 
 ## Examples
 
@@ -108,7 +99,7 @@ Tutorials and usage examples are available in the [`examples/`](examples/) folde
 - Forecasting quickstart
 - Feature engineering
 
-Additional tutorials are available in the [online documentation](https://openstef.github.io/openstef/user_guide/tutorials.html).
+Additional tutorials are available in the [online documentation](https://openstef.github.io/openstef/examples.html).
 
 ## License
 
@@ -129,15 +120,18 @@ We welcome contributions to OpenSTEF 4.0!
 ### Quick Development Setup
 
 ```bash
-# Clone and set up for development
+# Clone and set up for development (one command installs the full CPU dev env)
 git clone https://github.com/OpenSTEF/openstef.git
 cd openstef
-uv sync --dev
+uv sync
 
 # Run tests and quality checks
 uv run poe all
 ```
 
+> GPU dev env (CUDA; Linux/Windows): `uv sync --no-default-groups --group dev-gpu`.
+> Do not use `--all-groups`/`--all-extras` — the CPU and GPU runtimes conflict.
+
 **Code of Conduct**: We follow the [Contributor Code of Conduct](https://openstef.github.io/openstef/contribute/code_of_conduct.html) to ensure a welcoming environment for all contributors.
 ## Citations
 
@@ -151,4 +145,4 @@ If you use OpenSTEF in your research or publications, please cite the project. R
 - **Email:** openstef@lfenergy.org
 - **Community meeting:** [OpenSTEF four-weekly community meeting](https://lf-energy.atlassian.net/wiki/spaces/OS/pages/32278358/OpenSTEF+four-weekly+community+meeting)
 - **Issues:** [GitHub Issue Tracker](https://github.com/OpenSTEF/openstef/issues)
-- **Support Guide:** [How to get help](https://openstef.github.io/openstef/project/support.html)
+- **Support Guide:** [How to get help](https://openstef.github.io/openstef/project/support.html)