|
12 | 12 | battery_power_receiver = microgrid.battery_pool().power.new_receiver() |
13 | 13 | ``` |
14 | 14 |
|
15 | | -+ Formulas composition has changed (#327) - |
16 | | - - receivers from formulas are no longer composable. |
17 | | - - formula composition is now done by composing FormulaEngine instances. |
18 | | - - Automatic formulas from the logical meter and *pools, are now |
19 | | - properties, and return `FormulaEngine` instances, which can be |
20 | | - composed further, or can provide a receiver to fetch values. |
| 15 | +* Formulas composition has changed (#327) |
| 16 | + * Receivers from formulas are no longer composable. |
| 17 | + * Formula composition is now done by composing FormulaEngine instances. |
| 18 | + * Automatic formulas from the logical meter and \*pools, are now properties, and return `FormulaEngine` instances, which can be composed further, or can provide a receiver to fetch values. |
21 | 19 |
|
22 | 20 | ``` python |
23 | 21 | grid_power_receiver = microgrid.logical_meter().grid_power.new_receiver() |
|
30 | 28 | inverter_power_receiver = self._inverter_power.new_receiver() |
31 | 29 | ``` |
32 | 30 |
|
33 | | -* Update BatteryStatus to mark battery with unknown capacity as not working (#263) |
| 31 | +* Update `BatteryStatus` to mark battery with unknown capacity as not working (#263) |
34 | 32 | * The channels dependency was updated to v0.14.0 (#292) |
35 | 33 | * Some properties for `PowerDistributingActor` results were renamed to be more consistent between `Success` and `PartialFailure`: |
36 | 34 | * The `Success.used_batteries` property was renamed to `succeeded_batteries`. |
37 | 35 | * The `PartialFailure.success_batteries` property was renamed to `succeeded_batteries`. |
38 | 36 | * The `succeed_power` property was renamed to `succeeded_power` for both `Success` and `PartialFailure`. |
39 | | -* Update MovingWindow to accept size parameter as timedelta instead of int (#269). |
| 37 | +* Update `MovingWindow` to accept the `size` parameter as `timedelta` instead of `int` (#269). |
40 | 38 | This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored. |
41 | | -* Add a resampler in the MovingWindow to control the granularity of the samples to be stored in the underlying buffer (#269). |
| 39 | +* Add a resampler in the `MovingWindow` to control the granularity of the samples to be stored in the underlying buffer (#269). |
42 | 40 | Notice that the parameter `sampling_period` has been renamed to `input_sampling_period` |
43 | 41 | to better distinguish it from the sampling period parameter in the resampler. |
44 | 42 | * The serialization feature for the ringbuffer was made more flexible. The `dump` and `load` methods can now work directly with a ringbuffer instance. |
|
47 | 45 |
|
48 | 46 | ## New Features |
49 | 47 |
|
50 | | -* Automatic creation of core data-pipeline actors, to eliminate a lot |
51 | | - of boiler plate code. This makes it much simpler to deploy apps |
52 | | - (#270). For example: |
| 48 | +* The core data-pipeline actors are now created automatically (#270). |
| 49 | + |
| 50 | + This eliminates a lot of boiler plate code and makes it much simpler to deploy apps. |
| 51 | + |
| 52 | + For example: |
53 | 53 |
|
54 | 54 | ``` python |
55 | 55 | async def run(): |
|
59 | 59 | grid_power = microgrid.logical_meter().grid_power() |
60 | 60 | ``` |
61 | 61 |
|
62 | | -* The `Result` class (and subclasses) for the `PowerDistributingActor` are now dataclasses, so logging them will produce a more detailed output. |
| 62 | +* The `Result` class (and subclasses) for the `PowerDistributingActor` are now `dataclass`es, so logging them will produce a more detailed output. |
63 | 63 |
|
64 | 64 | ## Bug Fixes |
65 | 65 |
|
66 | | -* Change PowerDistributor to use all batteries if none is working (#258) |
67 | | -* Update the ordered ring buffer to fix the len() function so that it returns a value equal to or greater than zero, as expected (#274) |
| 66 | +* Change `PowerDistributor` to use all batteries when none are working (#258) |
| 67 | +* Update the ordered ring buffer to fix the `len()` function so that it returns a value equal to or greater than zero, as expected (#274) |
0 commit comments