OpenSimula 0.5.1__py3-none-any.whl

opensimula/components/Day_schedule.py

@@ -0,0 +1,64 @@
+from bisect import bisect
+from opensimula.Message import Message
+from opensimula.Parameters import (
+    Parameter_int_list,
+    Parameter_float_list,
+    Parameter_options,
+)
+from opensimula.Component import Component
+
+
+class Day_schedule(Component):
+    def __init__(self, name, project):
+        Component.__init__(self, name, project)
+        self.parameter("type").value = "Day_schedule"
+        self.parameter("description").value = "Time schedule for a day"
+        self.add_parameter(Parameter_int_list(
+            "time_steps", [3600], "s", min=1))
+        self.add_parameter(Parameter_float_list("values", [0, 10]))
+        self.add_parameter(
+            Parameter_options("interpolation", "STEP", ["STEP", "LINEAR"])
+        )
+
+    def check(self):
+        errors = super().check()
+        # Test time_steps and values sizes
+        if (
+            len(self.parameter("time_steps").value)
+            != len(self.parameter("values").value) - 1
+        ):
+            msg = f"Error: {self.parameter('name').value}, time_steps size must be values size minus 1"
+            errors.append(Message(msg,"ERROR"))
+
+        # Test total time steps
+        total_time = 0
+        for dt in self.parameter("time_steps").value:
+            total_time += dt
+        if total_time > 24 * 3600:
+            msg = f"Error: {self.parameter('name').value}, the sum of the time_steps is greater than one day (86400 s)"
+            errors.append(Message(msg,"ERROR"))
+        return errors
+
+    def pre_simulation(self, n_time_steps, delta_t):
+        # Create array of periods
+        self._periods_ = [0]
+        acumulated = 0
+        for period in self.parameter("time_steps").value:
+            acumulated += period
+            self._periods_.append(acumulated)
+        self._periods_.append(24 * 3600)
+
+    def get_value(self, date):
+        seconds = date.hour * 3600 + date.minute * 60 + date.second
+        index = bisect(self._periods_, seconds)
+        if self.parameter("interpolation").value == "LINEAR":
+            x_i = self._periods_[index - 1]
+            x_f = self._periods_[index]
+            y_i = self.parameter("values").value[index - 1]
+            if index < len(self.parameter("values").value):
+                y_f = self.parameter("values").value[index]
+            else:
+                y_f = self.parameter("values").value[0]
+            return (seconds - x_i) / (x_f - x_i) * (y_f - y_i) + y_i
+        else:
+            return self.parameter("values").value[index - 1]

opensimula/components/File_data.py

@@ -0,0 +1,117 @@
+import pandas as pd
+import datetime as dt
+import numpy as np
+import math
+from opensimula.Message import Message
+from opensimula.Parameters import Parameter_string, Parameter_options, Parameter_int
+from opensimula.Component import Component
+from opensimula.Variable import Variable
+
+
+class File_data(Component):
+    def __init__(self, name, project):
+        Component.__init__(self, name, project)
+        self.parameter("type").value = "File_data"
+        self.parameter("description").value = "Data file with varables"
+        self.add_parameter(Parameter_string("file_name", "data.csv"))
+        self.add_parameter(Parameter_options(
+            "file_type", "CSV", ["CSV", "EXCEL"]))
+        self.add_parameter(Parameter_options(
+            "file_step", "SIMULATION", ["SIMULATION", "OWN"]))
+        self.add_parameter(Parameter_string(
+            "initial_time", "01/01/2001 00:00:00"))
+        self.add_parameter(Parameter_int("time_step", 3600, "s", min=1))
+        self._df_ = pd.DataFrame()
+
+    def check(self):
+        errors = super().check()
+        if self.parameter("file_step").value == "OWN":  # Check initial time
+            try:
+                dt.datetime.strptime(self.parameter("initial_time").value, "%d/%m/%Y %H:%M:%S")
+            except ValueError:
+                msg = f"Error in component: {self.parameter('name').value}, initial_time: {self.parameter('initial_time').value} does not match format (dd/mm/yyyy HH:MM:SS)"
+                errors.append(Message(msg, "ERROR"))
+
+        # Read the file
+        try:
+            if self.parameter("file_type").value == "CSV":
+                self._df_ = pd.read_csv(self.parameter("file_name").value)
+            elif self.parameter("file_type").value == "EXCEL":
+                self._df_ = pd.read_excel(self.parameter("file_name").value)
+            # Create Variable
+            for col in self._df_.columns:
+                self.add_variable(Variable(self._extract_name_(
+                    col), unit=self._extract_unit_(col)))
+
+        except Exception as ex:
+            if type(ex).__name__ == "FileNotFoundError":
+                msg = f"Error in component: {self.parameter('name').value}, No such file: {self.parameter('file_name').value}"
+                errors.append(Message(msg, "ERROR"))
+            else:
+                msg = f"Error in component: {self.parameter('name').value}, error reading file: {self.parameter('file_name').value}"
+                errors.append(Message(msg, "ERROR"))                
+        return errors
+
+    def pre_simulation(self, n_time_steps, delta_t):
+        super().pre_simulation(n_time_steps, delta_t)
+
+        self.data_array = self._df_.to_numpy()
+
+        if self.parameter("file_step").value == "SIMULATION":
+            i = 0
+            k = 0
+            n = len(self._df_)
+            for key, var in self._variables_.items():
+                for j in range(n_time_steps):
+                    var.values[j] = self.data_array[k][i]
+                    k = k + 1
+                    if k == n:
+                        k = 0
+                i = i + 1
+        elif self.parameter("file_step").value == "OWN":
+            n = len(self._df_)
+            self._initial_date_ = dt.datetime.strptime(
+                self.parameter("initial_time").value, "%d/%m/%Y %H:%M:%S")
+            delta_t = self.parameter("time_step").value
+            date = self._initial_date_
+            self.dates = np.empty(n, dtype=object)
+            for i in range(n):
+                self.dates[i] = date
+                date = date + dt.timedelta(0, delta_t)
+
+    def pre_iteration(self, time_index, date, daylight_saving):
+        super().pre_iteration(time_index, date, daylight_saving)
+        if self.parameter("file_step").value == "OWN":
+            i, j, f = self._get_interpolation_tuple_(date)
+            k = 0
+            for key, var in self._variables_.items():
+                var.values[time_index] = self.data_array[i][k] * \
+                    (1 - f) + self.data_array[j][k] * f
+                k = k + 1
+
+    def _extract_name_(self, name):
+        if name.rfind("[") == -1:
+            return name
+        else:
+            return name[0: name.rfind("[")].strip()
+
+    def _extract_unit_(self, name):
+        if name.rfind("[") == -1:
+            return ""
+        else:
+            return name[name.rfind("[") + 1: name.rfind("]")].strip()
+
+    def _get_interpolation_tuple_(self, date):
+        seconds = (date-self._initial_date_).total_seconds()
+        index = seconds / self.parameter("time_step").value
+        n = len(self._df_)
+        if index < 0:
+            index = 0
+        elif index >= n:
+            index = n-1
+        i = math.floor(index)
+        j = i + 1
+        if j >= n:
+            j = n-1
+        f = index - i
+        return (i, j, f)