Rename DistributionAlgorithm → BatteryDistributionAlgorithm

shsms · shsms · commit d091df5db965 · 2023-11-20T16:11:12.000+01:00
Also rename the file _distribution_algorithm.py →
_battery_distribution_algorithm.py.

Signed-off-by: Sahas Subramanian &lt;sahas.subramanian@proton.me&gt;
diff --git a/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py b/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py
@@ -23,7 +23,7 @@
 from .._component_status import ComponentPoolStatus
 from .._distribution_algorithm import (
     AggregatedBatteryData,
-    DistributionAlgorithm,
+    BatteryDistributionAlgorithm,
     DistributionResult,
     InvBatPair,
 )
@@ -158,7 +158,7 @@ def __init__(
         equal SoC level.
         """
 
-        self._distribution_algorithm = DistributionAlgorithm(
+        self._distribution_algorithm = BatteryDistributionAlgorithm(
             self._power_distributor_exponent
         )
         """The distribution algorithm used to distribute power between batteries."""
diff --git a/src/frequenz/sdk/actor/power_distributing/_distribution_algorithm/__init__.py b/src/frequenz/sdk/actor/power_distributing/_distribution_algorithm/__init__.py
@@ -3,15 +3,15 @@
 
 """Utilities to manage power in a microgrid."""
 
-from ._distribution_algorithm import (
+from ._battery_distribution_algorithm import (
     AggregatedBatteryData,
-    DistributionAlgorithm,
+    BatteryDistributionAlgorithm,
     DistributionResult,
     InvBatPair,
 )
 
 __all__ = [
-    "DistributionAlgorithm",
+    "BatteryDistributionAlgorithm",
     "DistributionResult",
     "InvBatPair",
     "AggregatedBatteryData",
diff --git a/src/frequenz/sdk/actor/power_distributing/_distribution_algorithm/_battery_distribution_algorithm.py b/src/frequenz/sdk/actor/power_distributing/_distribution_algorithm/_battery_distribution_algorithm.py
@@ -198,7 +198,7 @@ class DistributionResult:
     """The power which could not be distributed because of bounds."""
 
 
-class DistributionAlgorithm:
+class BatteryDistributionAlgorithm:
     r"""Distribute power between many components.
 
     The purpose of this tool is to keep equal SoC level in the batteries.
diff --git a/src/frequenz/sdk/timeseries/battery_pool/_metric_calculator.py b/src/frequenz/sdk/timeseries/battery_pool/_metric_calculator.py
@@ -14,7 +14,7 @@
 from ...actor.power_distributing._component_managers._battery_manager import (
     _get_battery_inverter_mappings,
 )
-from ...actor.power_distributing._distribution_algorithm._distribution_algorithm import (
+from ...actor.power_distributing._distribution_algorithm._battery_distribution_algorithm import (
     _aggregate_battery_power_bounds,
 )
 from ...actor.power_distributing.result import PowerBounds
diff --git a/tests/actor/power_distributing/test_battery_distribution_algorithm.py b/tests/actor/power_distributing/test_battery_distribution_algorithm.py
diff --git a/tests/actor/power_distributing/test_power_distributing.py b/tests/actor/power_distributing/test_power_distributing.py

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`from ...actor.power_distributing._component_managers._battery_manager import (`
`15`	`15`	`_get_battery_inverter_mappings,`
`16`	`16`	`)`
`17`		`-from ...actor.power_distributing._distribution_algorithm._distribution_algorithm import (`
	`17`	`+from ...actor.power_distributing._distribution_algorithm._battery_distribution_algorithm import (`
`18`	`18`	`_aggregate_battery_power_bounds,`
`19`	`19`	`)`
`20`	`20`	`from ...actor.power_distributing.result import PowerBounds`