urbanopt-cli 0.5.2 → 0.6.3

data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/geometry.rb

@@ -1815,19 +1815,19 @@ class Geometry
       attic_space_type = OpenStudio::Model::SpaceType.new(model)
       attic_space_type.setStandardsSpaceType(attic_space_name)
       attic_space.setSpaceType(attic_space_type)
-    end
 
-    # Adiabatic surfaces for attic walls
-    attic_space.surfaces.each do |surface|
-      os_facade = get_facade_for_surface(surface)
-      next unless surface.surfaceType == 'Wall'
-      next unless adb_facade.include? os_facade
-      x_ft = UnitConversions.convert(x, 'm', 'ft')
-      max_x = getSurfaceXValues([surface]).max
-      min_x = getSurfaceXValues([surface]).min
-      next if ((max_x - x_ft).abs >= 0.01) && (min_x > 0)
+      # Adiabatic surfaces for attic walls
+      attic_space.surfaces.each do |surface|
+        os_facade = get_facade_for_surface(surface)
+        next unless surface.surfaceType == 'Wall'
+        next unless adb_facade.include? os_facade
+        x_ft = UnitConversions.convert(x, 'm', 'ft')
+        max_x = getSurfaceXValues([surface]).max
+        min_x = getSurfaceXValues([surface]).min
+        next if ((max_x - x_ft).abs >= 0.01) && (min_x > 0)
 
-      surface.setOutsideBoundaryCondition('Adiabatic')
+        surface.setOutsideBoundaryCondition('Adiabatic')
+      end
     end
 
     # put all of the spaces in the model into a vector

data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
-require 'yaml'
+require 'json'
 require 'matrix'
 
 class ScheduleGenerator
@@ -356,7 +356,7 @@ class ScheduleGenerator
     prng = Random.new(get_random_seed)
 
     # load the schedule configuration file
-    schedule_config = YAML.load_file(args[:resources_path] + '/schedules_config.yml')
+    schedule_config = JSON.parse(File.read(args[:resources_path] + '/schedules_config.json'))
 
     # pre-load the probability distribution csv files for speed
     cluster_size_prob_map = read_activity_cluster_size_probs(resources_path: args[:resources_path])
@@ -371,7 +371,7 @@ class ScheduleGenerator
     # if geometry_num_occupants = 2, period_in_a_year = 35040,  num_of_states = 7, then
     # shape of all_simulated_values is [2, 35040, 7]
     (1..args[:geometry_num_occupants]).each do |i|
-      occ_type_id = weighted_random(prng, schedule_config['occupancy_types_probability'])
+      occ_type_id = weighted_random(prng, schedule_config['occupancy_types']['probabilities'])
       init_prob_file_weekday = args[:resources_path] + "/schedules_weekday_mkv_chain_initial_prob_cluster_#{occ_type_id}.csv"
       initial_prob_weekday = CSV.read(init_prob_file_weekday)
       initial_prob_weekday = initial_prob_weekday.map { |x| x[0].to_f }
@@ -418,10 +418,7 @@ class ScheduleGenerator
           if j >= @mkc_ts_per_day then break end # break as soon as we have filled activities for the day
 
           transition_probs = transition_matrix[(j - 1) * 7...j * 7] # obtain the transition matrix for current timestep
-          transition_probs_matrix = Matrix[*transition_probs]
-          current_state_vec = Matrix.row_vector(state_vector)
-          state_prob = current_state_vec * transition_probs_matrix # Get a new state_probability array
-          state_prob = state_prob.to_a[0]
+          state_prob = transition_probs[active_state]
         end
       end
       # Markov-chain transition probabilities is based on ATUS data, and the starting time of day for the data is
@@ -456,7 +453,6 @@ class ScheduleGenerator
 
     # fill in the yearly time_step resolution schedule for plug/lighting and ceiling fan based on weekday/weekend sch
     # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
-    sim_year = @model.getYearDescription.calendarYear.get
     @total_days_in_year.times do |day|
       today = @sim_start_day + day
       month = today.month
@@ -500,7 +496,7 @@ class ScheduleGenerator
     #   d. if more cluster, go to 4.
     mins_in_year = 1440 * @total_days_in_year
     mkc_steps_in_a_year = @total_days_in_year * @mkc_ts_per_day
-    sink_activtiy_probable_mins = [0] * mkc_steps_in_a_year # 0 indicates sink activity cannot happen at that time
+    sink_activity_probable_mins = [0] * mkc_steps_in_a_year # 0 indicates sink activity cannot happen at that time
     sink_activity_sch = [0] * 1440 * @total_days_in_year
     # mark minutes when at least one occupant is doing nothing at home as possible sink activity time
     # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
@@ -508,7 +504,7 @@ class ScheduleGenerator
       all_simulated_values.size.times do |i| # across occupants
         # if at least one occupant is not sleeping and not absent from home, then sink event can occur at that time
         if not ((all_simulated_values[i][step, 0] == 1) || (all_simulated_values[i][step, 5] == 1))
-          sink_activtiy_probable_mins[step] = 1
+          sink_activity_probable_mins[step] = 1
         end
       end
     end
@@ -516,20 +512,25 @@ class ScheduleGenerator
     sink_duration_probs = schedule_config['sink']['duration_probability']
     events_per_cluster_probs = schedule_config['sink']['events_per_cluster_probs']
     hourly_onset_prob = schedule_config['sink']['hourly_onset_prob']
-    total_clusters = schedule_config['sink']['total_annual_cluster']
-    sink_between_event_gap = schedule_config['sink']['between_event_gap']
-    cluster_per_day = total_clusters / @total_days_in_year
+    # Lookup avg_clusters_per_occ from json
+    avg_sink_clusters_per_hh = schedule_config['sink']['avg_sink_clusters_per_hh']
+    # Adjust avg_clusters_per_hh for number of occupants in household
+    total_clusters = avg_sink_clusters_per_hh * (0.29 * args[:geometry_num_occupants] + 0.26) # Eq based on cluster scaling in Building America DHW Event Schedule Generator (fewer sink draw clusters for larger households)
+    sink_minutes_between_event_gap = schedule_config['sink']['minutes_between_event_gap']
+    cluster_per_day = (total_clusters / @total_days_in_year).to_i
     sink_flow_rate_mean = schedule_config['sink']['flow_rate_mean']
     sink_flow_rate_std = schedule_config['sink']['flow_rate_std']
     sink_flow_rate = gaussian_rand(prng, sink_flow_rate_mean, sink_flow_rate_std, 0.1)
     @total_days_in_year.times do |day|
       cluster_per_day.times do |cluster_count|
-        todays_probable_steps = sink_activtiy_probable_mins[day * @mkc_ts_per_day...((day + 1) * @mkc_ts_per_day)]
+        todays_probable_steps = sink_activity_probable_mins[day * @mkc_ts_per_day...((day + 1) * @mkc_ts_per_day)]
         todays_probablities = todays_probable_steps.map.with_index { |p, i| p * hourly_onset_prob[i / @mkc_ts_per_hour] }
-        prob_sum = todays_probablities.reduce(0, :+)
+        prob_sum = todays_probablities.sum(0)
         normalized_probabilities = todays_probablities.map { |p| p * 1 / prob_sum }
         cluster_start_index = weighted_random(prng, normalized_probabilities)
-        sink_activtiy_probable_mins[cluster_start_index] = 0 # mark the 15-min interval as unavailable for another sink event
+        if sink_activity_probable_mins[cluster_start_index] != 0
+          sink_activity_probable_mins[cluster_start_index] = 0 # mark the 15-min interval as unavailable for another sink event
+        end
         num_events = weighted_random(prng, events_per_cluster_probs) + 1
         start_min = cluster_start_index * 15
         end_min = (cluster_start_index + 1) * 15
@@ -537,7 +538,7 @@ class ScheduleGenerator
           duration = weighted_random(prng, sink_duration_probs) + 1
           if start_min + duration > end_min then duration = (end_min - start_min) end
           sink_activity_sch.fill(sink_flow_rate, (day * 1440) + start_min, duration)
-          start_min += duration + sink_between_event_gap # Two minutes gap between sink activity
+          start_min += duration + sink_minutes_between_event_gap # Two minutes gap between sink activity
           if start_min >= end_min then break end
         end
       end
@@ -554,14 +555,14 @@ class ScheduleGenerator
     #   a. Determine the number of events in the shower cluster (there can be multiple showers)
     #   b. For each event, sample the shower duration
     #   c. Fill in the time period of personal hygiene using that many events of corresponding duration
-    #      separated by shower_between_event_gap.
+    #      separated by shower_minutes_between_event_gap.
     #      TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
     # 5. If it is bath
     #   a. Sample the bath duration
     #   b. Fill in the mkc personal hygiene slot with the bath duration and flow rate.
     #      TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
     # 6. Repeat process 2-6 for each occupant
-    shower_between_event_gap = schedule_config['shower']['between_event_gap']
+    shower_minutes_between_event_gap = schedule_config['shower']['minutes_between_event_gap']
     shower_flow_rate_mean = schedule_config['shower']['flow_rate_mean']
     shower_flow_rate_std = schedule_config['shower']['flow_rate_std']
     bath_ratio = schedule_config['bath']['bath_to_shower_ratio']
@@ -612,7 +613,7 @@ class ScheduleGenerator
                 m += 1
                 if (start_min + m) >= mins_in_year then break end
               end
-              shower_between_event_gap.times do
+              shower_minutes_between_event_gap.times do
                 # skip the gap between events
                 m += 1
                 if (start_min + m) >= mins_in_year then break end
@@ -633,10 +634,9 @@ class ScheduleGenerator
     #    (it's typically composed of multiple water draw events)
     # 4. For each event, sample the event duration
     # 5. Fill in the dishwasher/clothes washer time slot using those water draw events
-
     dw_flow_rate_mean = schedule_config['dishwasher']['flow_rate_mean']
     dw_flow_rate_std = schedule_config['dishwasher']['flow_rate_std']
-    dw_between_event_gap = schedule_config['dishwasher']['between_event_gap']
+    dw_minutes_between_event_gap = schedule_config['dishwasher']['minutes_between_event_gap']
     dw_activity_sch = [0] * mins_in_year
     m = 0
     dw_flow_rate = gaussian_rand(prng, dw_flow_rate_mean, dw_flow_rate_std, 0)
@@ -662,7 +662,7 @@ class ScheduleGenerator
           end
           if start_minute + m >= mins_in_year then break end
 
-          dw_between_event_gap.times do
+          dw_minutes_between_event_gap.times do
             m += 1
             if start_minute + m >= mins_in_year then break end
           end
@@ -675,7 +675,7 @@ class ScheduleGenerator
 
     cw_flow_rate_mean = schedule_config['clothes_washer']['flow_rate_mean']
     cw_flow_rate_std = schedule_config['clothes_washer']['flow_rate_std']
-    cw_between_event_gap = schedule_config['clothes_washer']['between_event_gap']
+    cw_minutes_between_event_gap = schedule_config['clothes_washer']['minutes_between_event_gap']
     cw_activity_sch = [0] * mins_in_year # this is the clothes_washer water draw schedule
     cw_load_size_probability = schedule_config['clothes_washer']['load_size_probability']
     m = 0
@@ -703,7 +703,7 @@ class ScheduleGenerator
             end
             if start_minute + m >= mins_in_year then break end
 
-            cw_between_event_gap.times do
+            cw_minutes_between_event_gap.times do
               # skip the gap between events
               m += 1
               if start_minute + m >= mins_in_year then break end
@@ -725,7 +725,7 @@ class ScheduleGenerator
     dw_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
-    start_time = Time.new(sim_year, 1, 1)
+    start_time = Time.new(@sim_year, 1, 1)
     while step < mkc_steps_in_a_year
       dish_state = sum_across_occupants(all_simulated_values, 4, step, max_clip = 1)
       step_jump = 1
@@ -749,7 +749,7 @@ class ScheduleGenerator
     cd_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
-    start_time = Time.new(sim_year, 1, 1)
+    start_time = Time.new(@sim_year, 1, 1)
     while step < mkc_steps_in_a_year
       clothes_state = sum_across_occupants(all_simulated_values, 2, step, max_clip = 1)
       step_jump = 1
@@ -777,7 +777,7 @@ class ScheduleGenerator
     cooking_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
-    start_time = Time.new(sim_year, 1, 1)
+    start_time = Time.new(@sim_year, 1, 1)
     while step < mkc_steps_in_a_year
       cooking_state = sum_across_occupants(all_simulated_values, 3, step, max_clip = 1)
       step_jump = 1
@@ -885,16 +885,17 @@ class ScheduleGenerator
     new_array_size = array.size / group_size
     new_array = [0] * new_array_size
     new_array_size.times do |j|
-      new_array[j] = array[(j * group_size)...(j + 1) * group_size].reduce(0, :+)
+      new_array[j] = array[(j * group_size)...(j + 1) * group_size].sum(0)
     end
     return new_array
   end
 
   def apply_monthly_offsets(array:, weekday_monthly_shift_dict:, weekend_monthly_shift_dict:)
+    month_strs = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'July', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+    new_array = []
     @total_days_in_year.times do |day|
       today = @sim_start_day + day
       day_of_week = today.wday
-      month_strs = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'July', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
       month = month_strs[today.month - 1]
       if [0, 6].include?(day_of_week)
         # Weekend
@@ -907,9 +908,9 @@ class ScheduleGenerator
         raise "Could not find the entry for month #{month}, day #{day_of_week} and state #{@state}"
       end
 
-      array[day * 1440, 1440] = array[day * 1440, 1440].rotate(lead)
+      new_array.concat(array[day * 1440, 1440].rotate(lead))
     end
-    return array
+    return new_array
   end
 
   def read_monthly_shift_minutes(resources_path:, daytype:)

data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.json

@@ -0,0 +1,388 @@
+{
+  "occupancy_types": {
+    "probabilities": [
+      0.381,
+      0.297,
+      0.165,
+      0.157
+    ]
+  },
+  "plugload": {
+    "weekday_sch": [
+      0.035,
+      0.033,
+      0.032,
+      0.031,
+      0.032,
+      0.033,
+      0.037,
+      0.042,
+      0.043,
+      0.043,
+      0.043,
+      0.044,
+      0.045,
+      0.045,
+      0.044,
+      0.046,
+      0.048,
+      0.052,
+      0.053,
+      0.05,
+      0.047,
+      0.045,
+      0.04,
+      0.036
+    ],
+    "weekend_sch": [
+      0.035,
+      0.033,
+      0.032,
+      0.031,
+      0.032,
+      0.033,
+      0.037,
+      0.042,
+      0.043,
+      0.043,
+      0.043,
+      0.044,
+      0.045,
+      0.045,
+      0.044,
+      0.046,
+      0.048,
+      0.052,
+      0.053,
+      0.05,
+      0.047,
+      0.045,
+      0.04,
+      0.036
+    ],
+    "monthly_multiplier": [
+      1.248,
+      1.257,
+      0.993,
+      0.989,
+      0.993,
+      0.827,
+      0.821,
+      0.821,
+      0.827,
+      0.99,
+      0.987,
+      1.248
+    ]
+  },
+  "lighting": {
+    "weekday_sch": [
+      0.04,
+      0.037,
+      0.037,
+      0.036,
+      0.033,
+      0.036,
+      0.043,
+      0.047,
+      0.034,
+      0.023,
+      0.024,
+      0.025,
+      0.024,
+      0.028,
+      0.031,
+      0.032,
+      0.039,
+      0.053,
+      0.063,
+      0.067,
+      0.071,
+      0.069,
+      0.059,
+      0.05
+    ],
+    "weekend_sch": [
+      0.04,
+      0.037,
+      0.037,
+      0.036,
+      0.033,
+      0.036,
+      0.043,
+      0.047,
+      0.034,
+      0.023,
+      0.024,
+      0.025,
+      0.024,
+      0.028,
+      0.031,
+      0.032,
+      0.039,
+      0.053,
+      0.063,
+      0.067,
+      0.071,
+      0.069,
+      0.059,
+      0.05
+    ],
+    "monthly_multiplier": [
+      1.248,
+      1.257,
+      0.993,
+      0.989,
+      0.993,
+      0.827,
+      0.821,
+      0.821,
+      0.827,
+      0.99,
+      0.987,
+      1.248
+    ],
+    "holiday_sch": [
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.0,
+      0.008168,
+      0.098016,
+      0.168028,
+      0.193699,
+      0.283547,
+      0.192532,
+      0.03734,
+      0.01867
+    ]
+  },
+  "ceiling_fan": {
+    "weekday_sch": [
+      0.04,
+      0.037,
+      0.037,
+      0.036,
+      0.033,
+      0.036,
+      0.043,
+      0.047,
+      0.034,
+      0.023,
+      0.024,
+      0.025,
+      0.024,
+      0.028,
+      0.031,
+      0.032,
+      0.039,
+      0.053,
+      0.063,
+      0.067,
+      0.071,
+      0.069,
+      0.059,
+      0.05
+    ],
+    "weekend_sch": [
+      0.04,
+      0.037,
+      0.037,
+      0.036,
+      0.033,
+      0.036,
+      0.043,
+      0.047,
+      0.034,
+      0.023,
+      0.024,
+      0.025,
+      0.024,
+      0.028,
+      0.031,
+      0.032,
+      0.039,
+      0.053,
+      0.063,
+      0.067,
+      0.071,
+      0.069,
+      0.059,
+      0.05
+    ],
+    "monthly_multiplier": [
+      1.248,
+      1.257,
+      0.993,
+      0.989,
+      0.993,
+      0.827,
+      0.821,
+      0.821,
+      0.827,
+      0.99,
+      0.987,
+      1.248
+    ]
+  },
+  "cooking": {
+    "monthly_multiplier": [
+      1.038,
+      1.026,
+      0.976,
+      0.945,
+      0.965,
+      0.947,
+      0.939,
+      0.965,
+      0.967,
+      1.006,
+      1.098,
+      1.129
+    ]
+  },
+  "clothes_dryer": {
+    "monthly_multiplier": [
+      1.09,
+      1.054,
+      1.044,
+      0.996,
+      0.992,
+      0.967,
+      0.931,
+      0.906,
+      0.923,
+      0.955,
+      1.035,
+      1.108
+    ]
+  },
+  "sink": {
+    "duration_probability": [
+      0.901242,
+      0.076572,
+      0.01722,
+      0.003798,
+      0.000944,
+      0.000154,
+      4.6e-05,
+      2.2e-05,
+      2.0e-06
+    ],
+    "events_per_cluster_probs": [
+      0.62458,
+      0.18693,
+      0.08011,
+      0.0433,
+      0.02178,
+      0.01504,
+      0.0083,
+      0.00467,
+      0.0057,
+      0.00285,
+      0.00181,
+      0.00233,
+      0.0013,
+      0.00104,
+      0.00026
+    ],
+    "hourly_onset_prob": [
+      0.007,
+      0.018,
+      0.042,
+      0.062,
+      0.066,
+      0.062,
+      0.054,
+      0.05,
+      0.049,
+      0.045,
+      0.041,
+      0.043,
+      0.048,
+      0.065,
+      0.075,
+      0.069,
+      0.057,
+      0.048,
+      0.04,
+      0.027,
+      0.014,
+      0.007,
+      0.005,
+      0.005
+    ],
+    "avg_sink_clusters_per_hh": 6657,
+    "minutes_between_event_gap": 2,
+    "flow_rate_mean": 1.14,
+    "flow_rate_std": 0.61
+  },
+  "shower": {
+    "minutes_between_event_gap": 30,
+    "flow_rate_mean": 2.25,
+    "flow_rate_std": 0.68
+  },
+  "bath": {
+    "bath_to_shower_ratio": 0.078843,
+    "duration_mean": 5.65,
+    "duration_std": 2.09,
+    "flow_rate_mean": 4.4,
+    "flow_rate_std": 1.17
+  },
+  "dishwasher": {
+    "flow_rate_mean": 1.39,
+    "flow_rate_std": 0.2,
+    "minutes_between_event_gap": 10,
+    "monthly_multiplier": [
+      1.083,
+      1.056,
+      1.023,
+      0.999,
+      0.975,
+      0.944,
+      0.918,
+      0.928,
+      0.938,
+      0.984,
+      1.059,
+      1.094
+    ]
+  },
+  "clothes_washer": {
+    "flow_rate_mean": 2.2,
+    "flow_rate_std": 0.62,
+    "minutes_between_event_gap": 4,
+    "load_size_probability": [
+      0.682926829,
+      0.227642276,
+      0.056910569,
+      0.032520325
+    ],
+    "monthly_multiplier": [
+      0.968,
+      1.013,
+      0.99,
+      1.034,
+      1.019,
+      1.015,
+      1.048,
+      1,
+      1.021,
+      0.949,
+      0.945,
+      0.999
+    ]
+  }
+}

data/example_files/resources/hpxml-measures/BuildResidentialHPXML/resources/schedules_config.md

@@ -0,0 +1,43 @@
+### Occupancy Types
+
+Occupancy cluster types: Mostly Home, Early Regular Worker, Mostly Away, Regular Worker.
+Probabilities are derived from ATUS using the k-modes algorithm.
+
+### Plug Loads
+
+This is the baseline schedule for plugload, lighting and ceiling fan.
+It will be modified based on occupancy.
+
+### Lighting
+
+The exterior and garage lighting makes use of the weekday/weekend schedule.
+Indoor lighting schedule is generated on the fly. 
+Holiday lighting makes use of the holiday_sch.
+
+### Cooking
+
+Monthly energy use multipliers for cooking stove/oven/range from average of multiple end-use submetering datasets (HEMS, RBSAM, ELCAP, Mass Res 1, Pecan St.).
+Power draw distribution is based on csv files.
+
+### Clothes Dryer
+
+Monthly energy use multipliers for clothes dryer from average of multiple end-use submetering datasets (HEMS, RBSAM, ELCAP, Mass Res 1, Pecan St., FSEC).
+Power draw distribution is based on csv files.
+
+### Clothes Washer
+
+Monthly energy use multipliers for clothes washer and dishwasher from average of multiple end-use submetering datasets (generally HEMS, RBSAM, ELCAP, Mass Res 1, and Pecan St.).
+Power draw distribution is based on csv files.
+
+### Dishwasher
+
+Monthly energy use multipliers for clothes washer and dishwasher from average of multiple end-use submetering datasets (generally HEMS, RBSAM, ELCAP, Mass Res 1, Pecan St., and FSEC).
+Power draw distribution is based on csv files.
+
+### Water Draw Events
+
+Probabilities for all water draw events are extracted from DHW event generators.
+The onset, duration, events_per_cluster_probs, flow rate mean and std could all refer to the DHW event generator excel sheet ('event characteristics' and 'Start Times' sheet).
+
+#### sink
+avg_sink_clusters_per_hh -> Average sink cluster per house hold. Set to 6657 for U.S. average of 2.53 occupants per household, based on relationship of 6885 clusters for 25 gpd, from Building America DHW Event Schedule Generator,