v0.20.0

[github-actions[bot]]

Release Notes

Summary

Upgrading

• Battery power is no longer available through the LogicalMeter, but through the BatteryPool (Add power formula to BatteryPool #338)

  battery_power_receiver = microgrid.battery_pool().power.new_receiver()

• Formulas composition has changed (Make FormulaEngine instances composable, instead of FormulaReceivers #327)

  • Receivers from formulas are no longer composable.
  • Formula composition is now done by composing FormulaEngine instances.
  • 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.

  grid_power_receiver = microgrid.logical_meter().grid_power.new_receiver()
  
  self._inverter_power = (
      microgrid.logical_meter().pv_power
      + microgrid.battery_pool().power
  ).build("inverter_power")
  
  inverter_power_receiver = self._inverter_power.new_receiver()

• Update BatteryStatus to mark battery with unknown capacity as not working (Check battery capacity in BatteryStatus #263)

• The channels dependency was updated to v0.14.0 (Update SDK dependency of channels to the new release 0.14 #292)

• Some properties for PowerDistributingActor results were renamed to be more consistent between Success and PartialFailure:

  • The Success.used_batteries property was renamed to succeeded_batteries.
  • The PartialFailure.success_batteries property was renamed to succeeded_batteries.
  • The succeed_power property was renamed to succeeded_power for both Success and PartialFailure.

• MovingWindow

  • The class is now publicly available in the frequenz.sdk.timeseries package.

  • Accept the size parameter as timedelta instead of int (Add resampler to MovingWindow #269).

    This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored.

  • The input data will be resampled if a resampler_config is passed (Add resampler to MovingWindow #269).

    This allows controlling the granularity of the samples to be stored in the underlying buffer.

    Note that the parameter sampling_period has been renamed to input_sampling_period to better distinguish it from the sampling period parameter in the resampler_config.

  • Rename the constructor argument window_alignment to align_to and change the default to UNIX_EPOCH. This is to make it more consistent with the ResamplerConfig.

• Resampler

  • The ResamplerConfig class is now publicly available in the frequenz.sdk.timeseries package.

  • The ResamplerConfig now takes the resampling period as a timedelta. The configuration was renamed from resampling_period_s to resampling_period accordingly.

  • The SourceProperties of the resampler now uses a timedelta for the input sampling period. The attribute was renamed from sampling_period_s to sampling_period accordingly.

  • The periods are now aligned to the UNIX_EPOCH by default.

    To use the old behaviour (aligning to the time the resampler was created), pass align_to=None to the ResamplerConfig.

New Features

• The core data-pipeline actors are now created automatically (Add a DataPipeline implementation #270).

  This eliminates a lot of boiler plate code and makes it much simpler to deploy apps.

  For example:

  async def run():
      await microgrid.initialize(
          host=HOST, port=PORT, resampler_config=ResamplerConfig(resampling_period_s=1.0)
      )
      grid_power = microgrid.logical_meter().grid_power()

• The Result class (and subclasses) for the PowerDistributingActor are now dataclasses, so logging them will produce a more detailed output.

• The Resampler can now can align the resampling period to an arbitrary datetime.

  This can be configured via the new align_to option in the ResamplerConfig. By default the resampling period is aligned to the UNIX_EPOCH.

Bug Fixes

• Change PowerDistributor to use all batteries when none are working (Use all batteries when none are working in PowerDistributor #258)

• Update the ordered ring buffer used by the MovingWindow to fix the len() function so that it returns a value equal to or greater than zero, as expected (Fix len() of the OrderedRingBuffer #274)

What's Changed

• Power Distributing: Documentation enhancements by @mathias-baumann-frequenz in Power Distributing: Documentation enhancements #257
• Clean release notes by @ela-kotulska-frequenz in Clean release notes #271
• Check battery capacity in BatteryStatus by @ela-kotulska-frequenz in Check battery capacity in BatteryStatus #263
• Use all batteries when none are working in PowerDistributor by @ela-kotulska-frequenz in Use all batteries when none are working in PowerDistributor #258
• Configure dependabot to automated version updates by @daniel-zullo-frequenz in Configure dependabot to automated version updates #268
• Bump pylint from 2.17.0 to 2.17.1 by @dependabot in Bump pylint from 2.17.0 to 2.17.1 #288
• Bump mypy from 1.0.1 to 1.1.1 by @dependabot in Bump mypy from 1.0.1 to 1.1.1 #286
• Bump actions/labeler from 4.0.1 to 4.0.3 by @dependabot in Bump actions/labeler from 4.0.1 to 4.0.3 #279
• Bump pytest from 7.2.1 to 7.2.2 by @dependabot in Bump pytest from 7.2.1 to 7.2.2 #287
• Bump black from 23.1.0 to 23.3.0 by @dependabot in Bump black from 23.1.0 to 23.3.0 #284
• Update channels dependency to v0.14.0 by @mathias-baumann-frequenz in Update channels dependency to v0.14.0 #295
• Various small fixes by @mathias-baumann-frequenz in Various small fixes #277
• Fix len() of the OrderedRingBuffer by @daniel-zullo-frequenz in Fix len() of the OrderedRingBuffer #274
• Bump pytest-asyncio from 0.20.3 to 0.21.0 by @dependabot in Bump pytest-asyncio from 0.20.3 to 0.21.0 #281
• Bump mkdocstrings[python] from 0.19.1 to 0.20.0 by @dependabot in Bump mkdocstrings[python] from 0.19.1 to 0.20.0 #283
• Update networkx requirement from <3,>=2.8 to >=2.8,<4 by @dependabot in Update networkx requirement from <3,>=2.8 to >=2.8,<4 #282
• Bump mkdocs-material from 8.5.11 to 9.1.5 by @dependabot in Bump mkdocs-material from 8.5.11 to 9.1.5 #298
• Add a DataPipeline implementation by @shsms in Add a DataPipeline implementation #270
• Bump pylint from 2.17.1 to 2.17.2 by @dependabot in Bump pylint from 2.17.1 to 2.17.2 #300
• Use a bigger request receiver buffer size in data pipeline actors by @shsms in Use a bigger request receiver buffer size in data pipeline actors #302
• Refactor power distributor's Results by @leandro-lucarella-frequenz in Refactor power distributor's Results #305
• Bump mkdocstrings[python] from 0.20.0 to 0.21.1 by @dependabot in Bump mkdocstrings[python] from 0.20.0 to 0.21.1 #308
• Add component_data method to EVChargerPool by @shsms in Add component_data method to EVChargerPool #266
• benchmark data sourcing actor by @mathias-baumann-frequenz in benchmark data sourcing actor #211
• Add ringbuffer memory benchmark by @mathias-baumann-frequenz in Add ringbuffer memory benchmark #278
• Update MovingWindow to add resampler by @daniel-zullo-frequenz in Update MovingWindow to add resampler #272
• Bump mkdocs-material from 9.1.5 to 9.1.6 by @dependabot in Bump mkdocs-material from 9.1.5 to 9.1.6 #312
• Add a EVChargerPool.set_bounds method for setting current bounds by @shsms in Add a EVChargerPool.set_bounds method for setting current bounds #297
• Bump mkdocstrings[python] from 0.21.1 to 0.21.2 by @dependabot in Bump mkdocstrings[python] from 0.21.1 to 0.21.2 #309
• Bump pytest from 7.2.2 to 7.3.0 by @dependabot in Bump pytest from 7.2.2 to 7.3.0 #313
• Bump mypy from 1.1.1 to 1.2.0 by @dependabot in Bump mypy from 1.1.1 to 1.2.0 #310
• Add BatteryPool and PowerDistributingActor to the DataPipeline by @sahas-subramanian-frequenz in Add BatteryPool and PowerDistributingActor to the DataPipeline #317
• Expose BatteryPool and PowerDistributingHandle from sdk.microgrid by @sahas-subramanian-frequenz in Expose BatteryPool and PowerDistributingHandle from sdk.microgrid #323
• Fix ring buffer benchmarks by @daniel-zullo-frequenz in Fix ring buffer benchmarks #324
• Make interface for serializing a ringbuffer more flexible. by @mathias-baumann-frequenz in Make interface for serializing a ringbuffer more flexible. #326
• Ringbuffer: Moved files into a package by @mathias-baumann-frequenz in Ringbuffer: Moved files into a package #329
• Update BatteryPool tests, examples to use microgrid.battery_pool() by @sahas-subramanian-frequenz in Update BatteryPool tests, examples to use microgrid.battery_pool() #336
• Bump pytest from 7.3.0 to 7.3.1 by @dependabot in Bump pytest from 7.3.0 to 7.3.1 #339
• Make the resampler use timedelta for periods by @leandro-lucarella-frequenz in Make the resampler use timedelta for periods #334
• Bump frequenz-floss/setup-git-user from 1 to 2 by @dependabot in Bump frequenz-floss/setup-git-user from 1 to 2 #345
• Make FormulaEngine instances composable, instead of FormulaReceivers by @sahas-subramanian-frequenz in Make FormulaEngine instances composable, instead of FormulaReceivers #327
• Add power formula to BatteryPool by @sahas-subramanian-frequenz in Add power formula to BatteryPool #338
• Add an option to align resampling windows by @leandro-lucarella-frequenz in Add an option to align resampling windows #335
• Increase sample_rate in some formula tests to reduce flakiness by @sahas-subramanian-frequenz in Increase sample_rate in some formula tests to reduce flakiness #351
• Bump mkdocs-material from 9.1.6 to 9.1.7 by @dependabot in Bump mkdocs-material from 9.1.6 to 9.1.7 #353
• Bump nox from 2022.11.21 to 2023.4.22 by @dependabot in Bump nox from 2022.11.21 to 2023.4.22 #354
• Rename custom loggers to _logger by @sahas-subramanian-frequenz in Rename custom loggers to _logger #347
• Rename alignment arguments to align_to and make them default to UNIX_EPOCH by @leandro-lucarella-frequenz in Rename alignment arguments to align_to and make them default to UNIX_EPOCH #349
• Make the MovingWindow public and remove public mentions to the RingBuffer by @leandro-lucarella-frequenz in Make the MovingWindow public and remove public mentions to the RingBuffer #355
• Bump mkdocs-material from 9.1.7 to 9.1.8 by @dependabot in Bump mkdocs-material from 9.1.7 to 9.1.8 #357
• Bump pylint from 2.17.2 to 2.17.3 by @dependabot in Bump pylint from 2.17.2 to 2.17.3 #356

New Contributors

• @dependabot made their first contribution in Bump pylint from 2.17.0 to 2.17.1 #288

Full Changelog: v0.19.0...v0.20.0

---

This discussion was created from the release v0.20.0.