Skip to content

Prepare for release #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2025
Merged

Prepare for release #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,12 @@

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
- Minor updates to "Alerts Notebook" and "Solar Maintenance" notebooks to utilise new functionality, simplify parts of the notebooks' code, and update the documentation.
Copy link

Copilot AI Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The word 'utilise' should be 'utilize' for consistency with American English spelling conventions typically used in software documentation.

Suggested change
- Minor updates to "Alerts Notebook" and "Solar Maintenance" notebooks to utilise new functionality, simplify parts of the notebooks' code, and update the documentation.
- Minor updates to "Alerts Notebook" and "Solar Maintenance" notebooks to utilize new functionality, simplify parts of the notebooks' code, and update the documentation.

Copilot uses AI. Check for mistakes.

## 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.
<!-- Here goes the main new features and examples or instructions on how to use them -->

## 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.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
Loading