Merge pull request #17 from cwasicki/cfg

Add assets config to microgrid config

RELEASE_NOTES.md

@@ -12,6 +12,7 @@
 
 - Added options to add microgrid location metadata to `MicrogridConfig` (longitude, latitude, altitude).
 - Added support for `component_category` in the `component_type_ids` method of `MicrogridConfig`, allowing retrieval of IDs for specific categories (e.g., "meter", "inverter", and "component").
+- Added assets config to `MicrogridConfig`, which can be used to track metadata for assets like pv, wind and battery.
 
 ## Bug Fixes
 

src/frequenz/lib/notebooks/config.py

@@ -73,6 +73,53 @@ def is_valid_type(cls, ctype: str) -> bool:
         return ctype in get_args(ComponentType)
 
 
+@dataclass(frozen=True)
+class PVConfig:
+    """Configuration of a PV system in a microgrid."""
+
+    peak_power: float | None = None
+    """Peak power of the PV system in Watt."""
+
+    rated_power: float | None = None
+    """Rated power of the inverters in Watt."""
+
+
+@dataclass(frozen=True)
+class WindConfig:
+    """Configuration of a wind turbine in a microgrid."""
+
+    turbine_model: str | None = None
+    """Model name of the wind turbine."""
+
+    rated_power: float | None = None
+    """Rated power of the wind turbine in Watt."""
+
+    turbine_height: float | None = None
+    """Height of the wind turbine in meters."""
+
+
+@dataclass(frozen=True)
+class BatteryConfig:
+    """Configuration of a battery in a microgrid."""
+
+    capacity: float | None = None
+    """Capacity of the battery in Wh."""
+
+
+@dataclass(frozen=True)
+class AssetsConfig:
+    """Configuration of the assets in a microgrid."""
+
+    pv: dict[str, PVConfig] | None = None
+    """Configuration of the PV system."""
+
+    wind: dict[str, WindConfig] | None = None
+    """Configuration of the wind turbines."""
+
+    battery: dict[str, BatteryConfig] | None = None
+    """Configuration of the batteries."""
+
+
 @dataclass(frozen=True)
 class Metadata:
     """Metadata for a microgrid."""
@@ -103,6 +150,9 @@ class MicrogridConfig:
     _metadata: Metadata
     """Metadata of the microgrid."""
 
+    _assets_cfg: AssetsConfig
+    """Configuration of the assets in the microgrid."""
+
     _component_types_cfg: dict[str, ComponentTypeConfig]
     """Mapping of component category types to ac power component config."""
 
@@ -114,6 +164,12 @@ def __init__(self, config_dict: dict[str, Any]) -> None:
         """
         self._metadata = Metadata(**(config_dict.get("meta") or {}))
 
+        self._assets_cfg = AssetsConfig(
+            pv=config_dict.get("pv") or {},
+            wind=config_dict.get("wind") or {},
+            battery=config_dict.get("battery") or {},
+        )
+
         self._component_types_cfg = {
             ctype: ComponentTypeConfig(component_type=cast(ComponentType, ctype), **cfg)
             for ctype, cfg in config_dict["ctype"].items()
@@ -125,6 +181,11 @@ def meta(self) -> Metadata:
         """Return the metadata of the microgrid."""
         return self._metadata
 
+    @property
+    def assets(self) -> AssetsConfig:
+        """Return the assets configuration of the microgrid."""
+        return self._assets_cfg
+
     def component_types(self) -> list[str]:
         """Get a list of all component types in the configuration."""
         return list(self._component_types_cfg.keys())