urbanopt-cli 0.10.0 → 0.11.1

data/example_files/mappers/base_workflow.osw

@@ -6,6 +6,11 @@
   "run_directory": null,
   "steps": [
     {
+      "measure_dir_name": "BuildResidentialModel",
+      "arguments": {
+        "__SKIP__": true
+      }
+    },{
       "measure_dir_name": "set_run_period",
       "arguments": {
         "__SKIP__": true,
@@ -205,17 +210,19 @@
         "size_mult": "0.75",
         "charge_start": "23:00"
       }
-    },{
+    },
+    {
       "measure_dir_name":"export_time_series_modelica",
       "arguments":{
-        "__SKIP__":false
+        "__SKIP__": true
       }
     },{
       "measure_dir_name":"export_modelica_loads",
       "arguments":{
-        "__SKIP__":false
+        "__SKIP__": true
       }
-    },{
+    },
+    {
       "measure_dir_name": "envelope_and_internal_load_breakdown",
       "arguments": {
         "__SKIP__": true

data/example_files/mappers/residential/template/util.rb

@@ -0,0 +1,138 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
+# *********************************************************************************
+
+
+def residential_template(args, template, climate_zone)
+  '''Assign arguments from tsv files.'''
+
+  # IECC / EnergyStar / Other
+  if template.include?('Residential IECC')
+
+    captures = template.match(/Residential IECC (?<iecc_year>\d+) - Customizable Template (?<t_month>\w+) (?<t_year>\d+)/)
+    template_vals = Hash[captures.names.zip(captures.captures)]
+    template_vals = template_vals.transform_keys(&:to_sym)
+    template_vals[:climate_zone] = climate_zone
+
+    # ENCLOSURE
+
+    enclosure_filepath = File.join(File.dirname(__FILE__), 'iecc/enclosure.tsv')
+    enclosure = get_lookup_tsv(args, enclosure_filepath)
+    row = get_lookup_row(args, enclosure, template_vals)
+
+    # Determine which surfaces to place insulation on
+    if args[:geometry_foundation_type].include? 'Basement'
+      row[:foundation_wall_assembly_r] = row[:foundation_wall_assembly_r_basement]
+      row[:floor_over_foundation_assembly_r] = 2.1
+      row[:floor_over_garage_assembly_r] = 2.1
+    elsif args[:geometry_foundation_type].include? 'Crawlspace'
+      row[:foundation_wall_assembly_r] = row[:foundation_wall_assembly_r_crawlspace]
+      row[:floor_over_foundation_assembly_r] = 2.1
+      row[:floor_over_garage_assembly_r] = 2.1
+    end
+    row.delete(:foundation_wall_assembly_r_basement)
+    row.delete(:foundation_wall_assembly_r_crawlspace)
+    if ['ConditionedAttic'].include?(args[:geometry_attic_type])
+      row[:roof_assembly_r] = row[:ceiling_assembly_r]
+      row[:ceiling_assembly_r] = 2.1
+    end
+    args.update(row) unless row.nil?
+
+    # HVAC
+
+    { args[:heating_system_type] => 'iecc/heating_system.tsv',
+      args[:cooling_system_type] => 'iecc/cooling_system.tsv',
+      args[:heat_pump_type] => 'iecc/heat_pump.tsv' }.each do |type, path|
+
+      if type != 'none'
+        filepath = File.join(File.dirname(__FILE__), path)
+        lookup_tsv = get_lookup_tsv(args, filepath)
+        row = get_lookup_row(args, lookup_tsv, template_vals)
+        args.update(row) unless row.nil?
+      end
+    end
+
+    # APPLIANCES / MECHANICAL VENTILATION / WATER HEATER
+
+    ['refrigerator', 'clothes_washer', 'dishwasher', 'clothes_dryer', 'mechanical_ventilation', 'water_heater'].each do |appliance|
+      filepath = File.join(File.dirname(__FILE__), "iecc/#{appliance}.tsv")
+      lookup_tsv = get_lookup_tsv(args, filepath)
+      row = get_lookup_row(args, lookup_tsv, template_vals)
+      args.update(row) unless row.nil?
+    end
+  end
+end
+
+def get_lookup_tsv(args, filepath)
+  rows = []
+  headers = []
+  units = []
+  CSV.foreach(filepath, { col_sep: "\t" }) do |row|
+    if headers.empty?
+      row.each do |header|
+        next if header == 'Source'
+
+        if args.key?(header.gsub('Dependency=', '').to_sym)
+          header = header.gsub('Dependency=', '')
+        end
+        unless header.include?('Dependency=')
+          header = header.to_sym
+        end
+        headers << header
+      end
+      next
+    elsif units.empty?
+      row.each do |unit|
+        units << unit
+      end
+      next
+    end
+    if headers.length != row.length
+      row = row[0..-2] # leave out Source column
+    end
+    rows << headers.zip(row).to_h
+  end
+  return rows
+end
+
+def get_lookup_row(args, rows, template_vals)
+  rows.each do |row|
+    if row.key?('Dependency=Climate Zone') && (row['Dependency=Climate Zone'] != template_vals[:climate_zone])
+      next
+    end
+    if row.key?('Dependency=IECC Year') && (row['Dependency=IECC Year'] != template_vals[:iecc_year])
+      next
+    end
+    if row.key?('Dependency=Template Month') && (row['Dependency=Template Month'] != template_vals[:t_month])
+      next
+    end
+    if row.key?('Dependency=Template Year') && (row['Dependency=Template Year'] != template_vals[:t_year])
+      next
+    end
+
+    row.delete('Dependency=Climate Zone')
+    row.delete('Dependency=IECC Year')
+    row.delete('Dependency=Template Month')
+    row.delete('Dependency=Template Year')
+
+    row.each do |k, v|
+      next unless v.nil?
+
+      row.delete(k)
+    end
+
+    intersection = args.keys & row.keys
+    return row if intersection.empty? # found the correct row
+
+    skip = false
+    intersection.each do |k|
+      if args[k] != row[k]
+        skip = true
+      end
+    end
+
+    return row unless skip
+  end
+  return nil
+end

data/example_files/mappers/residential/util.rb

@@ -0,0 +1,276 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
+# *********************************************************************************
+
+
+def residential(scenario, feature, args, building_type)
+  '''Assign arguments from geojson file.'''
+
+  # Schedules
+  feature_ids = []
+  scenario.feature_file.features.each do |f|
+    feature_ids << f.id
+  end
+
+  # BuildResidentialModel arguments
+  args[:hpxml_path] = '../feature.xml'
+  args[:output_dir] = '..'
+  args[:feature_id] = feature.id
+  args[:schedules_type] = 'stochastic' # smooth or stochastic
+  args[:schedules_random_seed] = feature_ids.index(feature.id)
+  args[:schedules_variation] = 'unit' # building or unit
+  args[:geometry_num_floors_above_grade] = feature.number_of_stories_above_ground
+
+  # Optionals
+  number_of_residential_units = 1
+  begin
+    number_of_residential_units = feature.number_of_residential_units
+  rescue StandardError
+  end
+  args[:geometry_building_num_units] = number_of_residential_units
+
+  begin
+    args[:hpxml_dir] = feature.hpxml_directory
+    return
+  rescue StandardError
+  end
+
+  timestep = 60
+  begin
+    timestep = 60 / feature.timesteps_per_hour
+  rescue StandardError
+  end
+
+  run_period = 'Jan 1 - Dec 31'
+  calendar_year = 2007
+  begin
+    abbr_monthnames = Date::ABBR_MONTHNAMES
+    begin_month = abbr_monthnames[feature.begin_date[5, 2].to_i]
+    begin_day_of_month = feature.begin_date[8, 2].to_i
+    end_month = abbr_monthnames[feature.end_date[5, 2].to_i]
+    end_day_of_month = feature.end_date[8, 2].to_i
+    run_period = "#{begin_month} #{begin_day_of_month} - #{end_month} #{end_day_of_month}"
+    calendar_year = feature.begin_date[0, 4].to_i
+  rescue StandardError
+  end
+
+  occupancy_calculation_type = nil
+  begin
+    occupancy_calculation_type = feature.occupancy_calculation_type
+  rescue StandardError
+  end
+
+  number_of_occupants = nil
+  begin
+    number_of_occupants = feature.number_of_occupants
+  rescue StandardError
+  end
+
+  maximum_roof_height = 8.0
+  begin
+    maximum_roof_height = feature.maximum_roof_height
+  rescue StandardError
+  end
+
+  roof_type = 'Gable'
+  begin
+    roof_type = feature.roof_type
+  rescue StandardError
+  end
+
+  geometry_unit_orientation = nil
+  begin
+    geometry_unit_orientation = feature.geometry_unit_orientation
+  rescue StandardError
+  end
+
+  geometry_unit_aspect_ratio = nil
+  begin
+    geometry_unit_aspect_ratio = feature.geometry_unit_aspect_ratio
+  rescue StandardError
+  end
+
+  onsite_parking_fraction = false
+  begin
+    onsite_parking_fraction = feature.onsite_parking_fraction
+  rescue StandardError
+  end
+
+  # Apply residential
+  residential_simulation(args, timestep, run_period, calendar_year, feature.weather_filename)
+  residential_geometry_unit(args, building_type, feature.floor_area, feature.number_of_bedrooms, geometry_unit_orientation, geometry_unit_aspect_ratio, occupancy_calculation_type, number_of_occupants, maximum_roof_height)
+  residential_geometry_foundation(args, feature.foundation_type)
+  residential_geometry_attic(args, feature.attic_type, roof_type)
+  residential_geometry_garage(args, onsite_parking_fraction)
+  residential_geometry_neighbor(args)
+  residential_hvac(args, feature.system_type, feature.heating_system_fuel_type)
+  residential_appliances(args)
+end
+
+def residential_simulation(args, timestep, run_period, calendar_year, weather_filename)
+  args[:simulation_control_timestep] = timestep
+  args[:simulation_control_run_period] = run_period
+  args[:simulation_control_run_period_calendar_year] = calendar_year
+  args[:weather_station_epw_filepath] = "../../../weather/#{weather_filename}"
+end
+
+def residential_geometry_unit(args, building_type, floor_area, number_of_bedrooms, geometry_unit_orientation, geometry_unit_aspect_ratio, occupancy_calculation_type, number_of_occupants, maximum_roof_height)
+  number_of_stories_above_ground = args[:geometry_num_floors_above_grade]
+  args[:geometry_unit_num_floors_above_grade] = 1
+  case building_type
+  when 'Single-Family Detached'
+    args[:geometry_building_num_units] = 1
+    args[:geometry_unit_type] = 'single-family detached'
+    args[:geometry_unit_num_floors_above_grade] = number_of_stories_above_ground
+  when 'Single-Family Attached'
+    args[:geometry_unit_type] = 'single-family attached'
+    args[:geometry_unit_num_floors_above_grade] = number_of_stories_above_ground
+    args[:air_leakage_type] = 'unit exterior only'
+  when 'Multifamily'
+    args[:geometry_unit_type] = 'apartment unit'
+    args[:air_leakage_type] = 'unit exterior only'
+  end
+
+  args[:geometry_unit_cfa] = floor_area / args[:geometry_building_num_units]
+
+  args[:geometry_unit_num_bedrooms] = number_of_bedrooms / args[:geometry_building_num_units]
+
+  # Geometry Orientation and Aspect Ratio
+  # Orientation (North=0, East=90, South=180, West=270)
+  args[:geometry_unit_orientation] = geometry_unit_orientation if !geometry_unit_orientation.nil?
+
+  # Aspect Ratio
+  # The ratio of front/back wall length to left/right wall length for the unit, excluding any protruding garage wall area.
+  args[:geometry_unit_aspect_ratio] = geometry_unit_aspect_ratio if !geometry_unit_aspect_ratio.nil?
+
+  # Occupancy Calculation Type
+  if occupancy_calculation_type == 'operational'
+    # set args[:geometry_unit_num_occupants]
+    begin
+      args[:geometry_unit_num_occupants] = number_of_occupants / args[:geometry_building_num_units]
+    rescue StandardError # number_of_occupants is not defined: assume equal to number of bedrooms
+      args[:geometry_unit_num_occupants] = args[:geometry_unit_num_bedrooms]
+    end
+  else # nil or asset
+    # do not set args[:geometry_unit_num_occupants]
+  end
+
+  args[:geometry_average_ceiling_height] = maximum_roof_height / number_of_stories_above_ground
+end
+
+def residential_geometry_foundation(args, foundation_type)
+  args[:geometry_foundation_type] = 'SlabOnGrade'
+  args[:geometry_foundation_height] = 0.0
+  case foundation_type
+  when 'crawlspace - vented'
+    args[:geometry_foundation_type] = 'VentedCrawlspace'
+    args[:geometry_foundation_height] = 3.0
+  when 'crawlspace - unvented'
+    args[:geometry_foundation_type] = 'UnventedCrawlspace'
+    args[:geometry_foundation_height] = 3.0
+  when 'crawlspace - conditioned'
+    args[:geometry_foundation_type] = 'ConditionedCrawlspace'
+    args[:geometry_foundation_height] = 3.0
+  when 'basement - unconditioned'
+    args[:geometry_foundation_type] = 'UnconditionedBasement'
+    args[:geometry_foundation_height] = 8.0
+  when 'basement - conditioned'
+    args[:geometry_foundation_type] = 'ConditionedBasement'
+    args[:geometry_foundation_height] = 8.0
+  when 'ambient'
+    args[:geometry_foundation_type] = 'Ambient'
+    args[:geometry_foundation_height] = 8.0
+  end
+end
+
+def residential_geometry_attic(args, attic_type, roof_type)
+  begin
+    case attic_type
+    when 'attic - vented'
+      args[:geometry_attic_type] = 'VentedAttic'
+    when 'attic - unvented'
+      args[:geometry_attic_type] = 'UnventedAttic'
+    when 'attic - conditioned'
+      args[:geometry_attic_type] = 'ConditionedAttic'
+    when 'flat roof'
+      args[:geometry_attic_type] = 'FlatRoof'
+    end
+  rescue StandardError
+  end
+
+  case roof_type
+  when 'Gable'
+    args[:geometry_roof_type] = 'gable'
+  when 'Hip'
+    args[:geometry_roof_type] = 'hip'
+  end
+end
+
+def residential_geometry_garage(args, onsite_parking_fraction)
+  num_garage_spaces = 0
+  if onsite_parking_fraction
+    num_garage_spaces = 1
+    if args[:geometry_unit_cfa] > 2500.0
+      num_garage_spaces = 2
+    end
+  end
+  args[:geometry_garage_width] = 12.0 * num_garage_spaces
+  args[:geometry_garage_protrusion] = 1.0
+end
+
+def residential_geometry_neighbor(args)
+  args[:neighbor_left_distance] = 0.0
+  args[:neighbor_right_distance] = 0.0
+end
+
+def residential_hvac(args, system_type, heating_system_fuel_type)
+  system_type = 'Residential - furnace and central air conditioner'
+  begin
+    system_type = system_type
+  rescue StandardError
+  end
+
+  args[:heating_system_type] = 'none'
+  if system_type.include?('electric resistance')
+    args[:heating_system_type] = 'ElectricResistance'
+  elsif system_type.include?('furnace')
+    args[:heating_system_type] = 'Furnace'
+  elsif system_type.include?('boiler')
+    args[:heating_system_type] = 'Boiler'
+  end
+
+  args[:cooling_system_type] = 'none'
+  if system_type.include?('central air conditioner')
+    args[:cooling_system_type] = 'central air conditioner'
+  elsif system_type.include?('room air conditioner')
+    args[:cooling_system_type] = 'room air conditioner'
+  elsif system_type.include?('evaporative cooler')
+    args[:cooling_system_type] = 'evaporative cooler'
+  end
+
+  args[:heat_pump_type] = 'none'
+  if system_type.include?('air-to-air')
+    args[:heat_pump_type] = 'air-to-air'
+  elsif system_type.include?('mini-split')
+    args[:heat_pump_type] = 'mini-split'
+  elsif system_type.include?('ground-to-air')
+    args[:heat_pump_type] = 'ground-to-air'
+  end
+
+  args[:heating_system_fuel] = 'natural gas'
+  begin
+    args[:heating_system_fuel] = heating_system_fuel_type
+  rescue StandardError
+  end
+
+  if args[:heating_system_type] == 'ElectricResistance'
+    args[:heating_system_fuel] = 'electricity'
+  end
+end
+
+def residential_appliances(args)
+  args[:cooking_range_oven_fuel_type] = args[:heating_system_fuel]
+  args[:clothes_dryer_fuel_type] = args[:heating_system_fuel]
+  args[:water_heater_fuel_type] = args[:heating_system_fuel]
+end