Skip to content

Commit 892403e

Browse files
authored
Prepare release notes for the 1.0.0-rc1 release (#674)
2 parents 26590c0 + 59fde4d commit 892403e

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

RELEASE_NOTES.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
## Summary
44

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

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
119
- 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`.
1210

1311
- 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 @@
2826
assert_never(unreachable)
2927
```
3028

31-
## New Features
29+
- `Averager` was removed from `FormulaEngine`.
3230

33-
<!-- Here goes the main new features and examples or instructions on how to use them -->
31+
## New Features
3432

3533
- 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`.
3634

@@ -56,8 +54,6 @@
5654

5755
- The `min` and `max` functions in the `FormulaEngine` are now public. Note that the same functions have been public in the builder.
5856

59-
- Drop `Averager` from `FormulaEngine`.
60-
6157
## Bug Fixes
6258

6359
- `OrderedRingBuffer.window`:

0 commit comments

Comments
 (0)