Merge branch 'develop'

.gitignore

@@ -27,3 +27,6 @@ spec/test_directory_*
 
 Gemfile.lock
 .rubocop*
+
+# python dependencies
+example_files/python_deps

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 0.8.1
+Date Range: 05/14/22 - 06/28/22:
+
+- Fixed [#343]( https://github.com/urbanopt/urbanopt-cli/issues/343 ), Carbon Emission Reporting
+- Fixed [#329]( https://github.com/urbanopt/urbanopt-cli/issues/329 ), Better error messages for missing modelica files
+- Fixed [#349]( https://github.com/urbanopt/urbanopt-cli/issues/349 ), num_parallel bug
+
 ## Version 0.8.0
 
 Date Range: 12/22/21 - 05/13/22:

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.10.2)
 cmake_policy(SET CMP0048 NEW)
 
-project(URBANoptCLI VERSION 0.7.1)
+project(URBANoptCLI VERSION 0.8.0)
 
 include(FindOpenStudioSDK.cmake)
 
@@ -89,16 +89,16 @@ option(BUILD_PACKAGE "Build package" OFF)
 # need to  update the MD5sum for each platform and url below
 if(UNIX)
    if(APPLE)
-     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-darwin.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9c09ef89a66acff72377fa052542f0df")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-darwin.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9dea01c3a9664818a15ad34a5d37a155")
    else()
-     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-linux.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "6094f724a143023c19ab28b65d26094d")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-linux.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "84678cac20979c63913c8e4f99f30e0e")
    endif()
 elseif(WIN32)
   if(CMAKE_CL_64)
-    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-windows.tar.gz")
-    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "e1e0b44997dfd188996ef3bc5aa31388")
+    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-windows.tar.gz")
+    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "e31a7f7c12bde79046e18f9d2a23f105")
   endif()
 endif()
 

FindOpenStudioSDK.cmake

@@ -1,5 +1,5 @@
 set(OPENSTUDIO_VERSION_MAJOR 3)
-set(OPENSTUDIO_VERSION_MINOR 3)
+set(OPENSTUDIO_VERSION_MINOR 4)
 set(OPENSTUDIO_VERSION_PATCH 0)
 set(OPENSTUDIO_VERSION "${OPENSTUDIO_VERSION_MAJOR}.${OPENSTUDIO_VERSION_MINOR}.${OPENSTUDIO_VERSION_PATCH}")
 
@@ -16,23 +16,23 @@ else()
   set(OPENSTUDIO_BASELINK "https://openstudio-builds.s3.amazonaws.com/${OPENSTUDIO_VERSION}"
     CACHE STRING "Base link to where the openstudio archives are hosted" FORCE)
 
-  set(OPENSTUDIO_VERSION_SHA "+ad235ff36e")
+  set(OPENSTUDIO_VERSION_SHA "+4bd816f785")
 
   if(APPLE)
-    set(OPENSTUDIO_EXPECTED_HASH 77c2bf77f07dc2e2af7658df55940c49)
+    set(OPENSTUDIO_EXPECTED_HASH 5a1e5fdfc61a879a9d72dcf625a83e65)
     set(OPENSTUDIO_PLATFORM "Darwin")
     set(OPENSTUDIO_EXT "tar.gz")
   elseif(UNIX)
     if(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
-      set(OPENSTUDIO_EXPECTED_HASH 7fca6ef73399fdb21cde01aca4223d7c)
+      set(OPENSTUDIO_EXPECTED_HASH 1922de95bb3e196f1c719400ce58871c)
       set(OPENSTUDIO_PLATFORM "Ubuntu-20.04")
     else() # Assumes 18.04
-      set(OPENSTUDIO_EXPECTED_HASH 24858ac666a3d2fc40d0cff7b4f444b9)
+      set(OPENSTUDIO_EXPECTED_HASH 44a837fa96fe2ce1a883492a3a1cae09)
       set(OPENSTUDIO_PLATFORM "Ubuntu-18.04")
     endif()
     set(OPENSTUDIO_EXT "tar.gz")
   elseif(WIN32)
-    set(OPENSTUDIO_EXPECTED_HASH f01ddb50a7ce1f4461e1919350e7c629)
+    set(OPENSTUDIO_EXPECTED_HASH 9adffb37a62721ec51a33ce97533e956)
     set(OPENSTUDIO_PLATFORM "Windows")
     set(OPENSTUDIO_EXT "tar.gz")
   endif()

README.md

@@ -30,7 +30,7 @@ Below are installation instructions for each platform.
 
 ### Linux (Ubuntu 18.04)
 
-Download the .deb package. 
+Download the [.deb package](https://docs.urbanopt.net/installation/linux.html#install-with-the-urbanopt-installer). 
 
 ```terminal
 sudo apt update 
@@ -52,7 +52,7 @@ When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment
 
 ### Mac OSX (>= 10.12) 
 
-Download the .dmg package. 
+Download the [.dmg package](https://docs.urbanopt.net/installation/mac.html#install-with-the-urbanopt-installer). 
 
 Use the GUI installer and choose a directory to install. Once installed, open a terminal and run the provided setup script. 
 The `setup-env.sh` generates env variables and stores them in a file `.env_uo.sh` in your home directory. 
@@ -66,7 +66,7 @@ When launching new shell terminals run `. ~/.env_uo.s` to setup the environment.
 
 ### Windows (64-bit Windows 7 – 10)
 
-Download the .exe installer. 
+Download the [.exe installer](https://docs.urbanopt.net/installation/windows.html#install-with-the-urbanopt-installer). 
 
 Use the GUI installer and choose a directory to install. Once installed, open a terminal (Powershell, Windows CMD and GitBash are supported) and run the provided setup script for that shell (below are the setup scripts for each respective shell environment).
 

example_files/Gemfile

@@ -31,7 +31,7 @@ if allow_local && File.exist?('../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'
+  gem 'openstudio-common-measures', '~> 0.6.1'
 end
 
 if allow_local && File.exist?('../openstudio-model-articulation-gem')
@@ -67,22 +67,21 @@ else
 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'
+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.8.0'
+  gem 'urbanopt-geojson', '~> 0.8.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'
 
 if allow_local && File.exist?('../urbanopt-reporting-gem')
-  gem 'urbanopt-reporting', path: '../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.6.0'
+ gem 'urbanopt-reporting', '~> 0.6.1'
 end

example_files/example_project.json

@@ -13,7 +13,14 @@
     "surface_elevation": null,
     "tariff_filename": null,
     "timesteps_per_hour": 1,
-    "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw"
+    "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
+    "emissions": true,
+    "electricity_emissions_future_subregion": "NYSTc",
+    "electricity_emissions_hourly_historical_subregion": "New York",
+    "electricity_emissions_annual_historical_subregion": "NYCW",
+    "electricity_emissions_future_year": "2030",
+    "electricity_emissions_hourly_historical_year": "2019",
+    "electricity_emissions_annual_historical_year": "2019"
   },
   "scenarios": [
     {
@@ -164,10 +171,6 @@
         "floor_area": 125631,
         "footprint_area": 41877,
         "number_of_stories": 3,
-        "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"
       },
@@ -253,7 +256,6 @@
         "floor_area": 8804,
         "footprint_area": 8804,
         "number_of_stories": 1,
-        "emissions" : false,
         "ev_charging": true,
         "ev_charging_station_type": "Typical Work"
       },
@@ -337,14 +339,7 @@
         "building_type": "Office",
         "system_type": "VAV district chilled water with district hot water reheat",
         "number_of_stories": 6,
-        "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"
+        "detailed_model_filename": "7.osm"
       },
       "geometry": {
         "type": "Polygon",

example_files/example_project_combined.json

@@ -12,7 +12,14 @@
     "begin_date": "2017-01-01T07:00:00.000Z",
     "end_date": "2017-12-31T07:00:00.000Z",
     "timesteps_per_hour": 1,
-    "default_template": "90.1-2013"
+    "default_template": "90.1-2013",
+	  "emissions": true,
+    "electricity_emissions_future_subregion": "NYSTc",
+    "electricity_emissions_hourly_historical_subregion": "New York",
+    "electricity_emissions_annual_historical_subregion": "NYCW",
+    "electricity_emissions_future_year": "2030",
+    "electricity_emissions_hourly_historical_year": "2019",
+    "electricity_emissions_annual_historical_year": "2019"
   },
   "features": [
     {
@@ -157,10 +164,6 @@
         "weekday_duration": "11:30",
         "weekend_start_time": "11:00",
         "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"
       },
@@ -249,7 +252,6 @@
         "number_of_stories": 1,
         "weekday_start_time": "06:00",
         "weekday_duration": "16:00",
-		    "emissions" : false,
         "ev_charging": true,
         "ev_charging_station_type": "Typical Work"
       },
@@ -329,14 +331,7 @@
         "type": "Building",
         "building_type": "Office",
         "number_of_stories": 6,
-        "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"
+        "detailed_model_filename": "7.osm"
       },
       "geometry": {
         "type": "Polygon",
@@ -655,14 +650,7 @@
         "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",
-		"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"
+        "template": "Residential IECC 2015 - Customizable Template Sep 2020"
       },
       "geometry": {
         "type": "Polygon",

example_files/example_project_with_PV.json

@@ -13,7 +13,14 @@
       "end_date": "2017-12-31T07:00:00.000Z",
       "timesteps_per_hour": 1,
       "default_template": "90.1-2013",
-      "tariff_filename": null
+      "tariff_filename": null,
+      "emissions": true,
+      "electricity_emissions_future_subregion": "NYSTc",
+      "electricity_emissions_hourly_historical_subregion": "New York",
+      "electricity_emissions_annual_historical_subregion": "NYCW",
+      "electricity_emissions_future_year": "2030",
+      "electricity_emissions_hourly_historical_year": "2019",
+      "electricity_emissions_annual_historical_year": "2019"
     },
     "features": [
       {

example_files/example_project_with_electric_network.json

@@ -13,7 +13,14 @@
     "surface_elevation": null,
     "tariff_filename": null,
     "timesteps_per_hour": 1,
-    "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw"
+    "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
+    "emissions": true,
+    "electricity_emissions_future_subregion": "NYSTc",
+    "electricity_emissions_hourly_historical_subregion": "New York",
+    "electricity_emissions_annual_historical_subregion": "NYCW",
+    "electricity_emissions_future_year": "2030",
+    "electricity_emissions_hourly_historical_year": "2019",
+    "electricity_emissions_annual_historical_year": "2019"
   },
   "scenarios": [
     {

example_files/example_project_with_streets.json

@@ -13,9 +13,16 @@
     "end_date": "2017-12-31T07:00:00.000Z",
     "timesteps_per_hour": 1,
     "default_template": "90.1-2013",
-    "underground_cables_ratio": "0.9",
+    "underground_cables_ratio": 0.9,
     "only_lv_consumers": false,
-    "max_number_of_lv_nodes_per_building": 1
+    "max_number_of_lv_nodes_per_building": 1,
+    "emissions": true,
+    "electricity_emissions_future_subregion": "NYSTc",
+    "electricity_emissions_hourly_historical_subregion": "New York",
+    "electricity_emissions_annual_historical_subregion": "NYCW",
+    "electricity_emissions_future_year": "2030",
+    "electricity_emissions_hourly_historical_year": "2019",
+    "electricity_emissions_annual_historical_year": "2019"
   },
   "features": [
     {