Skip to content

Commit f4dce74

Browse files
authored
Merge pull request #133 from cyiallou/chore/prepare-release
Prepare for release
2 parents 76016fd + 5c09c5b commit f4dce74

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

RELEASE_NOTES.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,12 @@
66

77
## Upgrading
88

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

1111
## New Features
1212

13-
- Added consistent logger setup across all modules for structured logging and improved observability. Example notebooks updated to demonstrate logger usage.
14-
- 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.
15-
- `MicrogridData` class needs to be initialized with a `MicrogridConfig` object instead of a path to config file(s).
16-
- Added a transactional stateful data fetcher.
17-
- Added a new `state_analysis` module for detecting and analysing component state transitions and alerts from reporting data.
18-
- Provides structured `StateRecord` objects with human-readable enum names.
19-
- Supports filtering for alert states and warnings.
20-
- Includes full test coverage for transition detection and alert filtering logic.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
2114

2215
## Bug Fixes
2316

24-
- 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.
25-
- Fixed an issue where `EmailNotification` did not properly initialise its scheduler. Also fixed an example in the docstring.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)