urbanopt-cli 0.4.1 → 0.5.0

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

@@ -36,7 +36,6 @@ class Geometry
                                          geometry_attic_type:,
                                          geometry_roof_type:,
                                          geometry_roof_pitch:,
-                                         geometry_roof_structure:,
                                          **remainder)
     cfa = geometry_cfa
     wall_height = geometry_wall_height
@@ -51,7 +50,6 @@ class Geometry
     attic_type = geometry_attic_type
     roof_type = geometry_roof_type
     roof_pitch = geometry_roof_pitch
-    roof_structure = geometry_roof_structure
 
     # error checking
     if model.getSpaces.size > 0
@@ -886,39 +884,51 @@ class Geometry
       end
     end
 
+    # Initialize
     surface_window_area = {}
     target_facade_areas = {}
     facades.each do |facade|
-      # Initialize
+      target_facade_areas[facade] = 0.0
       wall_surfaces[facade].each do |surface|
         surface_window_area[surface] = 0
       end
+    end
 
+    facades.each do |facade|
       # Calculate target window area for this facade
-      target_facade_areas[facade] = 0.0
       if wwrs[facade] > 0
         wall_area = 0
         wall_surfaces[facade].each do |surface|
           wall_area += UnitConversions.convert(surface.grossArea, 'm^2', 'ft^2')
         end
-        target_facade_areas[facade] = wall_area * wwrs[facade]
+        target_facade_areas[facade] += wall_area * wwrs[facade]
       else
-        target_facade_areas[facade] = window_areas[facade]
+        target_facade_areas[facade] += window_areas[facade]
       end
 
       next if target_facade_areas[facade] == 0
 
       if target_facade_areas[facade] < min_single_window_area
         # If the total window area for the facade is less than the minimum window area,
-        # set all of the window area to the surface with the greatest available wall area
-        surface = my_hash.max_by { |k, v| v }[0]
-        surface_window_area[surface] = target_facade_areas[facade]
+        # set all of the window area to the surface with the greatest available wall area on any facade
+        surface = surface_avail_area.max_by { |k, v| v }[0]
+        next if Geometry.get_facade_for_surface(surface) == facade
+        next if surface_avail_area[surface] == facade_avail_area[facade]
+
+        surface_window_area[surface] += target_facade_areas[facade]
+
+        new_facade = Geometry.get_facade_for_surface(surface)
+        area_moved = target_facade_areas[facade]
+        target_facade_areas[facade] = 0
+        target_facade_areas[new_facade] = surface_window_area[surface]
+
+        runner.registerWarning("The #{facade} facade window area (#{area_moved.round(2)} ft2) is less than the minimum window area allowed (#{min_single_window_area.round(2)} ft2), and has been added to the #{new_facade} facade.")
         next
       end
 
       # Initial guess for wall of this facade
       wall_surfaces[facade].each do |surface|
-        surface_window_area[surface] = surface_avail_area[surface] / facade_avail_area[facade] * target_facade_areas[facade]
+        surface_window_area[surface] += surface_avail_area[surface] / facade_avail_area[facade] * target_facade_areas[facade]
       end
 
       # If window area for a surface is less than the minimum window area,
@@ -954,6 +964,7 @@ class Geometry
         sum_window_area += surface_window_area[surface]
       end
       next if sum_window_area == 0
+      next if target_facade_areas[facade] < sum_window_area # for cases where window area was added from different facade
 
       wall_surfaces[facade].each do |surface|
         surface_window_area[surface] += surface_window_area[surface] / sum_window_area * (target_facade_areas[facade] - sum_window_area)
@@ -1979,7 +1990,6 @@ class Geometry
     end
 
     num_units_per_floor = num_units / num_floors
-    num_units_per_floor_actual = num_units_per_floor
 
     if (num_floors > 1) && (level != 'Bottom') && (foundation_height != 0.0)
       runner.registerWarning('Unit is not on the bottom floor, setting foundation height to 0.')
@@ -2558,17 +2568,6 @@ class Geometry
     return yValueArray
   end
 
-  # Return an array of z values for surfaces passed in. The values will be relative to the parent origin. This was intended for spaces.
-  def self.getSurfaceZValues(surfaceArray)
-    zValueArray = []
-    surfaceArray.each do |surface|
-      surface.vertices.each do |vertex|
-        zValueArray << UnitConversions.convert(vertex.z, 'm', 'ft')
-      end
-    end
-    return zValueArray
-  end
-
   def self.get_surface_length(surface)
     xvalues = getSurfaceXValues([surface])
     yvalues = getSurfaceYValues([surface])

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

@@ -8,12 +8,13 @@ class ScheduleGenerator
   def initialize(runner:,
                  model:,
                  epw_file:,
-                 building_id: nil)
-
+                 building_id: nil,
+                 random_seed: nil)
     @runner = runner
     @model = model
     @epw_file = epw_file
     @building_id = building_id
+    @random_seed = random_seed
   end
 
   def get_simulation_parameters
@@ -21,6 +22,7 @@ class ScheduleGenerator
     if @model.getSimulationControl.timestep.is_initialized
       @minutes_per_step = 60 / @model.getSimulationControl.timestep.get.numberOfTimestepsPerHour
     end
+
     @steps_in_day = 24 * 60 / @minutes_per_step
 
     @mkc_ts_per_day = 96
@@ -29,20 +31,15 @@ class ScheduleGenerator
     @model.getYearDescription.isLeapYear ? @total_days_in_year = 366 : @total_days_in_year = 365
   end
 
-  def get_building_id
-    if @building_id.nil?
-      building_id = @model.getBuilding.additionalProperties.getFeatureAsInteger('Building ID') # this becomes the seed
-      if building_id.is_initialized
-        building_id = building_id.get
-      else
-        @runner.registerWarning('Unable to retrieve the Building ID (seed for schedule generator); setting it to 1.')
-        building_id = 1
-      end
+  def get_random_seed
+    if @random_seed.nil?
+      @runner.registerInfo('Unable to retrieve the schedules random seed; setting it to 1.')
+      seed = 1
     else
-      building_id = @building_id
+      @runner.registerInfo("Retrieved the schedules random seed; setting it to #{@random_seed}.")
+      seed = @random_seed
     end
-
-    return building_id
+    return seed
   end
 
   def self.col_names
@@ -352,11 +349,8 @@ class ScheduleGenerator
   end
 
   def create_stochastic_schedules(args:)
-    # get building_id if this is called by, e.g., BuildExistingModel
-    building_id = get_building_id
-
-    # initialize a random number generator using building_id
-    prng = Random.new(building_id)
+    # initialize a random number generator
+    prng = Random.new(get_random_seed)
 
     # load the schedule configuration file
     schedule_config = YAML.load_file(args[:resources_path] + '/schedules_config.yml')
@@ -729,12 +723,17 @@ class ScheduleGenerator
     dw_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
+    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
       if (dish_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive dishwasher power without gap
         duration_15min, avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'dishwasher')
-        duration = [duration_15min * 15, mins_in_year - step * 15].min
+
+        month = (start_time + step * 15 * 60).month
+        duration_min = (duration_15min * 15 * schedule_config['dishwasher']['monthly_multiplier'][month - 1]).to_i
+
+        duration = [duration_min, mins_in_year - step * 15].min
         dw_power_sch.fill(avg_power, step * 15, duration)
         step_jump = duration_15min
       end
@@ -748,16 +747,22 @@ class ScheduleGenerator
     cd_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
+    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
       if (clothes_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive washer power without gap
         cw_duration_15min, cw_avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'clothes_washer')
         cd_duration_15min, cd_avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'clothes_dryer')
-        cw_duration = [cw_duration_15min * 15, mins_in_year - step * 15].min
+
+        month = (start_time + step * 15 * 60).month
+        cd_duration_min = (cd_duration_15min * 15 * schedule_config['clothes_dryer']['monthly_multiplier'][month - 1]).to_i
+        cw_duration_min = (cw_duration_15min * 15 * schedule_config['clothes_washer']['monthly_multiplier'][month - 1]).to_i
+
+        cw_duration = [cw_duration_min, mins_in_year - step * 15].min
         cw_power_sch.fill(cw_avg_power, step * 15, cw_duration)
         cd_start_time = (step * 15 + cw_duration).to_i # clothes dryer starts immediately after washer ends\
-        cd_duration = [cd_duration_15min * 15, mins_in_year - cd_start_time].min # cd_duration would be negative if cd_start_time > mins_in_year, and no filling would occur
+        cd_duration = [cd_duration_min, mins_in_year - cd_start_time].min # cd_duration would be negative if cd_start_time > mins_in_year, and no filling would occur
         cd_power_sch = cd_power_sch.fill(cd_avg_power, cd_start_time, cd_duration)
         step_jump = cw_duration_15min + cd_duration_15min
       end
@@ -770,18 +775,22 @@ class ScheduleGenerator
     cooking_power_sch = [0] * mins_in_year
     step = 0
     last_state = 0
+    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
       if (cooking_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive cooking power without gap
         duration_15min, avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'cooking')
-        duration = [duration_15min * 15, mins_in_year - step * 15].min
+        month = (start_time + step * 15 * 60).month
+        duration_min = (duration_15min * 15 * schedule_config['cooking']['monthly_multiplier'][month - 1]).to_i
+        duration = [duration_min, mins_in_year - step * 15].min
         cooking_power_sch.fill(avg_power, step * 15, duration)
         step_jump = duration_15min
       end
       last_state = cooking_state
       step += step_jump
     end
+
     offset_range = 30
     random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
     sink_activity_sch = sink_activity_sch.rotate(-4 * 60 + random_offset) # 4 am shifting
@@ -900,7 +909,8 @@ class ScheduleGenerator
       @duration_row[appliance_name] = (prng.rand * duration_vals.size).to_i
     end
     power = consumption_vals[@consumption_row[appliance_name]]
-    duration = duration_vals[@duration_row[appliance_name]].sample
+    sample = prng.rand(0..(duration_vals[@duration_row[appliance_name]].length - 1))
+    duration = duration_vals[@duration_row[appliance_name]][sample]
     return [duration, power]
   end
 

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

@@ -21,11 +21,22 @@ 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]
+
+# 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.)
+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]
+
+# Monthly energy use multipliers for clothes dryer from average of multiple end-use submetering datasets (HEMS, RBSAM, ELCAP, Mass Res 1, Pecan St., FSEC)
+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]
+
+
 ###
 
 # probabilities below 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) 
 # Water Draw Probability Distribution
+# 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 [dishwasher only])
 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.04330, 0.02178, 0.01504, 0.00830, 0.00467, 0.00570, 0.00285, 0.00181, 0.00233, 0.00130, 0.00104, 0.00026]
@@ -51,11 +62,13 @@ dishwasher:
   flow_rate_mean: 1.39
   flow_rate_std: 0.2
   between_event_gap: 10  # in integer minutes (0.16 * 60)
+  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
   between_event_gap: 4  # integer minutes (0.08 * 60).to_i
   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]
 
-# power draw distribution for dishwasher, clothes_washer and clothes_dryer and cooking is based on csv files
+# power draw distribution for dishwasher, clothes_washer and clothes_dryer and cooking is based on csv files

data/example_files/resources/hpxml-measures/BuildResidentialHPXML/tests/base-appliances-coal.osw

@@ -57,7 +57,8 @@
         "dehumidifier_fraction_dehumidification_load_served": 1,
         "dehumidifier_present": false,
         "dehumidifier_rh_setpoint": 0.5,
-        "dhw_distribution_pipe_r": 0.0,
+        "dehumidifier_type": "portable",
+        "dhw_distribution_pipe_r": "0.0",
         "dhw_distribution_recirc_branch_piping_length": "50",
         "dhw_distribution_recirc_control_type": "no control",
         "dhw_distribution_recirc_piping_length": "50",
@@ -99,25 +100,25 @@
         "foundation_wall_insulation_distance_to_bottom": 8.0,
         "foundation_wall_insulation_distance_to_top": 0.0,
         "foundation_wall_insulation_r": 8.9,
+        "foundation_wall_thickness": "8.0",
         "freezer_location": "auto",
         "freezer_present": false,
         "freezer_rated_annual_kwh": "auto",
         "freezer_usage_multiplier": 1.0,
         "fuel_loads_fireplace_annual_therm": "auto",
+        "fuel_loads_fireplace_frac_latent": "auto",
+        "fuel_loads_fireplace_frac_sensible": "auto",
         "fuel_loads_fireplace_fuel_type": "natural gas",
-        "fuel_loads_fireplace_location": "auto",
         "fuel_loads_fireplace_present": false,
-        "fuel_loads_fireplace_usage_multiplier": 1.0,
+        "fuel_loads_fireplace_usage_multiplier": 0.0,
         "fuel_loads_grill_annual_therm": "auto",
         "fuel_loads_grill_fuel_type": "natural gas",
-        "fuel_loads_grill_location": "auto",
         "fuel_loads_grill_present": false,
-        "fuel_loads_grill_usage_multiplier": 1.0,
+        "fuel_loads_grill_usage_multiplier": 0.0,
         "fuel_loads_lighting_annual_therm": "auto",
         "fuel_loads_lighting_fuel_type": "natural gas",
-        "fuel_loads_lighting_location": "auto",
         "fuel_loads_lighting_present": false,
-        "fuel_loads_lighting_usage_multiplier": 1.0,
+        "fuel_loads_lighting_usage_multiplier": 0.0,
         "geometry_aspect_ratio": 1.5,
         "geometry_attic_type": "UnventedAttic",
         "geometry_balcony_depth": 0.0,
@@ -141,7 +142,6 @@
         "geometry_num_occupants": "3",
         "geometry_orientation": 180.0,
         "geometry_roof_pitch": "6:12",
-        "geometry_roof_structure": "truss, cantilever",
         "geometry_roof_type": "gable",
         "geometry_unit_type": "single-family detached",
         "geometry_wall_height": 8.0,
@@ -160,8 +160,6 @@
         "heat_pump_heating_efficiency_cop": 3.6,
         "heat_pump_heating_efficiency_hspf": 7.7,
         "heat_pump_type": "none",
-        "heating_system_electric_auxiliary_energy": 0,
-        "heating_system_electric_auxiliary_energy_2": 0,
         "heating_system_fraction_heat_load_served": 1,
         "heating_system_fraction_heat_load_served_2": 0.25,
         "heating_system_fuel": "natural gas",
@@ -209,7 +207,7 @@
         "mech_vent_flow_rate_2": 110,
         "mech_vent_hours_in_operation": 24,
         "mech_vent_hours_in_operation_2": 24,
-        "mech_vent_is_shared_system": false,
+        "mech_vent_num_units_served": 1,
         "mech_vent_sensible_recovery_efficiency": 0.72,
         "mech_vent_sensible_recovery_efficiency_2": 0.72,
         "mech_vent_sensible_recovery_efficiency_type": "Unadjusted",
@@ -238,14 +236,18 @@
         "plug_loads_other_frac_latent": "0.045",
         "plug_loads_other_frac_sensible": "0.855",
         "plug_loads_other_usage_multiplier": 1.0,
+        "plug_loads_other_usage_multiplier_2": 1.0,
         "plug_loads_television_annual_kwh": "620.0",
         "plug_loads_television_usage_multiplier": 1.0,
+        "plug_loads_television_usage_multiplier_2": 1.0,
         "plug_loads_vehicle_annual_kwh": "auto",
         "plug_loads_vehicle_present": false,
-        "plug_loads_vehicle_usage_multiplier": 1.0,
+        "plug_loads_vehicle_usage_multiplier": 0.0,
+        "plug_loads_vehicle_usage_multiplier_2": 0.0,
         "plug_loads_well_pump_annual_kwh": "auto",
         "plug_loads_well_pump_present": false,
-        "plug_loads_well_pump_usage_multiplier": 1.0,
+        "plug_loads_well_pump_usage_multiplier": 0.0,
+        "plug_loads_well_pump_usage_multiplier_2": 0.0,
         "pool_heater_annual_kwh": "auto",
         "pool_heater_annual_therm": "auto",
         "pool_heater_type": "electric resistance",
@@ -259,38 +261,34 @@
         "pv_system_array_tilt_2": "20",
         "pv_system_inverter_efficiency_1": 0.96,
         "pv_system_inverter_efficiency_2": 0.96,
-        "pv_system_is_shared_1": false,
-        "pv_system_is_shared_2": false,
-        "pv_system_location_1": "roof",
-        "pv_system_location_2": "roof",
+        "pv_system_location_1": "auto",
+        "pv_system_location_2": "auto",
         "pv_system_max_power_output_1": 4000,
         "pv_system_max_power_output_2": 4000,
         "pv_system_module_type_1": "none",
         "pv_system_module_type_2": "none",
+        "pv_system_num_units_served_1": 1,
+        "pv_system_num_units_served_2": 1,
         "pv_system_system_losses_fraction_1": 0.14,
         "pv_system_system_losses_fraction_2": 0.14,
-        "pv_system_tracking_1": "fixed",
-        "pv_system_tracking_2": "fixed",
+        "pv_system_tracking_1": "auto",
+        "pv_system_tracking_2": "auto",
         "refrigerator_location": "living space",
         "refrigerator_present": true,
         "refrigerator_rated_annual_kwh": "650.0",
         "refrigerator_usage_multiplier": 1.0,
         "roof_assembly_r": 2.3,
         "roof_color": "auto",
-        "roof_emittance": 0.92,
+        "roof_emittance": "0.92",
         "roof_material_type": "asphalt or fiberglass shingles",
-        "roof_radiant_barrier": false,
+        "roof_radiant_barrier": "false",
         "roof_radiant_barrier_grade": "1",
         "roof_solar_absorptance": "auto",
         "schedules_type": "default",
-        "setpoint_cooling_setup_hours_per_week": 0,
-        "setpoint_cooling_setup_start_hour": 0,
-        "setpoint_cooling_setup_temp": 78,
-        "setpoint_cooling_temp": 78,
-        "setpoint_heating_setback_hours_per_week": 0,
-        "setpoint_heating_setback_start_hour": 0,
-        "setpoint_heating_setback_temp": 68,
-        "setpoint_heating_temp": 68,
+        "setpoint_cooling_weekday_temp": 78,
+        "setpoint_cooling_weekend_temp": 78,
+        "setpoint_heating_weekday_temp": 68,
+        "setpoint_heating_weekend_temp": 68,
         "simulation_control_timestep": "60",
         "site_type": "suburban",
         "skylight_area_back": 0,
@@ -299,10 +297,11 @@
         "skylight_area_right": 0,
         "skylight_shgc": 0.45,
         "skylight_ufactor": 0.33,
-        "slab_carpet_fraction": 0.0,
-        "slab_carpet_r": 0.0,
+        "slab_carpet_fraction": "0.0",
+        "slab_carpet_r": "0.0",
         "slab_perimeter_depth": 0,
         "slab_perimeter_insulation_r": 0,
+        "slab_thickness": "4.0",
         "slab_under_insulation_r": 0,
         "slab_under_width": 0,
         "solar_thermal_collector_area": 40.0,
@@ -317,22 +316,21 @@
         "solar_thermal_system_type": "none",
         "wall_assembly_r": 23,
         "wall_color": "auto",
-        "wall_emittance": 0.92,
+        "wall_emittance": "0.92",
         "wall_siding_type": "wood siding",
         "wall_solar_absorptance": "auto",
         "wall_type": "WoodStud",
         "water_fixtures_shower_low_flow": true,
         "water_fixtures_sink_low_flow": false,
         "water_fixtures_usage_multiplier": 1.0,
-        "water_heater_efficiency_ef": 0.95,
+        "water_heater_efficiency": 0.95,
         "water_heater_efficiency_type": "EnergyFactor",
-        "water_heater_efficiency_uef": 0.93,
         "water_heater_fuel_type": "electricity",
         "water_heater_has_flue_or_chimney": false,
         "water_heater_heating_capacity": "18767",
-        "water_heater_is_shared_system": false,
         "water_heater_jacket_rvalue": 0,
         "water_heater_location": "living space",
+        "water_heater_num_units_served": 1,
         "water_heater_recovery_efficiency": "0.76",
         "water_heater_setpoint_temperature": "125",
         "water_heater_standby_loss": 0,