Skip to content

Commit

Permalink
Prepare release notes for the 1.0.0-rc1 release (#674)
Browse files Browse the repository at this point in the history
  • Loading branch information
llucax authored Sep 14, 2023
2 parents 26590c0 + 59fde4d commit 892403e
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

## Summary

<!-- Here goes a general summary of what this release is about -->
The most notable changes are the addition of `microgrid.grid` and `microgrid.frequency()`, as the many improvements to the `MovingWindow`.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

- 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:
Expand All @@ -28,9 +26,9 @@
assert_never(unreachable)
```

## New Features
- `Averager` was removed from `FormulaEngine`.

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

Expand All @@ -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`:
Expand Down

0 comments on commit 892403e

Please sign in to comment.