v0.11.0

Tooling Library for Notebooks Release Notes

Summary

Upgrading

New Features

• Added consistent logger setup across all modules for structured logging and improved observability. Example notebooks updated to demonstrate logger usage.
• The signature for passing config files MicrogridConfig.load_config() has been changed to accept a path a list of paths and a directory containing the config files.
• MicrogridData class needs to be initialized with a MicrogridConfig object instead of a path to config file(s).
• Added a transactional stateful data fetcher.
• Added a new state_analysis module for detecting and analysing component state transitions and alerts from reporting data.
  • Provides structured StateRecord objects with human-readable enum names.
  • Supports filtering for alert states and warnings.
  • Includes full test coverage for transition detection and alert filtering logic.

Bug Fixes

• Fixed a bug in the notification Scheduler where tasks could overrun the configured duration due to imprecise sleep and stop logic. The scheduler now correctly tracks elapsed time, respects task execution duration, and stops reliably after the intended interval.
• Fixed an issue where EmailNotification did not properly initialise its scheduler. Also fixed an example in the docstring.

What's Changed

• Fix Scheduler and its instantiation inside EmailNotification by @cyiallou in #127
• Minor doc fix and clarification by @cyiallou in #128
• Add consistent logger setup across all modules by @cyiallou in #125
• Refactor config file arguments of MicrogridData and MicrogridConfig classes by @matthias-wende-frequenz in #104
• Add transactional stateful data fetcher by @matthias-wende-frequenz in #130
• Add state analysis module for extracting component state transitions and alerts by @cyiallou in #131

New Contributors

• @matthias-wende-frequenz made their first contribution in #104

Full Changelog: v0.10.1...v0.11.0