openstef 4.0.0.dev1__tar.gz → 4.1.0__tar.gz

openstef-4.1.0/.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+# Require review from maintainers for CI/CD workflow changes
+.github/workflows/ @OpenSTEF/openstef-maintainers
+.github/CODEOWNERS @OpenSTEF/openstef-maintainers

openstef-4.1.0/.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.1.0/.github/dependabot.yml

@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2026 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+# 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.
+
+version: 2
+
+updates:
+  - package-ecosystem: uv
+    directories:
+      - "/"
+      - "/docs"
+      - "/examples"
+      - "/packages/openstef-beam"
+      - "/packages/openstef-core"
+      - "/packages/openstef-meta"
+      - "/packages/openstef-models"
+    schedule:
+      interval: daily
+      time: "06:00"
+      timezone: Europe/Amsterdam
+    open-pull-requests-limit: 10
+    versioning-strategy: lockfile-only
+    commit-message:
+      prefix: "chore(deps)"
+      include: scope
+    labels:
+      - dependencies
+      - python:uv
+    cooldown:
+      default-days: 3
+      semver-patch-days: 2
+      semver-minor-days: 5
+      semver-major-days: 7
+    groups:
+      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
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "06:00"
+      timezone: Europe/Amsterdam
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "chore(ci)"
+      include: scope
+    labels:
+      - dependencies
+      - github-actions
+    cooldown:
+      default-days: 3
+    groups:
+      actions-all:
+        patterns: ["*"]

openstef-4.1.0/.github/pr-labeler.yml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+# config of action in ./workflows/...
+feature: ['feature*', 'feat*']
+fix: ['fix*','bugfix*','hotfix*', 'bug*']
+chore: ['chore*', 'doc*']

openstef-4.1.0/.github/workflows/_job_quality_check.yaml

@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Quality Check
+on:
+  workflow_call:
+    inputs:
+      # _SKIP*: sometimes you want to quickly test something, without having the whole suite kicking in.
+      # This is a lazy way to switch on and off steps. But never set it to true in main.
+      _SKIP_QUALITY:
+        type: boolean
+        default: false
+        description: for debug purposes only - if true skip all quality checks.
+
+jobs:
+  builder:
+    name: Quality Checks
+    # Avoid duplicate runs: run on push (same-repo branches) OR on pull_request only if from a fork
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout # Must be done before using composite actions
+        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@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
+
+      # Run quality checks
+      - name: reuse
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe reuse
+      - name: licensecheck
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe licensecheck --check
+      - name: lint
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe lint --check
+      - name: format
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe format --check
+      - name: format-pyproject
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe format-pyproject --check
+      - 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
+      - name: doctests
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe doctests
+      - 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() }}
+        run: exit 1

openstef-4.1.0/.github/workflows/check.yaml

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+name: Quality Check
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Quality Checks
+    uses: ./.github/workflows/_job_quality_check.yaml
+    secrets: inherit

openstef-4.1.0/.github/workflows/citations.yaml

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Validate citation
+
+on:
+  # Run pipeline on push event of main branch, or when CITATIONS path has changed
+  push:
+    branches:
+      - main
+    paths:
+      - CITATION.cff
+      - .github/workflows/citations.yml
+  pull_request:
+    paths:
+      - CITATION.cff
+      - .github/workflows/citations.yml
+  # Run pipeline from another workflow
+  workflow_call:
+  # Run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-citations
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  validate-citations:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: checkout
+      uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+    - name: Install R
+      run: |
+        sudo apt-get update && sudo apt-get install -y r-base
+    - name: Validate CITATION.cff
+      uses: dieghernan/cff-validator@54c8e737314b948f25c0e5524a9d8ae3f39b207b # v5.0.1

openstef-4.1.0/.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.1.0/.github/workflows/docs.yaml

@@ -0,0 +1,89 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-docs:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main
+        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: Checkout gh-pages branch for deployment
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          ref: gh-pages
+          path: gh-pages-repo
+          show-progress: false
+      
+      - name: Update documentation
+        run: |
+          # One-shot: archive the existing v3 site into /v3/ if not already done.
+          # Detected by absence of /v3/ and presence of index.html at the root.
+          if [ ! -d gh-pages-repo/v3 ] && [ -f gh-pages-repo/index.html ]; then
+            echo "Archiving existing v3 documentation to gh-pages-repo/v3/"
+            mkdir -p gh-pages-repo/v3
+            find gh-pages-repo -maxdepth 1 -mindepth 1 \
+              ! -name v3 ! -name v4 ! -name .git ! -name .nojekyll \
+              -exec mv {} gh-pages-repo/v3/ \;
+          fi
+
+          # Clear root (but preserve /v3/, /v4/, .git, .nojekyll) and deploy.
+          find gh-pages-repo -maxdepth 1 -mindepth 1 \
+            ! -name v3 ! -name v4 ! -name .git ! -name .nojekyll \
+            -exec rm -rf {} +
+          cp -r docs/build/html/. gh-pages-repo/
+
+      - name: Configure git, stage, and commit changes
+        run: |
+            cd gh-pages-repo
+
+            # Configure git
+            git config --local user.email "action@github.com"
+            git config --local user.name "GitHub Action"
+
+            # Stage changes
+            git add -A
+
+            # Check if there are staged changes and commit if so
+            if ! git diff --staged --quiet; then
+                git commit -m "Deploy documentation from $(echo $GITHUB_SHA | cut -c1-7)"
+                echo "✅ Changes committed successfully"
+            else
+                echo "ℹ️ No changes to commit"
+            fi
+      
+      - name: Push changes to gh-pages
+        uses: ad-m/github-push-action@881a6320fdb16eb5318c5054f31c218aec2b324c # v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          directory: gh-pages-repo

openstef-4.1.0/.github/workflows/pr-labeler.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2017-2022 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+# Automatically label PRs, config in ../pr-labler.yml
+name: PR Labeler
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  pr-labeler:
+    permissions:
+        contents: read # To read config file
+        pull-requests: write # To add labels
+    runs-on: ubuntu-latest
+    steps:
+      - uses: TimonVS/pr-labeler-action@f9c084306ce8b3f488a8f3ee1ccedc6da131d1af # v5
+        with:
+          configuration-path: .github/pr-labeler.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

openstef-4.1.0/.github/workflows/release-v4.yaml

@@ -0,0 +1,83 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+name: Release V4
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version tag to release (e.g., v4.1.0 or 4.1.0). Prefixing with v is optional.'
+        required: true
+        default: ""
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    if: ${{ startsWith(github.ref, 'refs/tags/v4.') || (github.event_name == 'workflow_dispatch' && startsWith(github.event.inputs.version, 'v4')) }}
+    name: Quality Checks
+    uses: ./.github/workflows/_job_quality_check.yaml
+
+  release-pypi:
+    name: Release PyPI Package
+    needs: quality
+    runs-on: ubuntu-latest
+    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
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          fetch-depth: 0
+          show-progress: false
+      - name: Install uv
+        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 --no-default-groups --group build
+
+      # Start of release steps
+      - name: Set version from release
+        id: ver
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+          INPUT_VERSION: ${{ github.event.inputs.version }}
+        run: |
+          # Prefer release payload tag_name, otherwise fallback to the workflow_dispatch input
+          if [ -n "$RELEASE_TAG" ]; then
+            VERSION="$RELEASE_TAG"
+          elif [ -n "$INPUT_VERSION" ]; then
+            VERSION="$INPUT_VERSION"
+          else
+            # As a last-resort fallback, try to get the ref tag from GITHUB_REF
+            if [[ "$GITHUB_REF" == refs/tags/* ]]; then
+              VERSION="${GITHUB_REF#refs/tags/}"
+            else
+              echo "No version provided via release or workflow input, aborting"
+              exit 1
+            fi
+          fi
+          # Remove leading 'v' if present
+          VERSION="${VERSION#v}"
+          echo "Release version: $VERSION"
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+      - name: Apply version
+        run: poe version --version "${{ steps.ver.outputs.version }}"
+      - name: Build all packages
+        run: poe build
+      - name: Publish packages
+        run: uv publish --trusted-publishing always
+      - name: Summary
+        run: echo "Published version ${{ steps.ver.outputs.version }}"

openstef-4.1.0/.gitignore

@@ -0,0 +1,147 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org> # noqa E501>
+# SPDX-License-Identifier: MPL-2.0
+
+# Core
+config.user.yaml
+git-template
+.DS_Store
+tmp
+
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Packaging and build artifacts
+.Python
+build/
+dist/
+downloads/
+wheels/
+share/python-wheels/
+sdist/
+.eggs/
+*.egg-info/
+*.egg
+.installed.cfg
+MANIFEST
+
+# uv
+.uv/
+
+# Ruff
+.ruff_cache/
+
+# Test, coverage, tox
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.cover/
+cover/
+pytest-report.xml
+.tox/
+.nox/
+coverage.xml
+
+# Hypothesis
+.hypothesis/
+
+# Cython
+cython_debug/
+
+# Type checkers (misc)
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pytype/
+.pyre/
+
+# Sphinx
+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
+docs/source/user_guide/**/backtesting_tutorial.py
+
+# docs/_doctrees/
+# docs/_static_gen/
+
+# Editors: JetBrains
+.idea/
+
+# Editors: VS Code (allow shared configs)
+.vscode/*
+
+# Jupyter / IPython
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+
+# Spyder / Rope
+.spyderproject
+.spyproject
+.ropeproject
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# PEP 582
+__pypackages__/
+
+# web frameworks / services
+*.sqlite
+*.sqlite3
+*.log
+instance/
+.webassets-cache
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+tmp/
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Project outputs
+output/
+prof/
+certificates/
+
+# Output artifacts
+*.html
+*.pkl
+
+# Benchmark outputs
+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
+
+.github/instructions
+
+# Jupyter notebook cache (myst-nb execution outputs)
+.jupyter_cache/
+docs/build.zip