Residential: connect to ResStock

.gitignore

@@ -34,3 +34,5 @@ runner.conf
 .coveralls.yml
 
 example_project/measures/BuildResidentialModel/tests/run
+example_project/measures/BuildResidentialModel/tests/samples/precomputed
+example_project/resources/residential-measures/weather

Gemfile

@@ -103,13 +103,13 @@ else
   gem 'urbanopt-reporting', '~> 0.9.1'
 end
 
-if allow_local && File.exist?('../urbanopt-geojson-gem')
-  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
-elsif allow_local
-  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
-else
-  gem 'urbanopt-geojson', '~> 0.11.1'
-end
+#if allow_local && File.exist?('../urbanopt-geojson-gem')
+#  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+#elsif allow_local
+  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'uo-resstock_connection'
+#else
+#  gem 'urbanopt-geojson', '~> 0.11.1'
+#end
 
 if allow_local && File.exist?('../urbanopt-reopt-gem')
   gem 'urbanopt-reopt', path: '../urbanopt-reopt-gem'

Rakefile

@@ -759,12 +759,31 @@ desc 'Run residential tasks'
 namespace :residential do
   desc 'Update residential resources'
   task :update_resources do
-    prefix = 'example_project/resources/hpxml-measures'
-    repository = 'https://github.com/NREL/OpenStudio-HPXML.git'
-    branch_or_tag = 'v1.7.0' # update this when pulling in updated OS-HPXML
+    prefix = 'example_project/resources/residential-measures'
+    repository = 'https://github.com/NREL/resstock.git'
+    branch_or_tag = 'v3.2.0' # update this when pulling in updated ResStock
 
     FileUtils.rm_rf(prefix)
     system("git clone --depth 1 --branch #{branch_or_tag} #{repository} #{prefix}")
+
+    folders_to_remove = [
+      '.git',
+      '.github',
+      '.gitignore',
+      'docs',
+      'project_testing',
+      'resources/data',
+      'test/base_results/baseline/timeseries',
+      'test/base_results/upgrades',
+      'test/SetSpaceInfiltrationPerExteriorArea',
+      'test/tests_buildstock_csvs',
+      'test/tests_housing_characteristics',
+      'test/tests_yml_files'
+    ]
+
+    folders_to_remove.each do |f|
+      FileUtils.rm_rf(File.join(prefix, f))
+    end
   end
 
   desc 'Run residential measure tests'

example_project/Gemfile

@@ -81,13 +81,13 @@ else
   gem 'openstudio-geb', '~> 0.4.0'
 end
 
-if allow_local && File.exists?('../urbanopt-geojson-gem')
-  gem 'urbanopt-geojson', path: '../../urbanopt-geojson-gem'
-elsif allow_local
-  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
-else
-  gem 'urbanopt-geojson', '~> 0.11.1'
-end
+#if allow_local && File.exists?('../urbanopt-geojson-gem')
+#  gem 'urbanopt-geojson', path: '../../urbanopt-geojson-gem'
+#elsif allow_local
+  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'uo-resstock_connection'
+#else
+#  gem 'urbanopt-geojson', '~> 0.11.1'
+#end
 
 # NEVER put SCENARIO-GEM in this file...it will make all simulations fail due to the sqlite dependency
 # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'

example_project/example_project_combined.json

@@ -652,7 +652,7 @@
         "onsite_parking_fraction": 1,
         "template": "Residential IECC 2015 - Customizable Template Sep 2020",
         "geometry_unit_orientation": 90.0,
-        "geometry_unit_aspect_ratio" : 1.0
+        "geometry_unit_aspect_ratio": 1.0
       },
       "geometry": {
         "type": "Polygon",
@@ -699,7 +699,9 @@
         "roof_type": "Hip",
         "system_type": "Residential - boiler and room air conditioner",
         "heating_system_fuel_type": "propane",
-        "template": "Residential IECC 2015 - Customizable Template Sep 2020"
+        "year_built": 1986,
+        "characterize_residential_buildings_from_buildstock_csv": true,
+        "uo_buildstock_mapping_csv_path": "resources/uo_buildstock_mapping.csv"
       },
       "geometry": {
         "type": "Polygon",
@@ -833,17 +835,18 @@
         "name": "Residential 5",
         "type": "Building",
         "building_type": "Multifamily",
-        "floor_area": 28636,
-        "footprint_area": 14318,
+        "floor_area": 10000,
+        "footprint_area": 5000,
         "number_of_stories_above_ground": 2,
         "number_of_stories": 2,
         "number_of_bedrooms": 16,
         "foundation_type": "slab",
         "attic_type": "flat roof",
-        "system_type": "Residential - furnace and room air conditioner",
-        "heating_system_fuel_type": "wood",
+        "system_type": "Residential - furnace and central air conditioner",
+        "heating_system_fuel_type": "electricity",
         "number_of_residential_units": 8,
-        "template": "Residential IECC 2015 - Customizable Template Sep 2020"
+        "characterize_residential_buildings_from_buildstock_csv": true,
+        "resstock_buildstock_csv_path": "resources/residential-measures/test/base_results/baseline/annual/buildstock.csv"
       },
       "geometry": {
         "type": "Polygon",

example_project/mappers/Baseline.rb

@@ -37,7 +37,7 @@ def initialize
 
             # add any paths local to the project
             @@osw[:measure_paths] << File.join(File.dirname(__FILE__), '../measures/')
-            @@osw[:measure_paths] << File.join(File.dirname(__FILE__), '../resources/hpxml-measures')
+            @@osw[:measure_paths] << File.join(File.dirname(__FILE__), '../resources/residential-measures/resources/hpxml-measures')
             @@osw[:file_paths] << File.join(File.dirname(__FILE__), '../weather/')
 
             # configures OSW with extension gem paths for measures and files, all extension gems must be
@@ -264,7 +264,7 @@ def commercial_building_types
       def get_climate_zone_iecc(epw)
         headers = CSV.open(epw, 'r', &:first)
         wmo = headers[5]
-        zones_csv = Pathname(__FILE__).dirname.parent / 'resources' / 'hpxml-measures' / 'HPXMLtoOpenStudio' / 'resources' / 'data' / 'climate_zones.csv'
+        zones_csv = Pathname(__FILE__).dirname.parent / 'resources' / 'residential-measures' / 'resources' / 'hpxml-measures' / 'HPXMLtoOpenStudio' / 'resources' / 'data' / 'climate_zones.csv'
 
         # Check if the CSV file is empty
         if File.empty?(epw)
@@ -549,12 +549,13 @@ def create_osw(scenario, features, feature_names)
             end
 
             # Start general residential mapping
+            # mappers/residential/util.rb
             args = {}
             require File.join(File.dirname(__FILE__), 'residential/util')
             residential(scenario, feature, args, building_type)
 
             # Then onto optional "template" mapping
-            # mappers/residential/template
+            # mappers/residential/template/util.rb
             template = nil
             begin
               template = feature.template
@@ -566,9 +567,60 @@ def create_osw(scenario, features, feature_names)
               residential_template(args, template, climate_zone)
             end
 
-            # Parse BuildResidentialModel measure xml so we can override defaults
+            # Then onto optional "samples" mapping
+            # mappers/residential/samples/util.rb
+            uo_resstock_connection = false
+            begin
+              uo_resstock_connection = feature.characterize_residential_buildings_from_buildstock_csv
+            rescue StandardError
+            end
+
+            # Run workflows if UO-ResStock connection is established
+            if uo_resstock_connection
+
+              buildstock_csv_path = nil
+              begin
+                csv_path = feature.resstock_buildstock_csv_path
+                buildstock_csv_path = File.absolute_path(File.join(File.dirname(__FILE__), '..', csv_path))
+              rescue StandardError
+                @@logger.error("\n resstock_buildstock_csv_path was not assigned by the user.")
+              end
+
+              uo_buildstock_mapping_csv_path = nil
+              begin
+                mapping_csv_path = feature.uo_buildstock_mapping_csv_path
+                uo_buildstock_mapping_csv_path = File.absolute_path(File.join(File.dirname(__FILE__), '..', mapping_csv_path))
+              rescue StandardError
+                @@logger.error("\n uo_buildstock_mapping_csv_path was not assigned by the user")
+              end
+
+              require File.join(File.dirname(__FILE__), 'residential/samples/util')
+              if !buildstock_csv_path.nil? # If resstock_buildstock_csv_path is provided
+                @@logger.info("Processing with BuildStock CSV path.")
+
+                start_time = Time.now # To document the time of finding the resstock building id
+                resstock_building_id = find_resstock_building_id(buildstock_csv_path, feature, building_type, @@logger)
+                puts "Processing time for finding a building match (resstock_building_id = #{resstock_building_id}) from the buildstock CSV: #{Time.now - start_time} seconds."
+
+                residential_samples(args, resstock_building_id, buildstock_csv_path)
+
+              elsif !uo_buildstock_mapping_csv_path.nil? # If uo_buildstock_mapping_csv_path is provided
+                @@logger.info("Processing with UO-BuildStock mapping CSV path.")
+
+                start_time = Time.now # To document the time of getting the resstock building id
+                resstock_building_id = find_building_for_uo_id(uo_buildstock_mapping_csv_path, feature.id)
+                puts "Processing time for finding the building match (resstock_building_id = #{resstock_building_id}) from the buildstock CSV: #{Time.now - start_time} seconds."
+
+                residential_samples(args, resstock_building_id, uo_buildstock_mapping_csv_path) # uo_buildstock_mapping_csv_path may contain a subset of all parameters
+
+              else
+                @@logger.error("The user did not specify either the uo_buildstock_mapping_csv_path or the resstock_buildstock_csv_path. At least one of these is required for UO - ResStock connection.")
+              end
+            end
+
+            # Parse BuildResidentialHPXML measure xml so we can fill "args" in with default values where keys aren't already assigned
             default_args = {}
-            measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../resources/hpxml-measures'))
+            measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../resources/residential-measures/resources/hpxml-measures'))
             measure_xml = File.read(File.join(measures_dir, 'BuildResidentialHPXML', 'measure.xml'))
             measure = REXML::Document.new(measure_xml).root
             measure.elements.each('arguments/argument') do |arg|
@@ -581,7 +633,7 @@ def create_osw(scenario, features, feature_names)
               end
             end
 
-            build_res_model_args = [:feature_id, :schedules_type, :schedules_random_seed, :schedules_variation, :geometry_num_floors_above_grade, :hpxml_dir, :output_dir]
+            build_res_model_args = [:urbanopt_feature_id, :resstock_buildstock_csv_path, :resstock_building_id, :schedules_type, :schedules_random_seed, :schedules_variation, :geometry_num_floors_above_grade, :hpxml_dir, :output_dir]
             args.each_key do |arg_name|
               unless default_args.key?(arg_name)
                 next if build_res_model_args.include?(arg_name)