OpenDHW 0.2.7__tar.gz → 0.2.9__tar.gz

{opendhw-0.2.7 → opendhw-0.2.9}/OpenDHW/Data/prob_nonresidential.json

@@ -624,8 +624,8 @@
         0.169014085
       ],
       [
-        3,
-        0.105633803
+        4,
+        0.14084507
       ],
       [
         2,

{opendhw-0.2.7 → opendhw-0.2.9}/OpenDHW/OpenDHW.py

@@ -162,7 +162,7 @@ def import_from_dhwcalc(s_step, daylight_saving, categories,occupancy,
     return timeseries_df
 
 
-def generate_dhw_profile(s_step, categories, mean_drawoff_vol_per_day, occupancy, holidays, building_type,  weekend_weekday_factor, initial_day=0):
+def generate_dhw_profile(s_step, categories, mean_drawoff_vol_per_day, occupancy, holidays, building_type,  weekend_weekday_factor, initial_day=0, occupancy_profile=None):
     """
     Generates a DHW profile. The generation is split up in different
     functions and generally follows the methodology described in the DHWcalc
@@ -178,7 +178,12 @@ def generate_dhw_profile(s_step, categories, mean_drawoff_vol_per_day, occupancy
     :param categories:                  int:    1 or 4 (see DHWcalc)
     :param weekend_weekday_factor:      int:    taken from DHWcalc
     :param mean_drawoff_vol_per_day:    int:    daily water demand in Liters
+    :param occupancy:                    float:  occupancy of the building, between 0 and 1, multiplies the water demand
+    :param holidays:                   list:   list of holidays (day of year, 1-365)
+    :param building_type:                string: type of building, determines which days are off days
     :param initial_day:                 int:    0:Mon - 1:Tues ... 6:Sun
+    :param occupancy_profile:           list:   optional profile to adjust the probabilities, has to fit in length to p_final (s_step)
+
     :return: timeseries_df              df:     dataframe with all timeseries
     """
 
@@ -199,7 +204,8 @@ def generate_dhw_profile(s_step, categories, mean_drawoff_vol_per_day, occupancy
         weekend_weekday_factor=weekend_weekday_factor,
         holidays = holidays,
         initial_day=initial_day,
-        building_type=building_type
+        building_type=building_type,
+        occupancy_profile=occupancy_profile
     )
 
     # --- empty drawoffs list, will be filled afterwards
@@ -379,7 +385,7 @@ def generate_daily_probability_step_function(mode, s_step,building_type, save_fi
 
 
 def generate_yearly_probability_profile(s_step, weekend_weekday_factor,building_type, holidays,
-                                        initial_day=0):
+                                        initial_day=0, occupancy_profile=None):
     """
     generate a summed yearly probability profile. The whole function is
     deterministic. The same inputs always produce the same outputs.
@@ -394,6 +400,10 @@ def generate_yearly_probability_profile(s_step, weekend_weekday_factor,building_
     :param s_step:                  int:    seconds in a timestep
     :param weekend_weekday_factor:  float:  shift probabilities towards weekend
     :param initial_day:             int:    Mon: 0 ... Sun: 6
+    :param holidays:                list:   list of holidays (day of year, 1-365)
+    :param building_type:            string: type of building, determines which days are off days
+    :param occupancy_profile:        list:   optional profile to adjust the probabilities, has to fit in length to p_final
+
     :return: timeseries_df:         df:     df that holds the yearly profile
     """
 
@@ -424,7 +434,8 @@ def generate_yearly_probability_profile(s_step, weekend_weekday_factor,building_
         p_work_day=p_wd_weighted,
         s_step=s_step,
         holidays=holidays,
-        building_type=building_type
+        building_type=building_type,
+        occupancy_profile=occupancy_profile
     )
 
     # sum and normalize to range between 0 and 1.
@@ -460,7 +471,7 @@ def shift_weekend_weekday(p_work_day, p_off_day, factor):
 
     assert p_wd_factor * 5 / 7 + p_we_factor * 2 / 7 == 1
 
-    p_wd_weighted = [p * p_we_factor for p in p_work_day]
+    p_wd_weighted = [p * p_wd_factor for p in p_work_day]
     p_we_weighted = [p * p_we_factor for p in p_off_day]
 
     av_p_wd_weighted = statistics.mean(p_wd_weighted)
@@ -472,18 +483,20 @@ def shift_weekend_weekday(p_work_day, p_off_day, factor):
 
 
 def generate_yearly_probabilities(initial_day, p_off_day, p_work_day,
-                                  s_step, holidays,building_type, plot_p_yearly=False):
+                                  s_step, holidays,building_type, plot_p_yearly=False, occupancy_profile=None):
     """
     Takes the probabilities of a working days and a off days and generates a
     list of yearly probabilities by adding a seasonal probability factor.
     The seasonal factor is a sine-function, like in DHWcalc.
 
-    :param initial_day:     int:    0: Mon, 1: Tue, 2: Wed, 3: Thur, 4: Fri,
-                                    5 : Sat, 6 : Sun
+    :param initial_day:     int:    0: Mon, 1: Tue, 2: Wed, 3: Thur, 4: Fri, 5 : Sat, 6 : Sun
     :param p_off_day:       list:   probabilities of an off day
     :param p_work_day:       list:   probabilities of a working day
     :param s_step:          int:    seconds within a timestep
     :param plot_p_yearly:   bool:   plot the yearly probabilities
+    :param holidays:        list:   list of holidays (day of year, 1-365)
+    :param building_type:    string: type of building, determines which days are off days
+    :param occupancy_profile: list:   optional profile to adjust the probabilities, has to fit in length to p_final
 
     :return: p_final:       list:   probabilities of a full year
     """
@@ -517,6 +530,40 @@ def generate_yearly_probabilities(initial_day, p_off_day, p_work_day,
             probability = p_day[step] * probability_season
             p_final.append(probability)
 
+    p_final = np.array(p_final)
+
+    if occupancy_profile is not None:
+        occupancy_profile = np.asarray(occupancy_profile, dtype=float)
+
+        if occupancy_profile.ndim != 1 or occupancy_profile.size == 0:
+            raise ValueError("occupancy_profile must be a non-empty 1-D array-like of numbers.")
+        if not np.all(np.isfinite(occupancy_profile)):
+            raise ValueError("occupancy_profile must not contain NaN or infinite values.")
+        if np.any(occupancy_profile < 0):
+            raise ValueError("occupancy_profile must not contain negative values.")
+        if not np.any(occupancy_profile):
+            raise ValueError(
+                "occupancy_profile is all zeros; this would zero out the entire "
+                "probability distribution and cause a division by zero downstream."
+            )
+
+        len_p = len(p_final)
+        len_occ = len(occupancy_profile)
+        if len_occ != len_p:
+            ratio = len_p / len_occ
+            if ratio.is_integer() and ratio > 1:
+                occupancy_profile = np.repeat(occupancy_profile, int(ratio))
+            else:
+                direction = "longer than" if len_occ > len_p else "not an integer divisor of"
+                raise ValueError(
+                    f"occupancy_profile length ({len_occ}) is {direction} the target length "
+                    f"({len_p}, from s_step={s_step}). occupancy_profile must either match "
+                    f"the target length exactly, or be a shorter list whose length divides "
+                    f"evenly into it (it will be upsampled via np.repeat); downsampling a "
+                    f"longer profile is not supported."
+                )
+        p_final *= occupancy_profile
+
     if plot_p_yearly:
         fig, ax = plt.subplots()
         plt.plot(p_final)
@@ -781,7 +828,7 @@ def draw_lineplot(timeseries_df, plot_var='water', start_plot='2019-02-01',
         # compute some stats for figure title.
         max_water_flow = timeseries_df['Water_LperH'].max()  # in L/h
         s_step = timeseries_df.index.freqstr
-        method = timeseries_df['method'][0]
+        method = timeseries_df['method'].iloc[0]
 
         plt.title('Heat Time-series from {}, timestep = {}\n'
                   'with a Peak of {:.1f} L/h'.format(method, s_step,
@@ -797,10 +844,10 @@ def draw_lineplot(timeseries_df, plot_var='water', start_plot='2019-02-01',
     plt.show()
 
     if save_fig:
-        method = timeseries_df['method'][0]
+        method = timeseries_df['method'].iloc[0]
         s_step = get_s_step(timeseries_df)
-        vol_per_day = timeseries_df['mean_drawoff_vol_per_day'][0]
-        cats = timeseries_df['categories'][0]
+        vol_per_day = timeseries_df['mean_drawoff_vol_per_day'].iloc[0]
+        cats = timeseries_df['categories'].iloc[0]
 
         dir_output = Path.cwd() / "plots"
         dir_output.mkdir(exist_ok=True)
@@ -825,7 +872,7 @@ def draw_histplot(timeseries_df, extra_kde=False, save_fig=False):
     # get non-zero values of the profile
     drawoffs_df = get_drawoffs(timeseries_df=timeseries_df, remove_cats=False)
 
-    cats = timeseries_df['categories'][0]
+    cats = timeseries_df['categories'].iloc[0]
     if cats == 1:
         drawoffs_df = drawoffs_df['Water_LperH']
 
@@ -848,10 +895,10 @@ def draw_histplot(timeseries_df, extra_kde=False, save_fig=False):
     plt.show()
 
     if save_fig:
-        method = timeseries_df['method'][0]
+        method = timeseries_df['method'].iloc[0]
         s_step = get_s_step(timeseries_df)
-        vol_per_day = timeseries_df['mean_drawoff_vol_per_day'][0]
-        cats = timeseries_df['categories'][0]
+        vol_per_day = timeseries_df['mean_drawoff_vol_per_day'].iloc[0]
+        cats = timeseries_df['categories'].iloc[0]
 
         dir_output = Path.cwd() / "plots"
         dir_output.mkdir(exist_ok=True)
@@ -868,14 +915,14 @@ def draw_detailed_histplot(timeseries_df):
     https://towardsdatascience.com/advanced-histogram-using-python-bceae288e715
     plot to further analyse timeseries with 1 drawoff category.
     """
-    cats = timeseries_df['categories'][0]
-    method = timeseries_df['method'][0]
+    cats = timeseries_df['categories'].iloc[0]
+    method = timeseries_df['method'].iloc[0]
 
     if cats == 1 and method == 'DHWcalc':
 
         # create bin values
-        mean = timeseries_df['mean_drawoff_flow_rate_LperH'][0]
-        sdtdev = timeseries_df['sdtdev_drawoff_flow_rate_LperH'][0]
+        mean = timeseries_df['mean_drawoff_flow_rate_LperH'].iloc[0]
+        sdtdev = timeseries_df['sdtdev_drawoff_flow_rate_LperH'].iloc[0]
         non_zero_min = timeseries_df[timeseries_df['Water_LperH'] > 0][
             'Water_LperH'].min()  # smallest entry that is not 0.
 
@@ -943,11 +990,11 @@ def add_additional_runs(timeseries_df, holidays, occupancy, building_type, total
     added_runs = total_runs - 1
 
     s_step = int(timeseries_df.index.freqstr[:-1])
-    mean_drawoff_vol_per_day = timeseries_df['mean_drawoff_vol_per_day'][0]
-    weekend_weekday_factor = timeseries_df['weekend_weekday_factor'][0]
-    initial_day = timeseries_df['initial_day'][0]
-    method = timeseries_df['method'][0]
-    categories = timeseries_df['categories'][0]
+    mean_drawoff_vol_per_day = timeseries_df['mean_drawoff_vol_per_day'].iloc[0]
+    weekend_weekday_factor = timeseries_df['weekend_weekday_factor'].iloc[0]
+    initial_day = timeseries_df['initial_day'].iloc[0]
+    method = timeseries_df['method'].iloc[0]
+    categories = timeseries_df['categories'].iloc[0]
 
     if method == 'OpenDHW':
 
@@ -1165,8 +1212,8 @@ def compare_generators(timeseries_df_1, timeseries_df_2,
     :param save_fig:                    bool:   save the plot
     """
 
-    cats_1 = timeseries_df_1['categories'][0]
-    cats_2 = timeseries_df_2['categories'][0]
+    cats_1 = timeseries_df_1['categories'].iloc[0]
+    cats_2 = timeseries_df_2['categories'].iloc[0]
     if cats_1 or cats_2 == 1:
         print("detailed distribution is designed to compare timeseries with "
               "one drawoff category")
@@ -1307,8 +1354,8 @@ def compare_generators(timeseries_df_1, timeseries_df_2,
         drawoffs_lst = [drawoffs_1, drawoffs_2]
 
         # create bin values
-        mean1 = timeseries_df_1['mean_drawoff_flow_rate_LperH'][0]
-        sdtdev1 = timeseries_df_1['sdtdev_drawoff_flow_rate_LperH'][0]
+        mean1 = timeseries_df_1['mean_drawoff_flow_rate_LperH'].iloc[0]
+        sdtdev1 = timeseries_df_1['sdtdev_drawoff_flow_rate_LperH'].iloc[0]
         non_zero_min1 = timeseries_df_1[timeseries_df_1['Water_LperH'] > 0][
             'Water_LperH'].min()  # smallest entry that is not 0.
 
@@ -1322,8 +1369,8 @@ def compare_generators(timeseries_df_1, timeseries_df_2,
         bin_values1 = list(set(bin_values1))  # remove double entries
         bin_values1.sort()  # bins have to be sorted
 
-        mean2 = timeseries_df_2['mean_drawoff_flow_rate_LperH'][0]
-        sdtdev2 = timeseries_df_2['sdtdev_drawoff_flow_rate_LperH'][0]
+        mean2 = timeseries_df_2['mean_drawoff_flow_rate_LperH'].iloc[0]
+        sdtdev2 = timeseries_df_2['sdtdev_drawoff_flow_rate_LperH'].iloc[0]
         non_zero_min2 = timeseries_df_2[timeseries_df_2['Water_LperH'] > 0][
             'Water_LperH'].min()  # smallest entry that is not 0.
 
@@ -1510,8 +1557,8 @@ def make_title_str(timeseries_df):
     yearly_water_demand = timeseries_df['Water_L'].sum()  # in L
     drawoffs = timeseries_df[timeseries_df['Water_LperH'] != 0]['Water_LperH']
     max_water_flow = timeseries_df['Water_LperH'].max()
-    method = timeseries_df['method'][0]
-    cats = timeseries_df['categories'][0]
+    method = timeseries_df['method'].iloc[0]
+    cats = timeseries_df['categories'].iloc[0]
 
     if cats == 1:
         method = "{} ({} cat)".format(method, cats)
@@ -1642,7 +1689,7 @@ def reduce_no_drawoffs(timeseries_df):
     """
 
     # get the expected yearly water demand
-    expected_yearly_water = timeseries_df['mean_drawoff_vol_per_day'][0] * 365
+    expected_yearly_water = timeseries_df['mean_drawoff_vol_per_day'].iloc[0] * 365
     actual_yearly_water = timeseries_df['Water_L'].sum()
 
     if expected_yearly_water < actual_yearly_water:

{opendhw-0.2.7 → opendhw-0.2.9}/OpenDHW/__init__.py

@@ -5,4 +5,4 @@ as well as a utils package.
 """
 
 from OpenDHW.OpenDHW import *
-__version__ = '0.2.7'
+__version__ = '0.2.9'

{opendhw-0.2.7 → opendhw-0.2.9/OpenDHW.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenDHW
-Version: 0.2.7
+Version: 0.2.9
 Summary: Tool for generating domestic hot water profiles
 Home-page: https://github.com/RWTH-EBC/OpenDHW
 Author: RWTH Aachen University, E.ON Energy Research Center, Institute of Energy Efficient Buildings and Indoor Climate

{opendhw-0.2.7/OpenDHW.egg-info → opendhw-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: OpenDHW
-Version: 0.2.7
+Version: 0.2.9
 Summary: Tool for generating domestic hot water profiles
 Home-page: https://github.com/RWTH-EBC/OpenDHW
 Author: RWTH Aachen University, E.ON Energy Research Center, Institute of Energy Efficient Buildings and Indoor Climate