Skip to content

docs: add OpenSTEF workshop to docs - #1085

Merged
lschilders merged 8 commits into
mainfrom
lfenergy-workshop
Sep 11, 2026
Merged

docs: add OpenSTEF workshop to docs#1085
lschilders merged 8 commits into
mainfrom
lfenergy-workshop

Conversation

@lschilders

@lschilders lschilders commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

This PR adds an OpenSTEF workshop notebook to the examples/tutorials. It can be run locally, but it is also embedded in the documentation page.

Type of change

  • Bug fix
  • New feature
  • Breaking change (see checklist below)
  • Documentation
  • Refactor / chore / CI

Breaking changes checklist

  • Public API, config schema, or serialized/pickled objects changed in a way that affects existing users
  • If yes: see the breaking changes guide for the pickle/_migrate_state migration pattern

Migration path for existing users (e.g. "old pickled XScaler objects auto-migrate on load", "users must now pass X explicitly"):

AI disclosure

  • No AI assistance was used (beyond grammar/spelling)
  • AI assistance was used — tool(s):
    • I have reviewed, understand, and can explain all AI-generated code in this PR
    • This is disclosed in a commit message (e.g. Assisted-by: <tool name>)

Checklist

  • poe all --check passes locally
  • Tests added/updated for the change
  • Documentation updated (docstrings, user guide, examples) if needed
  • Commits are signed off per our DCO (git commit -s)
  • PR title follows Conventional Commits (e.g. feat: ..., fix: ..., feat!: ... for breaking changes)

Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
@lschilders
lschilders requested a review from a team September 11, 2026 08:00
Comment thread examples/tutorials/workshop.py Dismissed
bartpleiter
bartpleiter previously approved these changes Sep 11, 2026
lschilders and others added 2 commits September 11, 2026 12:48
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
Signed-off-by: Lars Schilders <lars.schilders@alliander.com>
@sonarqubecloud

Copy link
Copy Markdown

@lschilders
lschilders merged commit 1456a7f into main Sep 11, 2026
7 checks passed
@lschilders
lschilders deleted the lfenergy-workshop branch September 11, 2026 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants