diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 983f98917..1126e2d00 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,12 +2,10 @@ ## Summary - +The most notable changes are the addition of `microgrid.grid` and `microgrid.frequency()`, as the many improvements to the `MovingWindow`. ## Upgrading - - - The battery pool metric methods no longer return `None` when no batteries are available. Instead, the value of the `Sample` or `PowerMetric` is set to `None`. - The power distribution `Result` is now a union of all different types of results rather than a base class. This means we can now also use `match` to check for result types instead of only using `isinstance()`. The following example shows how `Result` can be used for matching power distribution results: @@ -28,9 +26,9 @@ assert_never(unreachable) ``` -## New Features +- `Averager` was removed from `FormulaEngine`. - +## New Features - Calling `microgrid.initialize()` now also initializes the microgrid's grid connection point as a singleton object of a newly added type `Grid`. This object can be obtained by calling `microgrid.grid.get()`. This object exposes the max current that can course through the grid connection point, which is useful for the power distribution algorithm. The max current is provided by the Microgrid API, and can be obtained by calling `microgrid.grid.get().fuse.max_current`. @@ -56,8 +54,6 @@ - The `min` and `max` functions in the `FormulaEngine` are now public. Note that the same functions have been public in the builder. -- Drop `Averager` from `FormulaEngine`. - ## Bug Fixes - `OrderedRingBuffer.window`: