Merge pull request #154 from urbanopt/OS-3.4.0

Changes for 0.8.0 release / OS 3.4.0
urbanopt · May 14, 2022 · 9ece0cc · 9ece0cc
2 parents 0f0fbc6 + e510be0
commit 9ece0cc
Show file tree

Hide file tree

Showing 422 changed files with 76,908 additions and 877 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # URBANopt Example GeoJSON Project
 
+## Version 0.8.0
+
+Date Range: 05/01/21 - 05/09/22:
+
+* Update copyrights for 2021
+* Ensure mappers are consistent with URBANopt CLI and add better error handling to baseline mapper
+* Utilize ASHRAE 90.1 Laboratory prototype model
+* Add new example PV feature file to example files folder
+* Update example project to make use of commercial hours of operation customization
+* Skip detailed model creation workflow if create bar workflow selected and detailed osm present
+* Default the GCR (ground coverage ratio) for PV to 1 in all example assumptions files
+* Add support for custom user HPXML files in example project
+* update feature-file for electrical projects
+
 ## Version 0.7.0
 
 * Updated dependencies to work with OpenStudio 3.3

diff --git a/Gemfile b/Gemfile
@@ -22,56 +22,83 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop'
 # end
 
-gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
-gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
-gem 'openstudio-ee', github: 'NREL/openstudio-ee-gem', branch: 'develop'
-gem 'openstudio-calibration', github: 'NREL/openstudio-calibration-gem', branch: 'develop'
+if allow_local && File.exist?('../openstudio-common-measures-gem')
+  gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
+elsif allow_local
+  gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
+else
+  gem 'openstudio-common-measures', '~> 0.6.0'
+end
 
-# if allow_local && File.exist?('../urbanopt-core-gem')
-#   gem 'urbanopt-core', path: '../urbanopt-core-gem'
-# elsif allow_local
-#   gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
-# end
+if allow_local && File.exist?('../openstudio-model-articulation-gem')
+  gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
+elsif allow_local
+  gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
+else
+  gem 'openstudio-model-articulation', '~> 0.6.1'
+end
 
-if allow_local && File.exist?('../urbanopt-scenario-gem')
-  gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
+if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
+  gem 'openstudio-load-flexibility-measures', path: '../openstudio-load-flexibility-measures-gem'
 elsif allow_local
-  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
+  gem 'openstudio-load-flexibility-measures', github: 'NREL/openstudio-load-flexibility-measures-gem', branch: 'master'
 else
-  gem 'urbanopt-scenario', '~> 0.7.0'
+  gem 'openstudio-load-flexibility-measures', '~> 0.5.0'
 end
 
-if allow_local && File.exist?('../urbanopt-reporting-gem')
-  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+if allow_local && File.exist?('../openstudio-ee-gem')
+  gem 'openstudio-ee', path: '../opesntudio-ee-gem'
 elsif allow_local
-  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+  gem 'openstudio-ee', github: 'NREL/openstudio-ee-gem', branch: 'develop'
 else
-  gem 'urbanopt-reporting', '~> 0.5.0'
+  gem 'openstudio-ee', '~> 0.6.0'
 end
 
+if allow_local && File.exist?('../openstudio-calibration-gem')
+  gem 'openstudio-calibration', path: '../openstudio-calibration-gem'
+elsif allow_local
+  gem 'openstudio-calibration', github: 'NREL/openstudio-calibration-gem', branch: 'develop'
+else
+  gem 'openstudio-calibration', '~> 0.6.0'
+end
+
+# if allow_local && File.exist?('../urbanopt-core-gem')
+#   gem 'urbanopt-core', path: '../urbanopt-core-gem'
+# elsif allow_local
+#   gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
+# end
+
+# if allow_local && File.exist?('../urbanopt-scenario-gem')
+#   gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
+# elsif allow_local
+  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'OS-3.4.0'
+# else
+#   gem 'urbanopt-scenario', '~> 0.7.0'
+# end
+
+# if allow_local && File.exist?('../urbanopt-reporting-gem')
+#   gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+# elsif allow_local
+  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'OS-3.4.0'
+# else
+#   gem 'urbanopt-reporting', '~> 0.5.0'
+# end
 
 # TODO: Uncomment and revert changes once gem is released
 # 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'
+gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'OS-3.4.0'
 # else
 #  gem 'urbanopt-geojson', '~> 0.7.0'
 # end
 
+# if allow_local && File.exist?('../urbanopt-reopt-gem')
+#   gem 'urbanopt-reopt', path: '../urbanopt-reopt-gem'
+# elsif allow_local
+  gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'OS-3.4.0'
+# else
+#   gem 'urbanopt-reopt', '0.7.0'
+# end
 
-if allow_local && File.exist?('../urbanopt-reopt-gem')
-  gem 'urbanopt-reopt', path: '../urbanopt-reopt-gem'
-elsif allow_local
-  gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'develop'
-else
-  gem 'urbanopt-reopt', '0.7.0'
-end
 
-if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
-  gem 'openstudio-load-flexibility-measures', path: '../openstudio-load-flexibility-measures-gem'
-elsif allow_local
-  gem 'openstudio-load-flexibility-measures', github: 'NREL/openstudio-load-flexibility-measures-gem', branch: 'master'
-else
-  gem 'openstudio-load-flexibility-measures', '0.4.0'
-end
diff --git a/example_project/Gemfile b/example_project/Gemfile
@@ -26,64 +26,63 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # end
 #
 
-# TODO : Uncomment to revert changes once branch is merged
-# if allow_local && File.exist?('../openstudio-common-measures-gem')
-#  gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
-# elsif allow_local
-gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
-# else
-#  gem 'openstudio-common-measures', '~> 0.5.0'
-# end
+if allow_local && File.exist?('../openstudio-common-measures-gem')
+  gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
+elsif allow_local
+  gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
+else
+  gem 'openstudio-common-measures', '~> 0.6.0'
+end
 
 if allow_local && File.exist?('../openstudio-model-articulation-gem')
   gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
 elsif allow_local
   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
 else
-  gem 'openstudio-model-articulation', '~> 0.5.0'
+  gem 'openstudio-model-articulation', '~> 0.6.1'
 end
 
 if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
   gem 'openstudio-load-flexibility-measures', path: '../openstudio-load-flexibility-measures-gem'
 elsif allow_local
   gem 'openstudio-load-flexibility-measures', github: 'NREL/openstudio-load-flexibility-measures-gem', branch: 'master'
 else
-  gem 'openstudio-load-flexibility-measures', '~> 0.4.0'
+  gem 'openstudio-load-flexibility-measures', '~> 0.5.0'
 end
 
 if allow_local && File.exist?('../openstudio-ee-gem')
   gem 'openstudio-ee', path: '../openstudio-ee-gem'
 elsif allow_local
   gem 'openstudio-ee', github: 'NREL/openstudio-ee-gem', branch: 'develop'
 else
-  gem 'openstudio-ee', '~> 0.5.0'
+  gem 'openstudio-ee', '~> 0.6.0'
 end
 
 if allow_local && File.exist?('../openstudio-calibration-gem')
   gem 'openstudio-calibration', path: '../openstudio-calibration-gem'
 elsif allow_local
   gem 'openstudio-calibration', github: 'NREL/openstudio-calibration-gem', branch: 'develop'
 else
-  gem 'openstudio-calibration', '~> 0.5.0'
+  gem 'openstudio-calibration', '~> 0.6.0'
 end
 
 
 # TODO : Uncomment to revert changes once gem is released
 # 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'
+gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'OS-3.4.0'
 # else
 #  gem 'urbanopt-geojson', '~> 0.7.0'
 # 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'
 
-if allow_local && File.exist?('../urbanopt-reporting-gem')
-  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
-elsif allow_local
-  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
-else
-  gem 'urbanopt-reporting', '~> 0.5.0'
-end
+# if allow_local && File.exist?('../urbanopt-reporting-gem')
+#   gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+# elsif allow_local
+  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'OS-3.4.0'
+# else
+#   gem 'urbanopt-reporting', '~> 0.5.0'
+# end
diff --git a/example_project/example_project_combined.json b/example_project/example_project_combined.json
@@ -108,7 +108,12 @@
         "building_type": "Food service",
         "floor_area": 22313,
         "footprint_area": 22313,
-        "number_of_stories": 1
+        "number_of_stories": 1,
+        "ev_charging": true,
+        "ev_charging_behavior": "Business as Usual",
+        "ev_percent": 100,
+        "ev_curtailment_frac": 0.5,
+        "ev_use_model_occupancy": true
       },
       "geometry": {
         "type": "Polygon",
@@ -151,7 +156,13 @@
         "weekday_start_time": "11:00",
         "weekday_duration": "11:30",
         "weekend_start_time": "11:00",
-        "weekend_duration": "11:30"
+        "weekend_duration": "11:30",
+		    "emissions" : true,
+		    "emissions_future_year": "2020",
+		    "emissions_hourly_historical_year": "2019",
+		    "emissions_annual_historical_year": "2019",
+        "ev_charging": true,
+        "ev_charging_station_type": "Typical Public"
       },
       "geometry": {
         "type": "Polygon",
@@ -194,7 +205,9 @@
         "weekday_start_time": "06:00",
         "weekday_duration": "07:00",
         "weekend_start_time": "08:00",
-        "weekend_duration": "05:00"
+        "weekend_duration": "05:00",
+        "ev_charging": true,
+        "ev_charging_station_type": "Typical Public"
       },
       "geometry": {
         "type": "Polygon",
@@ -235,7 +248,10 @@
         "footprint_area": 8804,
         "number_of_stories": 1,
         "weekday_start_time": "06:00",
-        "weekday_duration": "16:00"
+        "weekday_duration": "16:00",
+		    "emissions" : false,
+        "ev_charging": true,
+        "ev_charging_station_type": "Typical Work"
       },
       "geometry": {
         "type": "Polygon",
@@ -274,7 +290,8 @@
         "building_type": "Food service",
         "floor_area": 10689,
         "footprint_area": 10689,
-        "number_of_stories": 1
+        "number_of_stories": 1,
+        "ev_charging": true
       },
       "geometry": {
         "type": "Polygon",
@@ -312,7 +329,14 @@
         "type": "Building",
         "building_type": "Office",
         "number_of_stories": 6,
-        "detailed_model_filename": "7.osm"
+        "detailed_model_filename": "7.osm",
+		    "emissions" : true,
+		    "emissions_future_subregion": "RMPAc",
+        "emissions_hourly_historical_subregion": "Rocky Mountains",
+        "emissions_annual_historical_subregion": "RMPA",
+    		"emissions_future_year": "2020",
+    		"emissions_hourly_historical_year": "2019",
+    		"emissions_annual_historical_year": "2019"
       },
       "geometry": {
         "type": "Polygon",
@@ -631,7 +655,14 @@
         "system_type": "Residential - furnace and central air conditioner",
         "heating_system_fuel_type": "natural gas",
         "onsite_parking_fraction": 1,
-        "template": "Residential IECC 2015 - Customizable Template Sep 2020"
+        "template": "Residential IECC 2015 - Customizable Template Sep 2020",
+		"emissions" : true,
+		"emissions_future_subregion": "RMPAc",
+        "emissions_hourly_historical_subregion": "Rocky Mountains",
+        "emissions_annual_historical_subregion": "RMPA",
+		"emissions_future_year": "2020",
+		"emissions_hourly_historical_year": "2019",
+		"emissions_annual_historical_year": "2019"
       },
       "geometry": {
         "type": "Polygon",
@@ -712,7 +743,7 @@
       "type": "Feature",
       "properties": {
         "id": "16",
-        "name": "Residenital 3",
+        "name": "Residential 3",
         "type": "Building",
         "building_type": "Single-Family Detached",
         "floor_area": 5500,
@@ -771,6 +802,7 @@
         "name": "Residential 4",
         "type": "Building",
         "building_type": "Single-Family Attached",
+        "number_of_stories": 2,
         "number_of_stories_above_ground": 2,
         "foundation_type": "slab",
         "hpxml_directory": "17"