omotes-simulator-core 0.0.3.dev0__py3-none-any.whl

omotes_simulator_core-0.0.3.dev0.dist-info/RECORD

@@ -0,0 +1,59 @@
+simulator_core/__init__.py,sha256=TRRHUopVEKu2hkNW5lzfNar2eAeoWqCzY8aFZARf_cA,733
+simulator_core/__main__.py,sha256=BDvrVprBDYbyjqwY15WimOw8Bctl-JKAdauv4MuVZaI,830
+simulator_core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+simulator_core/adapter/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/adapter/presentation/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/adapter/transforms/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/adapter/transforms/esdl_asset_mapper.py,sha256=ZO2GLYxlQLZmLE6CuLziZFbAgLd4s9EiQ7CQ8rIosQ0,2168
+simulator_core/adapter/transforms/mappers.py,sha256=XDwqMagTUVfgCWm8-PaoWlcXm0XSaHa6IWeJlhpEUpQ,10852
+simulator_core/adapter/transforms/string_to_esdl.py,sha256=qgVCOVydqf7UE8WaRmLEDR_2pzzm7bPL4AqKEJVSKOc,2757
+simulator_core/adapter/transforms/transform_utils.py,sha256=tW0d2LnkC4UPPyZDvxU1aq0qcBViBAGjzszHXxLAlg0,1310
+simulator_core/entities/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/entities/esdl_object.py,sha256=LBYmF4k4qNslmNBWpArbVPW0-cd83BfuGIjwQU9Zumg,3871
+simulator_core/entities/heat_network.py,sha256=rC2gdv44l39tUEucoc2qi55CE_mYUAQdkDXc9aavWDs,3326
+simulator_core/entities/network_controller.py,sha256=1wZ8LBjFkt-3mLd2Shp1yPCeWP1yyrtORYOo_A8Vybg,3411
+simulator_core/entities/simulation_configuration.py,sha256=oZ5fWE6eFIXEY7-WfAr32n_gdQ2PsIVa_QKVCaSQcP8,1063
+simulator_core/entities/assets/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/entities/assets/asset_abstract.py,sha256=4bBIzE_b760VSmYyyB2t5dhh_59IMVADKxz7JJxcrrg,4119
+simulator_core/entities/assets/asset_defaults.py,sha256=UTs6fLRnxg-mSySNg0uE6qyp6_V9yigecwqu30NrPjI,2445
+simulator_core/entities/assets/controller_classes.py,sha256=ESTyMekSCceJrNLs3OSgOI3X-z2G8RigigaNV-VwcoY,3178
+simulator_core/entities/assets/demand_cluster.py,sha256=4vJiaYVHnu-9gG4PRyZK2MEyH_vdW2Po59oFM0th1Po,4883
+simulator_core/entities/assets/esdl_asset_object.py,sha256=cUtINgVUbZG_5u0dXeeHBRE7MWMSL17ifWh_9sH0d9Q,2177
+simulator_core/entities/assets/junction.py,sha256=GdlFJhyV9ahS24MM6eCSKeE0bHfaz6fwu7pUOrWmoZU,2395
+simulator_core/entities/assets/pipe.py,sha256=oaUFp5s54qWMThgA7WOduDQga6B1eR6cQoEcElhdpug,7971
+simulator_core/entities/assets/production_cluster.py,sha256=maIYUVFCbSEsripY7OAdSJCJ-DEHbOsMrsWVKjkwBvw,9236
+simulator_core/entities/assets/utils.py,sha256=m_SStM6f9kCjhpsDsiRIJTpCq1WCI34CvK9mAesgf38,6605
+simulator_core/entities/utility/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/entities/utility/influxdb_reader.py,sha256=cSo15Bhl3nkrgDtFXA0_naf6Xsr4CKUS001WDI5Bulc,5409
+simulator_core/infrastructure/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/infrastructure/app.py,sha256=jKU13EJxI1lFWGrWhyJgjPyGpM07JPNuxqtzfSGQtNI,2033
+simulator_core/infrastructure/simulation_manager.py,sha256=lF3kmWticXdFrKL6ZKT-fpr4TcIxu0g2s49_QxojWzE,2301
+simulator_core/infrastructure/utils.py,sha256=KLrp-AEsR4hKX3vhwStC5PVLt3gPo1bCo-aHXrYBGp4,1670
+simulator_core/simulation/__init__.py,sha256=I3jmv1oaRKVktAw4j7-oPBBVbhj0N7cR1wo0cVBpZlc,784
+simulator_core/simulation/networksimulation.py,sha256=JwkDfsaNSKSl8a8rgqC38kMvxASukzX1Lf1Ls2uEAUs,2641
+simulator_core/simulation/mappers/__init__.py,sha256=0uQyiQt-16nEsoaDvVzwTwQmj7H4zlN_7a3c_H9m1Xg,734
+simulator_core/simulation/mappers/mappers.py,sha256=lxwVnjGDCSoaG-Dy0g-tg-v5STYy6iJh25PFOKC3xJY,1304
+simulator_core/solver/__init__.py,sha256=TRRHUopVEKu2hkNW5lzfNar2eAeoWqCzY8aFZARf_cA,733
+simulator_core/solver/solver.py,sha256=ZWwmcQe9s8UnvcKTOEAteCKYImTMdneukZMs3UOvIog,3200
+simulator_core/solver/matrix/__init__.py,sha256=TRRHUopVEKu2hkNW5lzfNar2eAeoWqCzY8aFZARf_cA,733
+simulator_core/solver/matrix/core_enum.py,sha256=aYzq7L7qdsrgzDPczg-iGM1CH0O2K__E-Egm-KJcU28,943
+simulator_core/solver/matrix/equation_object.py,sha256=OCI3-4Hyw-eg_dMWcdibFASEmCkxF49-RnJmgKglIos,2192
+simulator_core/solver/matrix/matrix.py,sha256=KAIyOCWC2u3MwEPXs43F_65ffBBUkBWF2p5GwaKydFw,5513
+simulator_core/solver/matrix/utility.py,sha256=4LTWEQG9t7uFw9LpwRNpe1xhaOX65bfiYcsBpejI-T4,1490
+simulator_core/solver/network/__init__.py,sha256=TRRHUopVEKu2hkNW5lzfNar2eAeoWqCzY8aFZARf_cA,733
+simulator_core/solver/network/network.py,sha256=d4tnKI5jX6s_897bQeJLK9WS8dMPx4y-kGT0Sv67OM8,17629
+simulator_core/solver/network/assets/__init__.py,sha256=TRRHUopVEKu2hkNW5lzfNar2eAeoWqCzY8aFZARf_cA,733
+simulator_core/solver/network/assets/base_asset.py,sha256=DlANH4uTRQgKjY9PLBZDHjZ6e26PCjxTCwh-txXww8I,12632
+simulator_core/solver/network/assets/base_item.py,sha256=GKJYrhiTtG_M4GrrwiAMxU32SO-K4wcK2i4ZX1jCbq8,2354
+simulator_core/solver/network/assets/base_node_item.py,sha256=SvA_9TK-VJBXxsGIoT9ppuQgmkkiMCupo-L3POrILqQ,2480
+simulator_core/solver/network/assets/boundary.py,sha256=5JZ55Y3Z1WRpQvns8xa0PcQATRn7IgYofpaCyL89jTA,3480
+simulator_core/solver/network/assets/fall_type.py,sha256=l5WeDUo0QbVRu2l2q54LPz45j-KEIkqx0IjM43vn09c,9621
+simulator_core/solver/network/assets/node.py,sha256=no0YdK7HVR7J-KqQV77qxdpAG9r6edGPHy4Uj4wPOA8,11828
+simulator_core/solver/network/assets/production_asset.py,sha256=NxuI_iHlOGew1GhQWthPou0FtxLXEbSE1dcLGUjV8jU,7073
+simulator_core/solver/network/assets/solver_pipe.py,sha256=dMIyUTeeGC8U_SWwbC6w47EJbGJJVMrFVmTFrchFQHg,22136
+simulator_core/solver/utils/fluid_properties.py,sha256=vyDRjD8FLcMTu94l5R3f51r1TfHAqzUgmqOXWNS7c0c,7288
+omotes_simulator_core-0.0.3.dev0.dist-info/LICENSE,sha256=UiCnq3ALVoE2_2UYK0HpZY8amAxQ-6NkJfDt6GrGhlI,32472
+omotes_simulator_core-0.0.3.dev0.dist-info/METADATA,sha256=fJdgRvuVkWC8m7p0nEqo_2Xw4ZNTFx9nNeMrMEGn7DU,2490
+omotes_simulator_core-0.0.3.dev0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+omotes_simulator_core-0.0.3.dev0.dist-info/top_level.txt,sha256=ZQNUqmxeDErBZUWTewBdpG5ixU80gMwZEJad4t3kNLw,15
+omotes_simulator_core-0.0.3.dev0.dist-info/RECORD,,

omotes_simulator_core-0.0.3.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.40.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

omotes_simulator_core-0.0.3.dev0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simulator_core

simulator_core/__init__.py

@@ -0,0 +1,15 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""__init__.py file for initialization code."""

simulator_core/__main__.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__main__.py file entry point for testing."""
+
+from simulator_core.infrastructure.app import run
+
+if __name__ == "__main__":
+    print(run())

simulator_core/adapter/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__init__.py file for initialization code."""

simulator_core/adapter/presentation/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__init__.py file for initialization code."""

simulator_core/adapter/transforms/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__init__.py file for initialization code."""

simulator_core/adapter/transforms/esdl_asset_mapper.py

@@ -0,0 +1,53 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Module containing the Esdl to asset mapper class."""
+from typing import Any
+
+import esdl
+
+from simulator_core.entities.assets.asset_abstract import AssetAbstract
+from simulator_core.entities.assets.demand_cluster import DemandCluster
+from simulator_core.entities.assets.esdl_asset_object import EsdlAssetObject
+from simulator_core.entities.assets.pipe import Pipe
+from simulator_core.entities.assets.production_cluster import ProductionCluster
+
+
+class EsdlAssetMapper:
+    """Creates entity Asset objects based on a PyESDL EnergySystem assets."""
+
+    conversion_dict = {
+        esdl.Producer: ProductionCluster,
+        esdl.GenericProducer: ProductionCluster,
+        esdl.Consumer: DemandCluster,
+        esdl.HeatingDemand: DemandCluster,
+        esdl.Pipe: Pipe,
+    }
+
+    def to_esdl(self, entity: AssetAbstract) -> Any:
+        """Maps entity object to PyEsdl objects."""
+        raise NotImplementedError("EsdlAssetMapper.to_esdl()")
+
+    def to_entity(self, model: EsdlAssetObject) -> AssetAbstract:
+        """Method to map an esdl asset to an asset entity class.
+
+        :param EsdlAssetObject model: Object to be converted to an asset entity.
+
+        :return: Entity object.
+        """
+        if not type(model.esdl_asset) in self.conversion_dict:
+            raise NotImplementedError(str(model.esdl_asset) + " not implemented in conversion")
+        return self.conversion_dict[type(model.esdl_asset)](
+            model.esdl_asset.name, model.esdl_asset.id)

simulator_core/adapter/transforms/mappers.py

@@ -0,0 +1,226 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Mapper classes."""
+from typing import Dict, List, Tuple
+
+from esdl.esdl import Joint as esdl_junction
+
+from simulator_core.adapter.transforms.esdl_asset_mapper import EsdlAssetMapper
+from simulator_core.entities.assets.asset_abstract import AssetAbstract
+from simulator_core.entities.assets.controller_classes import (
+    ControllerConsumer,
+    ControllerSource,
+)
+from simulator_core.entities.assets.junction import Junction
+from simulator_core.entities.assets.utils import Port
+from simulator_core.entities.esdl_object import EsdlObject
+from simulator_core.entities.heat_network import HeatNetwork
+from simulator_core.entities.network_controller import NetworkController
+from simulator_core.simulation.mappers.mappers import EsdlMapperAbstract
+from simulator_core.solver.network.network import Network
+
+
+def connect_connected_asset(
+    connected_py_assets: List[Tuple[str, Port]],
+    junction: Junction,
+    py_assets_list: List[AssetAbstract],
+) -> None:
+    """Method to connect assets connected to one asset to the same junction.
+
+    :param connected_py_assets: List of connected assets
+    :param junction: Junction to connect the assets to
+    :param py_assets_list: List of assets
+    :return: None
+    """
+    for connected_py_asset in connected_py_assets:
+        index = [py_asset_temp.asset_id for py_asset_temp in py_assets_list].index(
+            connected_py_asset[0]
+        )
+        if connected_py_asset[1] == Port.In:  # from
+            py_assets_list[index].set_from_junction(from_junction=junction)
+        else:  # to
+            py_assets_list[index].set_to_junction(to_junction=junction)
+
+
+def replace_joint_in_connected_assets(
+    connected_py_assets: List[Tuple[str, Port]],
+    py_joint_dict: Dict[str, List[Tuple[str, Port]]],
+    py_asset_id: str,
+    iteration_limit: int = 10,
+) -> List[Tuple[str, Port]]:
+    """Replace joint with assets connected to the elements.
+
+    Replace items in the connected_py_assets list that are connected to a Joint
+    with the items that are connected to the Joint, except for the current asset.
+
+    :param connected_py_assets: List of connected assets
+    :param py_joint_dict: Dictionary with joint id as key and list of tuples with
+    connected asset id and port as value.
+    :param py_asset_id: Id of the asset all the connected assets are connected to
+    :param iteration_limit: Limit for the number of iterations
+
+    """
+    replace_bool = True
+    while replace_bool and iteration_limit > 0:
+        replace_bool = False
+        iteration_limit -= 1
+        for index, connected_py_asset in enumerate(connected_py_assets):
+            connected_py_asset_id, _ = connected_py_asset
+            if connected_py_asset_id in py_joint_dict:
+                # remove the joint from the list and add the connected assets
+                connected_py_assets.pop(index)
+                # get the connected assets
+                additional_assets = py_joint_dict[connected_py_asset_id].copy()
+                # remove the current asset from the list
+                for index, additional_asset_properties in enumerate(additional_assets):
+                    additional_asset_id, _ = additional_asset_properties
+                    if additional_asset_id == py_asset_id:
+                        additional_assets.pop(index)
+                        break
+                # add the connected assets to the list
+                connected_py_assets.extend(additional_assets)
+                replace_bool = True
+                break
+    if iteration_limit == 0:
+        raise RuntimeError("Error in replacing joint in connected assets.")
+    else:
+        return connected_py_assets
+
+
+class EsdlEnergySystemMapper(EsdlMapperAbstract):
+    """Creates a HeatNetwork entity object based on a PyESDL EnergySystem object."""
+
+    def __init__(self, esdl_object: EsdlObject):
+        """Constructor for esdl to heat network mapper.
+
+        :param esdl_object: Esdl object to be converted to a Heatnetwork
+        """
+        self.esdl_object = esdl_object
+
+    def to_esdl(self, entity: HeatNetwork) -> EsdlObject:
+        """Method to convert a HeatNetwork object back to an esdlobject.
+
+        For now this method is not implemented.
+        :param HeatNetwork entity: HeatNetwork object to be converted to esdl object
+        :return: EsdlObject, which is the converted HeatNetwork object.
+        """
+        raise NotImplementedError("EsdlEnergySystemMapper.to_esdl()")
+
+    def to_entity(self, network: Network) -> Tuple[List[AssetAbstract], List[Junction]]:
+        """Method to convert esdl to Heatnetwork object.
+
+        This method first converts all assets into a list of assets.
+        Next to this a list of Junctions is created. This is then used
+        to create the Heatnetwork object.
+        :param Network network: netowrk to add the compenents to.
+        :return: (List[AssetAbstract], List[Junction]), tuple of list of assets and junctions.
+        """
+        # TODO: This method requires a clean-up!
+        py_assets_list = []
+        py_joint_dict = {}
+        for esdl_asset in self.esdl_object.get_all_assets_of_type("asset"):
+            # Junctions need to be skipped, as they are replaced by merged pandapipes junctions.
+            if isinstance(esdl_asset.esdl_asset, esdl_junction):
+                py_joint_dict[esdl_asset.esdl_asset.id] = [
+                    *self.esdl_object.get_connected_assets(esdl_asset.esdl_asset.id, Port.In),
+                    *self.esdl_object.get_connected_assets(esdl_asset.esdl_asset.id, Port.Out),
+                ]
+            else:
+                py_assets_list.append(EsdlAssetMapper().to_entity(esdl_asset))
+                py_assets_list[-1].add_physical_data(esdl_asset=esdl_asset)
+                network.add_existing_asset(py_assets_list[-1].solver_asset)
+
+        py_junction_list = []
+
+        # loop over assets and create junctions and connect them
+        for py_asset in py_assets_list:
+            for con_point in range(0, 2):
+                if not py_asset.solver_asset.is_connected(con_point):
+                    connected_py_assets = self.esdl_object.get_connected_assets(
+                        py_asset.asset_id, Port.In if con_point == 0 else Port.Out
+                    )
+                    # Replace items in the connected_py_assets list that are connected to a Joint
+                    # with the items that are connected to the Joint, except for the current asset.
+                    connected_py_assets = replace_joint_in_connected_assets(
+                        connected_py_assets, py_joint_dict, py_asset.asset_id
+                    )
+                    for connected_py_asset, connected_py_port in connected_py_assets:
+                        index = [py_asset_temp.asset_id for py_asset_temp in py_assets_list].index(
+                            connected_py_asset
+                        )
+                        if connected_py_port == Port.In:
+                            node_id = network.connect_assets(
+                                asset1_id=py_asset.solver_asset.name,
+                                connection_point_1=con_point,
+                                asset2_id=py_assets_list[index].solver_asset.name,
+                                connection_point_2=0,
+                            )
+                            py_junction_list.append(
+                                Junction(network.get_node(node_id), name=str(node_id))
+                            )
+                            py_assets_list[index].set_to_junction(py_junction_list[-1])
+                        else:
+                            node_id = network.connect_assets(
+                                asset1_id=py_asset.solver_asset.name,
+                                connection_point_1=con_point,
+                                asset2_id=py_assets_list[index].solver_asset.name,
+                                connection_point_2=1,
+                            )
+                            py_junction_list.append(
+                                Junction(network.get_node(node_id), name=str(node_id))
+                            )
+                            py_assets_list[index].set_from_junction(py_junction_list[-1])
+                        # connect the connected assets to the junction
+                        if con_point == 0:
+                            py_asset.set_to_junction(py_junction_list[-1])
+                        else:
+                            py_asset.set_from_junction(py_junction_list[-1])
+
+        return py_assets_list, py_junction_list
+
+
+class EsdlControllerMapper(EsdlMapperAbstract):
+    """Creates a NetworkController entity object based on a PyESDL EnergySystem object."""
+
+    def to_esdl(self, entity: NetworkController) -> EsdlObject:
+        """Method to convert a NetworkController object to an esdlobject.
+
+        For now this method is not implemented.
+        :param NetworkController entity: NetworkController object to be converted to esdl object
+        :return: EsdlObject, which is the converted NetworkController object.
+        """
+        raise NotImplementedError("EsdlControllerMapper.to_esdl()")
+
+    def to_entity(self, model: EsdlObject) -> NetworkController:
+        """Method to convert esdl to NetworkController object.
+
+        This method first converts all assets into a list of assets.
+        Next to this a list of Junctions is created. This is then used
+        to create the NetworkController object.
+        :param EsdlObject model: EsdlObject object to be converted to NetworkController object
+        :return: NetworkController, which is the converted EsdlObject object.
+        """
+        consumers = []
+        for esdl_asset in model.get_all_assets_of_type("consumer"):
+            consumers.append(
+                ControllerConsumer(esdl_asset.esdl_asset.name, esdl_asset.esdl_asset.id)
+            )
+            consumers[-1].add_profile(esdl_asset.get_profile())
+
+        sources = []
+        for esdl_asset in model.get_all_assets_of_type("producer"):
+            sources.append(ControllerSource(esdl_asset.esdl_asset.name, esdl_asset.esdl_asset.id))
+        return NetworkController(consumers, sources)

simulator_core/adapter/transforms/string_to_esdl.py

@@ -0,0 +1,66 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""Module containing class to convert a string to asdl class type and vica-versa."""
+import esdl
+
+from simulator_core.adapter.transforms.transform_utils import reverse_dict
+from typing import List
+
+
+class StringEsdlAssetMapper:
+    """Mapper class to convert strings to an esdl class type and vica-versa.
+
+    Please note that the str_to_type_dict needs to have unique keys and values.
+    Also note that fo the esdl class only the derived classes should be listed.
+    Otherwise asset might be selected twice, since a HeatingDemand is also and Consumer.
+    """
+
+    type_to_str_dict = {
+        esdl.Asset: "asset",
+        esdl.GenericProducer: "producer",
+        esdl.GenericConsumer: "consumer",
+        esdl.HeatingDemand: "consumer",
+        esdl.GeothermalSource: "geothermal",
+        esdl.Conversion: "conversion",
+        esdl.Pipe: "pipe",
+        esdl.Transport: "transport",
+        esdl.Joint: "junction",
+    }
+
+    str_to_type_dict = reverse_dict(original_dict=type_to_str_dict)
+
+    def to_esdl(self, entity: str) -> List[type]:
+        """Method to convert a string to esdl class type.
+
+        :param str entity: String to be converted to an esdl class type object.
+        :return: ESDL class described in the string.
+        """
+        if entity not in self.str_to_type_dict:
+            raise NotImplementedError(entity + " not implemented in StringESDLAssetMapper class")
+        return self.str_to_type_dict[entity]
+
+    def to_entity(self, entity: type) -> str:
+        """Method to convert esdl type class to a string.
+
+        The dict values are converted to a list to find the index in the list.
+        Then the list of keys is created and the value at the index found is returned.
+        :param type entity: ESDl object clas to be converted to a string
+        :return: str belonging to the entity.
+        """
+        if entity not in self.type_to_str_dict:
+            raise NotImplementedError(
+                str(entity) + " not implemented in StringESDLAssetMapper class"
+            )
+        return self.type_to_str_dict[entity]

simulator_core/adapter/transforms/transform_utils.py

@@ -0,0 +1,34 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""File containing utility functions for the transforms."""
+from typing import Dict, List
+
+
+def reverse_dict(original_dict: dict) -> Dict[str, List[type]]:
+    """Method to reverse a dict.
+
+    Creates a dict with set(values) as keys and the keys of the original dict as list values.
+
+    :param dict original_dict: Dict to be reversed {keys:values}.
+    :return: Reversed dict with {set(values):list[keys]}.
+    """
+    new_dict = {}
+    for key, value in original_dict.items():
+        if value not in new_dict:
+            new_dict[value] = [key]
+        else:
+            new_dict[value].append(key)
+    return new_dict

simulator_core/entities/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__init__.py file for initialization code."""

simulator_core/entities/assets/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright (c) 2023. Deltares & TNO
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""__init__.py file for initialization code."""