Merge branch 'main' into df/#360-vector-traces

# Conflicts:
#	poetry.lock

Author: danielfeismann

CHANGELOG.md

@@ -17,7 +17,8 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 - Removed `q_characteristics` from `create_energy_management_systems_data` [#326](https://github.com/ie3-institute/pypsdm/issues/326)
-- Fix emInput from parent_em to controlling_em [#333](https://github.com/ie3-institute/pypsdm/issues/333)
+- Fix `emInput` from `parent_em` to `controlling_em` [#333](https://github.com/ie3-institute/pypsdm/issues/333)
+- Fix also from `em` to `controlling_em` for all `SystemParticipants` [#337](https://github.com/ie3-institute/pypsdm/issues/337)
 
 
 ## 0.0.6

nbs/create_grid.ipynb

@@ -78,7 +78,7 @@
     "    \"control_strategy\": [\"PRIORITIZED\", \"PRIORITIZED\", \"PRIORITIZED\"],\n",
     "}\n",
     "\n",
-    "emss = create_energy_management_systems(data_dict)"
+    "controlling_emss = create_energy_management_systems(data_dict)"
    ]
   },
   {
@@ -97,7 +97,7 @@
     "    \"s_rated\": pv_s_rated,\n",
     "    \"azimuth\": [90, 0, -90],\n",
     "    \"elevation_angle\": [40, 45, 30],\n",
-    "    \"em\": em_uuids,\n",
+    "    \"controlling_em\": em_uuids,\n",
     "}\n",
     "\n",
     "pvs = create_pvs(data_dict)"
@@ -116,7 +116,7 @@
     "    \"id\": [\"BS_NS_02\", \"BS_NS_03\", \"BS_NS_04\"],\n",
     "    \"node\": [node_2, node_3, node_4],\n",
     "    \"e_storage\": [1.5 * pv_power for pv_power in pv_s_rated],\n",
-    "    \"em\": em_uuids,\n",
+    "    \"controlling_em\": em_uuids,\n",
     "}\n",
     "\n",
     "bs = create_storages(data_dict)"
@@ -163,7 +163,7 @@
     "        EvcsLocationType.HOME.value,\n",
     "    ],\n",
     "    \"s_rated\": [10, 10, 10],\n",
-    "    \"em\": em_uuids,\n",
+    "    \"controlling_em\": em_uuids,\n",
     "}\n",
     "\n",
     "evcs = create_ev_charging_stations(data_dict)"
@@ -208,7 +208,7 @@
     "    \"node\": [node_2, node_3, node_4],\n",
     "    \"thermal_bus\": list(tbs.uuid),\n",
     "    \"s_rated\": [4, 3, 6],\n",
-    "    \"em\": em_uuids,\n",
+    "    \"controlling_em\": em_uuids,\n",
     "}\n",
     "\n",
     "hps = create_heat_pumps(data_dict)"
@@ -248,7 +248,7 @@
     "    \"s_rated\": [3, 3, 3],\n",
     "    \"e_cons_annual\": [3000, 3500, 4000],\n",
     "    \"load_profile\": [\"h0\", \"h0\", \"h0\"],\n",
-    "    \"em\": em_uuids,\n",
+    "    \"controlling_em\": em_uuids,\n",
     "}\n",
     "\n",
     "loads = create_loads(load_data_dict)"
@@ -268,7 +268,7 @@
     "\n",
     "\n",
     "participants = SystemParticipantsContainer(\n",
-    "    ems=EnergyManagementSystems.create_empty(),\n",
+    "    controlling_ems=EnergyManagementSystems.create_empty(),\n",
     "    loads=loads,\n",
     "    pvs=pvs,\n",
     "    storages=bs,\n",
@@ -313,7 +313,7 @@
    "outputs": [],
    "source": [
     "updated_participants = SystemParticipantsContainer(\n",
-    "    emss,\n",
+    "    controlling_emss,\n",
     "    participants.loads,\n",
     "    participants.fixed_feed_ins,\n",
     "    participants.pvs,\n",

nbs/enrich_simbench_grid.ipynb

@@ -3104,7 +3104,7 @@
     "    \"s_rated\": load_input_params[3],\n",
     "    \"e_cons_annual\": load_input_params[4],\n",
     "    \"load_profile\": load_input_params[5],\n",
-    "    \"em\": load_input_params[6],\n",
+    "    \"controlling_em\": load_input_params[6],\n",
     "}\n",
     "\n",
     "loads = create_loads(load_data_dict)"
@@ -3131,7 +3131,7 @@
     "    \"azimuth\": pv_input_params[2],\n",
     "    \"elevation_angle\": pv_input_params[3],\n",
     "    \"uuid\": pv_input_params[5],\n",
-    "    \"em\": pv_input_params[6],\n",
+    "    \"controlling_em\": pv_input_params[6],\n",
     "}\n",
     "\n",
     "pvs = create_pvs(data_dict)"
@@ -3172,7 +3172,7 @@
     "    \"s_rated\": evcs_params[4],\n",
     "    \"uuid\": evcs_params[1],\n",
     "    \"v2g_support\": evcs_params[5],\n",
-    "    \"em\": evcs_params[6],\n",
+    "    \"controlling_em\": evcs_params[6],\n",
     "}\n",
     "\n",
     "evcs = create_ev_charging_stations(data_dict)"
@@ -3197,7 +3197,7 @@
     "    \"uuid\": storage_params[1],\n",
     "    \"node\": storage_params[2],\n",
     "    \"e_storage\": storage_params[3],\n",
-    "    \"em\": storage_params[4],\n",
+    "    \"controlling_em\": storage_params[4],\n",
     "}\n",
     "\n",
     "bs = create_storages(data_dict)"
@@ -3224,7 +3224,7 @@
     "    \"control_strategy\": em_params[3],\n",
     "}\n",
     "\n",
-    "emss = create_energy_management_systems(data_dict)"
+    "controlling_emss = create_energy_management_systems(data_dict)"
    ],
    "id": "40b9651a2b2602fb",
    "outputs": [],
@@ -3246,7 +3246,7 @@
     "from pypsdm.models.input.participant.hp import HeatPumps\n",
     "\n",
     "participants = SystemParticipantsContainer(\n",
-    "    ems=emss,\n",
+    "    controlling_ems=controlling_emss,\n",
     "    loads=loads,\n",
     "    pvs=pvs,\n",
     "    storages=bs,\n",
@@ -3283,7 +3283,7 @@
     "        participant_uuids.extend(list(current.uuid))\n",
     "    node_connected_assets[node] = participant_uuids\n",
     "updated_participants = SystemParticipantsContainer(\n",
-    "    emss,\n",
+    "    controlling_emss,\n",
     "    participants.loads,\n",
     "    participants.fixed_feed_ins,\n",
     "    participants.pvs,\n",

poetry.lock

@@ -31,7 +31,7 @@ black = { extras = ["jupyter"], version = "~25.1.0" }
 flake8 = "^7.3.0"
 flake8-black = "^0.3.6"
 flake8-isort = "^6.0.0"
-pre-commit = "~=4.2.0"
+pre-commit = "~=4.3.0"
 PyYAML = "^6.0"
 deptry = "^0.23.1" # find unused dependencies
 

pyproject.toml

@@ -53,8 +53,8 @@ def switches(self):
         return self.grid.switches
 
     @property
-    def ems(self):
-        return self.participants.ems
+    def controlling_ems(self):
+        return self.participants.controlling_ems
 
     @property
     def loads(self):
@@ -117,8 +117,8 @@ def participants_res(self):
         return self.results.participants
 
     @property
-    def ems_res(self):
-        return self.participants_res.ems
+    def controlling_ems_res(self):
+        return self.participants_res.controlling_ems
 
     @property
     def loads_res(self):
@@ -181,10 +181,10 @@ def nodal_result(self, node_uuid: str) -> "GridResultContainer":
             participants=participants,
         )
 
-    def em_results(
+    def controlling_em_results(
         self,
     ) -> list[Tuple[SystemParticipantsContainer, SystemParticipantsResultContainer]]:
-        uuid_to_connected_asset = self.ems.uuid_to_connected_assets()
+        uuid_to_connected_asset = self.controlling_ems.uuid_to_connected_assets()
         return [
             (
                 self.participants.subset(connected_assets + [em_uuid]),

pypsdm/models/gwr.py

@@ -56,8 +56,8 @@ def switches(self):
         return self.raw_grid.switches
 
     @property
-    def ems(self):
-        return self.participants.ems
+    def controlling_ems(self):
+        return self.participants.controlling_ems
 
     @property
     def loads(self):

pypsdm/models/input/container/grid.py

@@ -23,7 +23,7 @@
 
 @dataclass(frozen=True)
 class SystemParticipantsContainer(ContainerMixin):
-    ems: EnergyManagementSystems
+    controlling_ems: EnergyManagementSystems
     loads: Loads
     fixed_feed_ins: FixedFeedIns
     pvs: PhotovoltaicPowerPlants
@@ -36,7 +36,7 @@ class SystemParticipantsContainer(ContainerMixin):
 
     def to_list(self, include_empty=False) -> list[Entities]:
         participants = [
-            self.ems,
+            self.controlling_ems,
             self.loads,
             self.fixed_feed_ins,
             self.pvs,
@@ -74,20 +74,22 @@ def filter_by_nodes(
 
         em_uuids = pd.concat(
             [
-                loads.em,
-                fixed_feed_ins.em,
-                pvs.em,
-                biomass_plants.em,
-                wecs.em,
-                storages.em,
-                evcs.em,
-                hps.em,
+                loads.controlling_em,
+                fixed_feed_ins.controlling_em,
+                pvs.controlling_em,
+                biomass_plants.controlling_em,
+                wecs.controlling_em,
+                storages.controlling_em,
+                evcs.controlling_em,
+                hps.controlling_em,
             ]
         )
-        ems = EnergyManagementSystems(self.ems.data[self.ems.data.index.isin(em_uuids)])
+        controlling_ems = EnergyManagementSystems(
+            self.controlling_ems.data[self.controlling_ems.data.index.isin(em_uuids)]
+        )
 
         return SystemParticipantsContainer(
-            ems,
+            controlling_ems,
             loads,
             fixed_feed_ins,
             pvs,
@@ -101,7 +103,7 @@ def filter_by_nodes(
 
     def get_with_enum(self, sp_type: EntitiesEnum) -> Entities | None:
         if sp_type == SystemParticipantsEnum.ENERGY_MANAGEMENT:
-            return self.ems
+            return self.controlling_ems
         elif sp_type == SystemParticipantsEnum.LOAD:
             return self.loads
         elif sp_type == SystemParticipantsEnum.BIOMASS_PLANT:
@@ -134,8 +136,8 @@ def find_participant(self, uuid: str) -> Series:
             return self.wecs.get(uuid)
         elif uuid in self.biomass_plants:
             return self.biomass_plants.get(uuid)
-        elif uuid in self.ems:
-            return self.ems.get(uuid)
+        elif uuid in self.controlling_ems:
+            return self.controlling_ems.get(uuid)
         elif uuid in self.storages:
             return self.storages.get(uuid)
         elif uuid in self.evs:
@@ -156,7 +158,7 @@ def uuids(self):
 
     def subset(self, uuids):
         return SystemParticipantsContainer(
-            self.ems.subset(uuids, intersection=True),
+            self.controlling_ems.subset(uuids, intersection=True),
             self.loads.subset(uuids, intersection=True),
             self.fixed_feed_ins.subset(uuids, intersection=True),
             self.pvs.subset(uuids, intersection=True),
@@ -178,12 +180,14 @@ def from_csv(
         biomass_plants = BiomassPlants.from_csv(path, delimiter, must_exist=False)
         wecs = WindEnergyConverters.from_csv(path, delimiter, must_exist=False)
         storages = Storages.from_csv(path, delimiter, must_exist=False)
-        ems = EnergyManagementSystems.from_csv(path, delimiter, must_exist=False)
+        controlling_ems = EnergyManagementSystems.from_csv(
+            path, delimiter, must_exist=False
+        )
         evs = ElectricVehicles.from_csv(path, delimiter, must_exist=False)
         evcs = EvChargingStations.from_csv(path, delimiter, must_exist=False)
         hps = HeatPumps.from_csv(path, delimiter, must_exist=False)
         return SystemParticipantsContainer(
-            ems,
+            controlling_ems,
             loads,
             fixed_feed_ins,
             pvs,
@@ -198,7 +202,7 @@ def from_csv(
     @classmethod
     def create(
         cls,
-        ems=EnergyManagementSystems.create_empty(),
+        controlling_ems=EnergyManagementSystems.create_empty(),
         loads=Loads.create_empty(),
         fixed_feed_ins=FixedFeedIns.create_empty(),
         pvs=PhotovoltaicPowerPlants.create_empty(),
@@ -210,7 +214,7 @@ def create(
         hps=HeatPumps.create_empty(),
     ):
         return cls(
-            ems=ems,
+            controlling_ems=controlling_ems,
             loads=loads,
             fixed_feed_ins=fixed_feed_ins,
             pvs=pvs,