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

simulator_core/entities/utility/influxdb_reader.py

@@ -0,0 +1,129 @@
+#  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 to read the esdl profiles from an energy system."""
+from esdl.profiles.influxdbprofilemanager import InfluxDBProfileManager
+from esdl.units.conversion import ENERGY_IN_J, POWER_IN_W, convert_to_unit
+import esdl
+from esdl.esdl_handler import EnergySystemHandler
+from typing import Dict, Tuple
+import pandas as pd
+
+
+def parse_esdl_profiles(esh: EnergySystemHandler) -> Dict[str, pd.DataFrame]:
+    """Method to parse the esdl profiles from an energy system.
+
+    This method tries to parse the esdl profiles from an energy system.
+    :param esh: EnergySystemHandler with the energy system
+    :param start_date: datetime.datetime with the start date
+    :param end_date: datetime.datetime with the end date
+    :return: dict with the parsed profiles
+    """
+    data_set = {}
+    for profile in esh.get_all_instances_of_type(esdl.InfluxDBProfile):
+        data_set[profile.id] = get_data_from_profile(profile)
+    return data_set
+
+
+def get_data_from_profile(esdl_profile: esdl.InfluxDBProfile) -> pd.DataFrame:
+    """Method to get the data from the esdl influxdb profile.
+
+    This method tries to get the data from the esdl profile.
+    :param esdl_profile: esdl.Profile with the profile
+    :return: pandas.DataFrame with the data
+    """
+    influx_cred_map: Dict[str, Tuple[str, str]] = {}
+    profile_host = esdl_profile.host
+    ssl_setting = False
+    if "https" in profile_host:
+        profile_host = profile_host[8:]
+        ssl_setting = True
+    elif "http" in profile_host:
+        profile_host = profile_host[7:]
+    # why is this here?
+    if esdl_profile.port == 443:
+        ssl_setting = True
+
+    influx_host = "{}:{}".format(profile_host, esdl_profile.port)
+    if influx_host in influx_cred_map:
+        (username, password) = influx_cred_map[influx_host]
+    else:
+        username = None
+        password = None
+    time_series_data = InfluxDBProfileManager.create_esdl_influxdb_profile_manager(
+        esdl_profile,
+        username,
+        password,
+        ssl_setting,
+        ssl_setting,
+    )
+    # Error check start and end dates of profiles
+
+    # I do not thing this is required since you set it in mapeditor.
+    if time_series_data.end_datetime != esdl_profile.endDate:
+        raise RuntimeError(
+            f"The user input profile end datetime: {esdl_profile.endDate} does not match the end"
+            f" datetime in the datbase: {time_series_data.end_datetime} for variable: "
+            f"{esdl_profile.field}"
+        )
+    if time_series_data.start_datetime != esdl_profile.startDate:
+        raise RuntimeError(
+            f"The user input profile start datetime: {esdl_profile.startDate} does not match the"
+            f" start date in the datbase: {time_series_data.start_datetime} for variable: "
+            f"{esdl_profile.field}"
+        )
+    if time_series_data.start_datetime != time_series_data.profile_data_list[0][0]:
+        raise RuntimeError(
+            f"The profile's variable value for the start datetime: "
+            f"{time_series_data.start_datetime} does not match the start datetime of the"
+            f" profile data: {time_series_data.profile_data_list[0][0]}"
+        )
+    if time_series_data.end_datetime != time_series_data.profile_data_list[-1][0]:
+        raise RuntimeError(
+            f"The profile's variable value for the end datetime: "
+            f"{time_series_data.end_datetime} does not match the end datetime of the"
+            f" profile data: {time_series_data.profile_data_list[-1][0]}"
+        )
+
+    unit = get_unit(esdl_profile)
+    dates = [time_stamp for time_stamp, _ in
+             time_series_data.profile_data_list]
+    values = [convert_to_unit(value, esdl_profile.profileQuantityAndUnit, unit)
+              * esdl_profile.multiplier
+              for _, value in time_series_data.profile_data_list]
+    data_points = {"date": dates, "values": values}
+
+    return pd.DataFrame(data_points)
+
+
+def get_unit(profile: esdl.InfluxDBProfile) -> esdl.PhysicalQuantityEnum:
+    """Method to get the SI unit of the profile.
+
+    This method tries to get the unit of the profile.
+    if the unit is not in the list the same unit as the profile is returned
+    :param profile: esdl.InfluxDBProfile with the profile
+    :return: esdl.PhysicalQuantityEnum with the unit
+    """
+    conversion_dict = {
+        esdl.PhysicalQuantityEnum.POWER: POWER_IN_W,
+        esdl.PhysicalQuantityEnum.ENERGY: ENERGY_IN_J
+    }
+    try:
+        profile_unit = profile.profileQuantityAndUnit.reference.physicalQuantity
+    except AttributeError:
+        profile_unit = profile.profileQuantityAndUnit.physicalQuantity
+    if profile_unit in conversion_dict:
+        return conversion_dict[profile_unit]
+    return profile_unit

simulator_core/infrastructure/__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/infrastructure/app.py

@@ -0,0 +1,55 @@
+#  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/>.
+
+"""Entry point for running simulator-core library from cmdline."""
+
+import logging
+import sys
+import traceback
+import uuid
+from datetime import datetime
+
+import pandas as pd
+
+from simulator_core.entities.esdl_object import EsdlObject
+from simulator_core.entities.simulation_configuration import SimulationConfiguration
+from simulator_core.infrastructure.simulation_manager import SimulationManager
+from simulator_core.infrastructure.utils import pyesdl_from_file
+
+logger = logging.getLogger(__name__)
+
+
+def run(file_path: str | None = None) -> pd.DataFrame:
+    """Main run function for the heatnetwork simulator."""
+    config = SimulationConfiguration(
+        simulation_id=uuid.uuid1(),
+        name="test run",
+        timestep=3600,
+        start=datetime.strptime("2019-01-01T00:00:00", "%Y-%m-%dT%H:%M:%S"),
+        stop=datetime.strptime("2019-01-01T01:00:00", "%Y-%m-%dT%H:%M:%S"),
+    )
+
+    esdl_file_path = sys.argv[1] if file_path is None else file_path
+    try:
+        app = SimulationManager(EsdlObject(pyesdl_from_file(esdl_file_path)), config)
+        result = app.execute()
+        return result
+    except Exception as error:
+        logger.error(f"Error occured: {error} at: {traceback.format_exc(limit=-1)}")
+        logger.debug(traceback.format_exc())
+
+
+if __name__ == "__main__":
+    print(run(r".\testdata\test1.esdl"))

simulator_core/infrastructure/simulation_manager.py

@@ -0,0 +1,55 @@
+#  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/>.
+
+"""Simulation manager creates and controls the simulation objects."""
+
+import pandas as pd
+
+from simulator_core.adapter.transforms.mappers import EsdlControllerMapper, EsdlEnergySystemMapper
+from simulator_core.entities.esdl_object import EsdlObject
+from simulator_core.entities.heat_network import HeatNetwork
+from simulator_core.entities.simulation_configuration import SimulationConfiguration
+from simulator_core.simulation import NetworkSimulation
+
+
+class SimulationManager:
+    """Manager class for managing the simulation."""
+
+    def __init__(self, esdl: EsdlObject, config: SimulationConfiguration):
+        """Constructor for SimulationManager class.
+
+        :param EsdlObject esdl: Esdlobject, which stores the network information
+        :param SimulationConfiguration config: Config object to hold the simulation start, stop, end
+        """
+        self.esdl = esdl
+        self.config = config
+
+    def execute(self) -> pd.DataFrame:
+        """Method to simulate the network.
+
+        First the network is converted to pandapipes and then the simulation is run.
+
+        :return: DataFrame with the result of the simulations
+        """
+        # convert ESDL to Heat Network, NetworkController
+        network = HeatNetwork(EsdlEnergySystemMapper(self.esdl).to_entity)
+        controller = EsdlControllerMapper().to_entity(self.esdl)
+
+        worker = NetworkSimulation(network, controller)
+        worker.run(self.config)
+
+        # Run output presenter that iterates over het network (/controller?) and
+        # gathers the output into a single data object
+        return worker.gather_output()

simulator_core/infrastructure/utils.py

@@ -0,0 +1,45 @@
+#  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 utility functions."""
+
+from esdl.esdl_handler import EnergySystemHandler
+from pathlib import Path
+
+
+def pyesdl_from_file(file_path: str) -> EnergySystemHandler:
+    """
+    Loads esdl file into memory and returns a handle to be able to use this file.
+
+    Please note that it is not checked if the file is a valid esdl file.
+    :param file_path: string pointing to the esdl file to be loaded into memory
+    """
+    if not Path(file_path).is_file():
+        raise FileNotFoundError("Not a valid path to an ESDL file")
+    esh = EnergySystemHandler()
+    esh.load_file(file_path)
+    return esh
+
+
+def pyesdl_from_string(input_str: str) -> EnergySystemHandler:
+    """
+    Loads esdl file from a string into memory.
+
+    Please note that it is not checked if the contents of the string is a valid esdl.
+    :param input_str: string containing the contents of an esdl file.
+    """
+    esh = EnergySystemHandler()
+    esh.load_from_string(input_str)
+    return esh

simulator_core/simulation/__init__.py

@@ -0,0 +1,18 @@
+#  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."""
+
+from .networksimulation import NetworkSimulation

simulator_core/simulation/mappers/__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/simulation/mappers/mappers.py

@@ -0,0 +1,35 @@
+#  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 abstract class for the mappers."""
+
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+
+Entity = TypeVar("Entity")
+EsdlAssetObject = TypeVar("EsdlAssetObject")
+
+
+class EsdlMapperAbstract(ABC, Generic[Entity, EsdlAssetObject]):
+    """Abstract class to be used for deriving mapper classes from esdl to our own classes."""
+
+    @abstractmethod
+    def to_esdl(self, entity: Entity) -> EsdlAssetObject:
+        """Map an Entity to a EsdlAsset."""
+
+    @abstractmethod
+    def to_entity(self, model: EsdlAssetObject) -> Entity:
+        """Map am esdl asset  to an Entity."""

simulator_core/simulation/networksimulation.py

@@ -0,0 +1,63 @@
+#  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/>.
+
+"""Simulates an heat network for the specified duration."""
+
+from pandas import DataFrame
+from simulator_core.entities.heat_network import HeatNetwork
+from simulator_core.entities.network_controller import NetworkController
+from simulator_core.entities.simulation_configuration import SimulationConfiguration
+from datetime import timedelta, timezone
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class NetworkSimulation:
+    """NetworkSimulation connects the controller and HeatNetwork (incl. assets)."""
+
+    def __init__(self, network: HeatNetwork, controller: NetworkController):
+        """Instantiate the NetworkSimulation object."""
+        self.network = network
+        self.controller = controller
+
+    def run(self, config: SimulationConfiguration) -> None:
+        """Run the simulation.
+
+        :param SimulationConfiguration config: Configuration to run the simulation with.
+        """
+        # time loop
+        number_of_time_steps = int((config.stop - config.start).total_seconds() / config.timestep)
+        for time_step in range(number_of_time_steps):
+            not_converged = True
+            time = (config.start + timedelta(seconds=time_step * config.timestep)
+                    ).replace(tzinfo=timezone.utc)
+            controller_input = self.controller.run_time_step(time)
+
+            while not_converged:
+                not_converged = False  # for the moment we do not check on convergence,
+                # to get stuff running. Also need to add break after 10 iteration.
+                logger.debug("Simulating for timestep " + str(time))
+                self.network.run_time_step(time, controller_input)
+            self.network.store_output()
+
+    def gather_output(self) -> DataFrame:
+        """Gathers all output and return a dict with this output.
+
+        :return: DataFrame with all the results for the simulation
+        """
+        result = self.network.gather_output()
+        return result

simulator_core/solver/__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/solver/matrix/__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/solver/matrix/core_enum.py

@@ -0,0 +1,26 @@
+#  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/>.
+"""This file contains the enum for the core quantities of the matrix."""
+from enum import IntEnum
+
+NUMBER_CORE_QUANTITIES = 3
+
+
+class IndexEnum(IntEnum):
+    """Enum for the index of the matrix."""
+
+    discharge = 0
+    pressure = 1
+    internal_energy = 2

simulator_core/solver/matrix/equation_object.py

@@ -0,0 +1,56 @@
+#  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 store equations."""
+import numpy as np
+
+
+class EquationObject:
+    """Class to store equation objects.
+
+    Indices are the location in the matrix of the coefficients
+    rhs is the rhs of the matrix.
+    """
+
+    indices: np.ndarray
+    """Indices of the coefficients in the matrix."""
+
+    coefficients: np.ndarray
+    """Coefficients of the equation."""
+
+    rhs: float
+    """Right hand side of the equation."""
+
+    def __init__(self) -> None:
+        """Constructor of the EquationObject."""
+        self.indices = np.array([], dtype=int)
+        self.coefficients = np.array([], dtype=float)
+        self.rhs = 0.0
+
+    def to_list(self, length: int) -> list[float]:
+        """Method to change the equation object to list which can be stored in the matrix.
+
+        The method creates a list with zero of the length given in the input.
+        At the indices of the class the coefficients of the class are stored.
+        :param int length: Length of the list to be returned
+        :return: a list of the coefficient which can be used in the matrix.
+        """
+        if length < len(self.indices):
+            raise IndexError(f"Length of {length} smaller than the available number "
+                             f"of coefficients {len(self.coefficients)}!")
+
+        coefficient_list: list[float] = [0.0] * length
+        for col, coefficient in zip(self.indices, self.coefficients):
+            coefficient_list[col] = coefficient
+        return coefficient_list