RubyGems - urbanopt-cli - Versions diffs - 0.9.1 → 0.9.2 - Mend

urbanopt-cli 0.9.1 → 0.9.2

Files changed (16) hide show

checksums.yaml +4 -4
data/.github/workflows/nightly_build.yml +60 -0
data/CHANGELOG.md +6 -0
data/CMakeLists.txt +8 -8
data/FindOpenStudioSDK.cmake +10 -10
data/README.md +25 -23
data/example_files/Gemfile +2 -0
data/example_files/mappers/Baseline.rb +154 -154
data/example_files/mappers/ClassProject.rb +3 -3
data/example_files/measures/BuildResidentialModel/measure.rb +3 -3
data/example_files/measures/BuildResidentialModel/resources/util.rb +45 -45
data/lib/uo_cli/version.rb +1 -1
data/lib/uo_cli.rb +61 -66
data/uo_cli.gemspec +3 -1
metadata +31 -3
data/requirements.txt +0 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1403126b59a00ca08656510c8f97147cf88dc7b58be19d63944f99120c27d73
-  data.tar.gz: c5502d2e07c64a04908e4939ad83d7c312a790b06e0842dd053809263b05ab06
+  metadata.gz: 3b8ee2cd09a50121cae55adfc77ef76ea468e1923eb6bfde899e35b193261dd4
+  data.tar.gz: '08b77907722db1cbc4465a8864735545dfe55b8f9820e7da1e93b1348bd3e860'
 SHA512:
-  metadata.gz: 6f4482a92fc524b4d104764f9a654b62a2aeda1c78183c3f96a59e755645ba67b73b27ac667881f8bf436e8ad99f4ff5d1c8b3caaeed1b75a5b14bb9144f9443
-  data.tar.gz: 6862733daffd4901ec5ab6dc0f23ad5957c566fb86faa8b10ca8f5b89745bee6b351d5f3a6a9a596f97570a5624d0fa575dfc3e2334603e9253d7198ee3f2986
+  metadata.gz: d078d451cc11e8eff4ea463a2bf5e40d3c28d8ae3551036de31f9c2a4432bd564b67ec03f1753fd64bf2a12ecd4eb088c71f15bd36508af91cdca9dd0e84a849
+  data.tar.gz: f3f2ceb4c12281606e52a5f9a2977cf4eab015dad74c9456cf75c89d655149638686ae8eb9c6778cb8c3e03750ebab2ee34d97d8d60883ae4351c950fe419a2b

data/.github/workflows/nightly_build.yml ADDED Viewed

@@ -0,0 +1,60 @@
+name: nightly_build
+on:
+  # push:
+  schedule:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+    # 5:24 am UTC (11:24pm MDT the day before) every weekday night in MDT
+    - cron: '24 5 * * 2-6'
+env:
+  # Favor_Local_Gems enforces develop branch of all Ruby dependencies
+  # This is our canary in the coal mine! If any simulation tests fail, comment this and retry.
+  # If CI is then successful, we have a breaking change in a dependency somewhere.
+  FAVOR_LOCAL_GEMS: true
+  GEM_DEVELOPER_KEY: ${{ secrets.GEM_DEVELOPER_KEY }}
+  UO_NUM_PARALLEL: 2
+  # GHA machines only have 2 cores. Trying to run more than that is even slower.
+  # https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
+jobs:
+  weeknight-tests:
+    # ubuntu-latest works since https://github.com/rbenv/ruby-build/releases/tag/v20220710 (July 10, 2022)
+    # https://github.com/rbenv/ruby-build/discussions/1940
+    runs-on: ubuntu-latest
+    container:
+      image: docker://nrel/openstudio:3.5.1
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          # Disco needs python 3.10
+          python-version: '3.10'
+      - name: Install Ruby dependencies
+        run: |
+          ruby --version
+          bundle update
+          bundle exec certified-update
+      - name: Install python dependencies
+        run: bundle exec uo install_python
+      - name: Run Rspec
+        continue-on-error: true
+        # Continue to upload step even if a test fails, so we can troubleshoot
+        run: bundle exec rspec
+      - name: Upload artifacts
+      # Save results for examination - useful for debugging
+        uses: actions/upload-artifact@v3
+        if: failure() # Only upload if rspec fails
+        with:
+          name: rspec_results
+          path: |
+            spec/test_directory**/run/
+            # coverage/
+          retention-days: 7 # save for 1 week before deleting
+      # coveralls action docs: https://github.com/marketplace/actions/coveralls-github-action
+      # - name: Coveralls
+      #   uses: coverallsapp/github-action@1.1.3
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     path-to-lcov: "./coverage/lcov/urbanopt-cli.lcov"

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,11 @@
 # Changelog
+## Version 0.9.2
+Date Range: 01/06/23 - 04/11/23:
+- Fixed [#417]( https://github.com/urbanopt/urbanopt-cli/pull/417 ), pin addressable dependency to resolve unicode_normalize error
+- Fixed [#397]( https://github.com/urbanopt/urbanopt-cli/pull/397 ), New tests for GEB mappers
 ## Version 0.9.1
 Date Range: 12/14/22 - 01/05/23:

data/CMakeLists.txt CHANGED Viewed

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.10.2)
 cmake_policy(SET CMP0048 NEW)
-project(URBANoptCLI VERSION 0.8.3)
+project(URBANoptCLI VERSION 0.9.1)
 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-20221011-darwin.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9eee6fb77b168d1b2211e1888f733c63")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20230111-darwin.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "dfb4d2d28d6ff25b42d8e375b4435be2")
    else()
-     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20221011-linux.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "5d10dc28cca00bbaed4df8ba0a930868")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20230111-linux.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "2edb06d97ea496a3b3929a780404bb05")
    endif()
 elseif(WIN32)
   if(CMAKE_CL_64)
-    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20221011-windows.tar.gz")
-    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9c9dff191bc91379ce60923bfe6cfa4a")
+    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20230111-windows.tar.gz")
+    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "ecbad071c3aba2223e9ad5803c8004d8")
   endif()
 endif()
@@ -211,7 +211,7 @@ elseif(UNIX)
   # set(CPACK_DEBIAN_PACKAGE_DEBUG ON)
   # These two will set the .deb install path correctly
-  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqdbm14,sqlite3,libgomp1")
+  set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqdbm14,sqlite3,libgomp1,libncurses5")
   set(CPACK_SET_DESTDIR ON)
   set(CPACK_INSTALL_PREFIX /usr/local/urbanopt-cli-${URBANOPT_CLI_VERSION})

data/FindOpenStudioSDK.cmake CHANGED Viewed

@@ -1,6 +1,6 @@
 set(OPENSTUDIO_VERSION_MAJOR 3)
-set(OPENSTUDIO_VERSION_MINOR 4)
-set(OPENSTUDIO_VERSION_PATCH 0)
+set(OPENSTUDIO_VERSION_MINOR 5)
+set(OPENSTUDIO_VERSION_PATCH 1)
 set(OPENSTUDIO_VERSION "${OPENSTUDIO_VERSION_MAJOR}.${OPENSTUDIO_VERSION_MINOR}.${OPENSTUDIO_VERSION_PATCH}")
 find_package(openstudio "${OPENSTUDIO_VERSION}" CONFIG)
@@ -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 "+4bd816f785")
+  set(OPENSTUDIO_VERSION_SHA "+22e1db7be5")
   if(APPLE)
-    set(OPENSTUDIO_EXPECTED_HASH 5a1e5fdfc61a879a9d72dcf625a83e65)
-    set(OPENSTUDIO_PLATFORM "Darwin")
+    set(OPENSTUDIO_EXPECTED_HASH f21b03a44aa9ac3e52a4bdfa20009171)
+    set(OPENSTUDIO_PLATFORM "Darwin-x86_64")
     set(OPENSTUDIO_EXT "tar.gz")
   elseif(UNIX)
     if(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
-      set(OPENSTUDIO_EXPECTED_HASH 1922de95bb3e196f1c719400ce58871c)
+      set(OPENSTUDIO_EXPECTED_HASH 6e5c93002f0cfb445dcdcdb1270261a4)
+      set(OPENSTUDIO_PLATFORM "Ubuntu-20.04")
+    else() # Assumes 20.04
+      set(OPENSTUDIO_EXPECTED_HASH 6e5c93002f0cfb445dcdcdb1270261a4)
       set(OPENSTUDIO_PLATFORM "Ubuntu-20.04")
-    else() # Assumes 18.04
-      set(OPENSTUDIO_EXPECTED_HASH 44a837fa96fe2ce1a883492a3a1cae09)
-      set(OPENSTUDIO_PLATFORM "Ubuntu-18.04")
     endif()
     set(OPENSTUDIO_EXT "tar.gz")
   elseif(WIN32)
-    set(OPENSTUDIO_EXPECTED_HASH 9adffb37a62721ec51a33ce97533e956)
+    set(OPENSTUDIO_EXPECTED_HASH bc83efcb140d20f8f9758559a58c4347)
     set(OPENSTUDIO_PLATFORM "Windows")
     set(OPENSTUDIO_EXT "tar.gz")
   endif()

data/README.md CHANGED Viewed

@@ -1,8 +1,10 @@
+[![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-cli/badge.svg?branch=develop)](https://coveralls.io/github/urbanopt/urbanopt-cli?branch=develop)
 # URBANopt CLI
 This is the command line interface (CLI) for the URBANopt™ SDK.
-## Installation (Using Ruby)
+## Installation (Using Ruby)
 2 ) Using ruby add this line to your application's Gemfile:
@@ -25,40 +27,40 @@ gem install urbanopt-cli
 ## Installation (Using Installer)
-The UrbanOpt installer is an alternate way to install the UrbanOpt CLI that also includes Ruby 2.5.x and OpenStudio SDK.
-Below are installation instructions for each platform.
+The UrbanOpt installer is an alternate way to install the UrbanOpt CLI that also includes Ruby 2.5.x and OpenStudio SDK.
+Below are installation instructions for each platform.
 ### Linux (Ubuntu 18.04)
-Download the [.deb package](https://docs.urbanopt.net/installation/linux.html#install-with-the-urbanopt-installer).
+Download the [.deb package](https://docs.urbanopt.net/installation/linux.html#install-with-the-urbanopt-installer).
 ```terminal
-sudo apt update
+sudo apt update
 sudo apt install ./UrbanOptCLI-0.3.1.b6f118d506-Linux.deb
 ```
-This will install to `/usr/local/` directory.
-e.g.
-`/usr/local/urbanopt-cli-0.3.1/`
+This will install to `/usr/local/` directory.
+e.g.
+`/usr/local/urbanopt-cli-0.3.1/`
-To run the UrbanOpt CLI, first run the `setup-env.sh` script that generates environmental variables and stores these in `env_uo.sh` in your home directory.
+To run the UrbanOpt CLI, first run the `setup-env.sh` script that generates environmental variables and stores these in `env_uo.sh` in your home directory.
 ```terminal
-/usr/local/urbanopt-cli-0.3.1/setup-env.sh
+/usr/local/urbanopt-cli-0.3.1/setup-env.sh
 . ~/.env_uo.sh
 ```
 When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment.
-### Mac OSX (>= 10.12)
+### Mac OSX (>= 10.12)
-Download the [.dmg package](https://docs.urbanopt.net/installation/mac.html#install-with-the-urbanopt-installer).
+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.
+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.
-```terminal
-/Applications/UrbanOptCLI_0.3.1/setup-env.sh
+```terminal
+/Applications/UrbanOptCLI_0.3.1/setup-env.sh
 . ~/.env_uo.sh
 ```
@@ -66,26 +68,26 @@ When launching new shell terminals run `. ~/.env_uo.s` to setup the environment.
 ### Windows (64-bit Windows 7 – 10)
-Download the [.exe installer](https://docs.urbanopt.net/installation/windows.html#install-with-the-urbanopt-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).
 #### Bash (or GitBash for Windows)
 ```terminal
-c:/urbanopt-cli-0.3.1/setup-env.sh
-. ~/.env_uo.sh
+c:/urbanopt-cli-0.3.1/setup-env.sh
+. ~/.env_uo.sh
 ```
 #### Powershell
 ```terminal
-c:\urbanopt-cli-0.3.1\setup-env.ps1
-. ~\.env_uo.ps1
+c:\urbanopt-cli-0.3.1\setup-env.ps1
+. ~\.env_uo.ps1
 ```
 #### Windows Command Prompt
 ```terminal
-c:\urbanopt-cli-0.3.1\setup-env.bat
-%HOMEPATH%\.env_uo.bat
+c:\urbanopt-cli-0.3.1\setup-env.bat
+%HOMEPATH%\.env_uo.bat
 ```
 When launching new shell terminals run the correct environment config to setup the environment.

data/example_files/Gemfile CHANGED Viewed

@@ -25,6 +25,8 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #  gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
 # end
+# pin this dependency to avoid unicode_normalize error
+gem 'addressable', '2.8.1'
 if allow_local && File.exist?('../openstudio-common-measures-gem')
   gem 'openstudio-common-measures', path: '../../openstudio-common-measures-gem'

data/example_files/mappers/Baseline.rb CHANGED Viewed

@@ -391,55 +391,55 @@ module URBANopt
         # Options are: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc
         # egrid subregions can map directly to zipcodes but not to states. Some state might include multiple egrid subregions. the default mapper prioritize the egrid subregion that is most common in the state (covers the biggest number of zipcodes)
         future_emissions_mapping_hash =
-          { 'FL': 'FRCCc', # ['FRCCc', 'SRSOc']
-            'MS': 'SRMVc', # ['SRMVc', 'SRTVc']
-            'NE': 'MROWc', # ['MROWc', 'RMPAc']
-            'OR': 'NWPPc',
-            'CA': 'CAMXc', # ['CAMXc', 'NWPPc']
-            'VA': 'SRVCc', # ['SRVCc', 'RFCWc', 'RFCEc'],
-            'AR': 'SRMVc', # ['SRMVc', 'SPSOc']
-            'TX': 'ERCTc', # ['ERCTc', 'SRMVc', 'SPSOc', 'AZNMc']
-            'OH': 'RFCWc',
-            'UT': 'NWPPc',
-            'MT': 'NWPPc', # ['NWPPc', 'MROWc']
-            'TN': 'SRTVc',
-            'ID': 'NWPPc',
-            'WI': 'MROEc', # ['RFCWc', 'MROEc', 'MROWc']
-            'WV': 'RFCWc',
-            'NC': 'SRVCc',
-            'LA': 'SRMVc',
-            'IL': 'SRMWc', # ['RFCWc', 'SRMWc']
-            'OK': 'SPSOc',
-            'IA': 'MROWc',
-            'WA': 'NWPPc',
-            'SD': 'MROWc', # ['MROWc', 'RMPAc']
-            'MN': 'MROWc',
-            'KY': 'SRTVc', # ['SRTVc', 'RFCWc']
-            'MI': 'RFCMc', # ['RFCMc', 'MROEc']
-            'KS': 'SPNOc',
-            'NJ': 'RFCEc',
-            'NY': 'NYSTc',
-            'IN': 'RFCWc',
-            'VT': 'NEWEc',
-            'NM': 'AZNMc', # ['AZNMc', 'SPSOc']
-            'WY': 'RMPAc', # ['RMPAc', 'NWPPc']
-            'GA': 'SRSOc',
-            'MO': 'SRMWc', # ['SRMWc', 'SPNOc']
-            'DC': 'RFCEc',
-            'SC': 'SRVCc',
-            'PA': 'RFCEc', # ['RFCEc', 'RFCWc']
-            'CO': 'RMPAc',
-            'AZ': 'AZNMc',
-            'ME': 'NEWEc',
-            'AL': 'SRSOc',
-            'MD': 'RFCEc', # ['RFCEc', 'RFCWc']
-            'NH': 'NEWEc',
-            'MA': 'NEWEc',
-            'ND': 'MROWc',
-            'NV': 'NWPPc', # ['NWPPc', 'AZNMc']
-            'CT': 'NEWEc',
-            'DE': 'RFCEc',
-            'RI': 'NEWEc' }
+          { FL: 'FRCCc', # ['FRCCc', 'SRSOc']
+            MS: 'SRMVc', # ['SRMVc', 'SRTVc']
+            NE: 'MROWc', # ['MROWc', 'RMPAc']
+            OR: 'NWPPc',
+            CA: 'CAMXc', # ['CAMXc', 'NWPPc']
+            VA: 'SRVCc', # ['SRVCc', 'RFCWc', 'RFCEc'],
+            AR: 'SRMVc', # ['SRMVc', 'SPSOc']
+            TX: 'ERCTc', # ['ERCTc', 'SRMVc', 'SPSOc', 'AZNMc']
+            OH: 'RFCWc',
+            UT: 'NWPPc',
+            MT: 'NWPPc', # ['NWPPc', 'MROWc']
+            TN: 'SRTVc',
+            ID: 'NWPPc',
+            WI: 'MROEc', # ['RFCWc', 'MROEc', 'MROWc']
+            WV: 'RFCWc',
+            NC: 'SRVCc',
+            LA: 'SRMVc',
+            IL: 'SRMWc', # ['RFCWc', 'SRMWc']
+            OK: 'SPSOc',
+            IA: 'MROWc',
+            WA: 'NWPPc',
+            SD: 'MROWc', # ['MROWc', 'RMPAc']
+            MN: 'MROWc',
+            KY: 'SRTVc', # ['SRTVc', 'RFCWc']
+            MI: 'RFCMc', # ['RFCMc', 'MROEc']
+            KS: 'SPNOc',
+            NJ: 'RFCEc',
+            NY: 'NYSTc',
+            IN: 'RFCWc',
+            VT: 'NEWEc',
+            NM: 'AZNMc', # ['AZNMc', 'SPSOc']
+            WY: 'RMPAc', # ['RMPAc', 'NWPPc']
+            GA: 'SRSOc',
+            MO: 'SRMWc', # ['SRMWc', 'SPNOc']
+            DC: 'RFCEc',
+            SC: 'SRVCc',
+            PA: 'RFCEc', # ['RFCEc', 'RFCWc']
+            CO: 'RMPAc',
+            AZ: 'AZNMc',
+            ME: 'NEWEc',
+            AL: 'SRSOc',
+            MD: 'RFCEc', # ['RFCEc', 'RFCWc']
+            NH: 'NEWEc',
+            MA: 'NEWEc',
+            ND: 'MROWc',
+            NV: 'NWPPc', # ['NWPPc', 'AZNMc']
+            CT: 'NEWEc',
+            DE: 'RFCEc',
+            RI: 'NEWEc' }
         # get the state from weather file
         state = feature.weather_filename.split('_', -1)[1]
@@ -459,55 +459,55 @@ module URBANopt
         # Mapping is done using mapping tools from eGrid and AVERT (ZipCode for eGrid and fraction of state for AVERT).
         # Mapped based on the maps of each set of regions:
         hourly_historical_mapping_hash =
-          { 'FL': 'Florida',
-            'MS': 'Midwest',
-            'NE': 'Midwest',  # MRWO could be Midwest / Central
-            'OR': 'Northwest',
-            'CA': 'California',
-            'VA': 'Carolinas',
-            'AR': 'Midwest',
-            'TX': 'Texas',
-            'OH': 'Midwest',  # RFCW could be Midwest / Mid Atlantic
-            'UT': 'Northwest',
-            'MT': 'Northwest',
-            'TN': 'Tennessee',
-            'ID': 'Northwest',
-            'WI': 'Midwest',
-            'WV': 'Midwest', # RFCW could be Midwest / Mid Atlantic
-            'NC': 'Carolinas',
-            'LA': 'Midwest',
-            'IL': 'Midwest',
-            'OK': 'Central',
-            'IA': 'Midwest', # MRWO could be Midwest / Central
-            'WA': 'Northwest',
-            'SD': 'Midwest',  # MRWO could be Midwest / Central
-            'MN': 'Midwest',  # MRWO could be Midwest / Central
-            'KY': 'Tennessee',
-            'MI': 'Midwest',
-            'KS': 'Central',
-            'NJ': 'Mid-Atlantic',
-            'NY': 'New York',
-            'IN': 'Midwest', # RFCW could be Midwest / Mid Atlantic
-            'VT': 'New England',
-            'NM': 'Southwest',
-            'WY': 'Rocky Mountains',
-            'GA': 'SRSO',
-            'MO': 'Midwest',
-            'DC': 'Mid-Atlantic',
-            'SC': 'Carolinas',
-            'PA': 'Mid-Atlantic',
-            'CO': 'Rocky Mountains',
-            'AZ': 'Southwest',
-            'ME': 'New England',
-            'AL': 'Southeast',
-            'MD': 'Mid-Atlantic',
-            'NH': 'New England',
-            'MA': 'New England',
-            'ND': 'Midwest', # MRWO could be Midwest / Central
-            'NV': 'Northwest',
-            'CT': 'New England',
-            'DE': 'Mid-Atlantic',
-            'RI': 'New England' }
+          { FL: 'Florida',
+            MS: 'Midwest',
+            NE: 'Midwest',  # MRWO could be Midwest / Central
+            OR: 'Northwest',
+            CA: 'California',
+            VA: 'Carolinas',
+            AR: 'Midwest',
+            TX: 'Texas',
+            OH: 'Midwest',  # RFCW could be Midwest / Mid Atlantic
+            UT: 'Northwest',
+            MT: 'Northwest',
+            TN: 'Tennessee',
+            ID: 'Northwest',
+            WI: 'Midwest',
+            WV: 'Midwest', # RFCW could be Midwest / Mid Atlantic
+            NC: 'Carolinas',
+            LA: 'Midwest',
+            IL: 'Midwest',
+            OK: 'Central',
+            IA: 'Midwest', # MRWO could be Midwest / Central
+            WA: 'Northwest',
+            SD: 'Midwest',  # MRWO could be Midwest / Central
+            MN: 'Midwest',  # MRWO could be Midwest / Central
+            KY: 'Tennessee',
+            MI: 'Midwest',
+            KS: 'Central',
+            NJ: 'Mid-Atlantic',
+            NY: 'New York',
+            IN: 'Midwest', # RFCW could be Midwest / Mid Atlantic
+            VT: 'New England',
+            NM: 'Southwest',
+            WY: 'Rocky Mountains',
+            GA: 'SRSO',
+            MO: 'Midwest',
+            DC: 'Mid-Atlantic',
+            SC: 'Carolinas',
+            PA: 'Mid-Atlantic',
+            CO: 'Rocky Mountains',
+            AZ: 'Southwest',
+            ME: 'New England',
+            AL: 'Southeast',
+            MD: 'Mid-Atlantic',
+            NH: 'New England',
+            MA: 'New England',
+            ND: 'Midwest', # MRWO could be Midwest / Central
+            NV: 'Northwest',
+            CT: 'New England',
+            DE: 'Mid-Atlantic',
+            RI: 'New England' }
         # get the state from weather file
         state = feature.weather_filename.split('_', -1)[1]
@@ -524,55 +524,55 @@ module URBANopt
         # Options are: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC
         # egrid subregions can map directly to zipcodes but not to states. Some state might include multiple egrid subregions. the default mapper prioritize the egrid subregion that is most common in the state (covers the biggest number of zipcodes)
         annual_historical_mapping_hash =
-          { 'FL': 'FRCC',
-            'MS': 'SRMV',
-            'NE': 'MROW',
-            'OR': 'NWPP',
-            'CA': 'CAMX',
-            'VA': 'SRVC',
-            'AR': 'SRMV',
-            'TX': 'ERCT',
-            'OH': 'RFCW',
-            'UT': 'NWPP',
-            'MT': 'NWPP',
-            'TN': 'SRTV',
-            'ID': 'NWPP',
-            'WI': 'MROE',
-            'WV': 'RFCW',
-            'NC': 'SRVC',
-            'LA': 'SRMV',
-            'IL': 'SRMW',
-            'OK': 'SPSO',
-            'IA': 'MROW',
-            'WA': 'NWPP',
-            'SD': 'MROW',
-            'MN': 'MROW',
-            'KY': 'SRTV',
-            'MI': 'RFCM',
-            'KS': 'SPNO',
-            'NJ': 'RFCE',
-            'NY': 'NYCW',
-            'IN': 'RFCW',
-            'VT': 'NEWE',
-            'NM': 'AZNM',
-            'WY': 'RMPA',
-            'GA': 'SRSO',
-            'MO': 'SRMW',
-            'DC': 'RFCE',
-            'SC': 'SRVC',
-            'PA': 'RFCE',
-            'CO': 'RMPA',
-            'AZ': 'AZNM',
-            'ME': 'NEWE',
-            'AL': 'SRSO',
-            'MD': 'RFCE',
-            'NH': 'NEWE',
-            'MA': 'NEWE',
-            'ND': 'MROW',
-            'NV': 'NWPP',
-            'CT': 'NEWE',
-            'DE': 'RFCE',
-            'RI': 'NEWE' }
+          { FL: 'FRCC',
+            MS: 'SRMV',
+            NE: 'MROW',
+            OR: 'NWPP',
+            CA: 'CAMX',
+            VA: 'SRVC',
+            AR: 'SRMV',
+            TX: 'ERCT',
+            OH: 'RFCW',
+            UT: 'NWPP',
+            MT: 'NWPP',
+            TN: 'SRTV',
+            ID: 'NWPP',
+            WI: 'MROE',
+            WV: 'RFCW',
+            NC: 'SRVC',
+            LA: 'SRMV',
+            IL: 'SRMW',
+            OK: 'SPSO',
+            IA: 'MROW',
+            WA: 'NWPP',
+            SD: 'MROW',
+            MN: 'MROW',
+            KY: 'SRTV',
+            MI: 'RFCM',
+            KS: 'SPNO',
+            NJ: 'RFCE',
+            NY: 'NYCW',
+            IN: 'RFCW',
+            VT: 'NEWE',
+            NM: 'AZNM',
+            WY: 'RMPA',
+            GA: 'SRSO',
+            MO: 'SRMW',
+            DC: 'RFCE',
+            SC: 'SRVC',
+            PA: 'RFCE',
+            CO: 'RMPA',
+            AZ: 'AZNM',
+            ME: 'NEWE',
+            AL: 'SRSO',
+            MD: 'RFCE',
+            NH: 'NEWE',
+            MA: 'NEWE',
+            ND: 'MROW',
+            NV: 'NWPP',
+            CT: 'NEWE',
+            DE: 'RFCE',
+            RI: 'NEWE' }
         # get the state from weather file
         state = feature.weather_filename.split('_', -1)[1]
@@ -880,7 +880,7 @@ module URBANopt
             if !template.nil? && 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 = captures.names.zip(captures.captures).to_h
               template_vals = template_vals.transform_keys(&:to_sym)
               epw = File.join(File.dirname(__FILE__), '../weather', feature.weather_filename)
@@ -994,18 +994,18 @@ module URBANopt
             default_args.each do |arg_name, arg_default|
               next if arg_default.nil?
-              if !args.key?(arg_name)
-                args[arg_name] = arg_default
-              else
+              if args.key?(arg_name)
                 if debug
-                  if !arg_default.nil?
+                  if arg_default.nil?
+                    puts "Setting #{arg_name} to '#{args[arg_name]}'."
+                  else
                     if args[arg_name] != arg_default
                       puts "Overriding #{arg_name} default '#{arg_default}' with '#{args[arg_name]}'."
                     end
-                  else
-                    puts "Setting #{arg_name} to '#{args[arg_name]}'."
                   end
                 end
+              else
+                args[arg_name] = arg_default
               end
             end

data/example_files/mappers/ClassProject.rb CHANGED Viewed

@@ -46,7 +46,7 @@ module URBANopt
         feature = features[0]
         building_type = feature.building_type
         # Energy Efficiency Measures
         OpenStudio::Extension.set_measure_argument(osw, 'AddOverhangsByProjectionFactor', '__SKIP__', true)
@@ -96,8 +96,8 @@ module URBANopt
         OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex1', 'Float')
         OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex_hrs1', '08:01-20:00')
-        OpenStudio::Extension.set_measure_argument(osw,'add_packaged_ice_storage', '__SKIP__', true)
-        OpenStudio::Extension.set_measure_argument(osw,'add_packaged_ice_storage', 'ice_cap', 'AutoSize')
+        OpenStudio::Extension.set_measure_argument(osw, 'add_packaged_ice_storage', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_packaged_ice_storage', 'ice_cap', 'AutoSize')
         OpenStudio::Extension.set_measure_argument(osw, 'ShiftScheduleByType', '__SKIP__', true)
         OpenStudio::Extension.set_measure_argument(osw, 'ShiftScheduleByType', 'shift_value', -2)

data/example_files/measures/BuildResidentialModel/measure.rb CHANGED Viewed

@@ -162,7 +162,9 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       measures = {}
       hpxml_path = File.expand_path("../#{unit['name']}.xml")
-      if !unit.key?('hpxml_path')
+      if unit.key?('hpxml_path')
+        FileUtils.cp(File.expand_path(unit['hpxml_path']), hpxml_path)
+      else
         # BuildResidentialHPXML
         measure_subdir = 'BuildResidentialHPXML'
@@ -196,8 +198,6 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         measure_args.delete('geometry_num_floors_above_grade')
         measures[measure_subdir] << measure_args
-      else
-        FileUtils.cp(File.expand_path(unit['hpxml_path']), hpxml_path)
       end
       # BuildResidentialScheduleFile

data/example_files/measures/BuildResidentialModel/resources/util.rb CHANGED Viewed

@@ -80,17 +80,17 @@ class MathTools
   end
   def self.interp2(x, x0, x1, f0, f1)
-    '''
+    '
     Returns the linear interpolation between two results.
-    '''
+    '
     return f0 + ((x - x0) / (x1 - x0)) * (f1 - f0)
   end
   def self.interp4(x, y, x1, x2, y1, y2, fx1y1, fx1y2, fx2y1, fx2y2)
-    '''
+    '
     Returns the bilinear interpolation between four results.
-    '''
+    '
     return (fx1y1 / ((x2 - x1) * (y2 - y1))) * (x2 - x) * (y2 - y) \
           + (fx2y1 / ((x2 - x1) * (y2 - y1))) * (x - x1) * (y2 - y) \
@@ -99,7 +99,7 @@ class MathTools
   end
   def self.biquadratic(x, y, c)
-    '''
+    '
     Description:
     ------------
         Calculate the result of a biquadratic polynomial with independent variables
@@ -113,7 +113,7 @@ class MathTools
     Outputs:
     --------
         z       float      result of biquadratic polynomial
-    '''
+    '
     if c.length != 6
       puts 'Error: There must be 6 coefficients in a biquadratic polynomial'
     end
@@ -122,7 +122,7 @@ class MathTools
   end
   def self.quadratic(x, c)
-    '''
+    '
     Description:
     ------------
         Calculate the result of a quadratic polynomial with independent variable
@@ -138,7 +138,7 @@ class MathTools
     Outputs:
     --------
         y       float      result of biquadratic polynomial
-    '''
+    '
     if c.size != 3
       puts 'Error: There must be 3 coefficients in a quadratic polynomial'
     end
@@ -148,7 +148,7 @@ class MathTools
   end
   def self.bicubic(x, y, c)
-    '''
+    '
     Description:
     ------------
         Calculate the result of a bicubic polynomial with independent variables
@@ -166,7 +166,7 @@ class MathTools
     Outputs:
     --------
         z       float      result of bicubic polynomial
-    '''
+    '
     if c.size != 10
       puts 'Error: There must be 10 coefficients in a bicubic polynomial'
     end
@@ -177,7 +177,7 @@ class MathTools
   end
   def self.Iterate(x0, f0, x1, f1, x2, f2, icount, cvg)
-    '''
+    '
     Description:
     ------------
         Determine if a guess is within tolerance for convergence
@@ -225,7 +225,7 @@ class MathTools
         else:
             print "x did NOT converge after", i, "iterations"
         print "x, when f(x) is", f,"is", x
-    '''
+    '
     tolRel = 1e-5
     dx = 0.1
@@ -987,16 +987,16 @@ class OutputMeters
             plant_loop.supplyComponents.each do |supply_component|
               next unless supply_component.to_BoilerHotWater.is_initialized
-              if units_served.length != 1 # this is a central system
-                if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
-                  custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
-                end
-                custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
-              else
+              if units_served.length == 1
                 if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
                   custom_meter_infos["#{unit.name}:ElectricityHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
                 end
                 custom_meter_infos["#{unit.name}:ElectricityHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
+              else # this is a central system
+                if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
+                  custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
+                end
+                custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
               end
             end
           end
@@ -1029,16 +1029,16 @@ class OutputMeters
             plant_loop.supplyComponents.each do |supply_component|
               next unless supply_component.to_BoilerHotWater.is_initialized
-              if units_served.length != 1 # this is a central system
-                if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
-                  custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
-                end
-                custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
-              else
+              if units_served.length == 1
                 if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
                   custom_meter_infos["#{unit.name}:ElectricityHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
                 end
                 custom_meter_infos["#{unit.name}:ElectricityHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
+              else # this is a central system
+                if supply_component.to_BoilerHotWater.get.fuelType == 'Electricity'
+                  custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Electric Energy']
+                end
+                custom_meter_infos['Central:ElectricityHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Ancillary Electric Energy']
               end
             end
           end
@@ -1089,10 +1089,10 @@ class OutputMeters
             plant_loop.supplyComponents.each do |supply_component|
               next unless supply_component.to_ChillerElectricEIR.is_initialized
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:ElectricityCooling']['key_var_groups'] << [supply_component.name.to_s, 'Chiller Electric Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:ElectricityCooling"]['key_var_groups'] << [supply_component.name.to_s, 'Chiller Electric Energy']
+              else # this is a central system
+                custom_meter_infos['Central:ElectricityCooling']['key_var_groups'] << [supply_component.name.to_s, 'Chiller Electric Energy']
               end
             end
           end
@@ -1317,10 +1317,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'NaturalGas'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:NaturalGasHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:NaturalGasHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
+              else # this is a central system
+                custom_meter_infos['Central:NaturalGasHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
               end
             end
           end
@@ -1350,10 +1350,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'NaturalGas'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:NaturalGasHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:NaturalGasHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
+              else # this is a central system
+                custom_meter_infos['Central:NaturalGasHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Gas Energy']
               end
             end
           end
@@ -1446,10 +1446,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'FuelOil#1'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:FuelOilHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:FuelOilHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
+              else # this is a central system
+                custom_meter_infos['Central:FuelOilHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
               end
             end
           end
@@ -1479,10 +1479,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'FuelOil#1'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:FuelOilHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:FuelOilHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
+              else # this is a central system
+                custom_meter_infos['Central:FuelOilHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler FuelOil#1 Energy']
               end
             end
           end
@@ -1549,10 +1549,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'PropaneGas'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:PropaneHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:PropaneHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
+              else # this is a central system
+                custom_meter_infos['Central:PropaneHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
               end
             end
           end
@@ -1582,10 +1582,10 @@ class OutputMeters
               next unless supply_component.to_BoilerHotWater.is_initialized
               next if supply_component.to_BoilerHotWater.get.fuelType != 'PropaneGas'
-              if units_served.length != 1 # this is a central system
-                custom_meter_infos['Central:PropaneHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
-              else
+              if units_served.length == 1
                 custom_meter_infos["#{unit.name}:PropaneHeating"]['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
+              else # this is a central system
+                custom_meter_infos['Central:PropaneHeating']['key_var_groups'] << [supply_component.name.to_s, 'Boiler Propane Energy']
               end
             end
           end

data/lib/uo_cli/version.rb CHANGED Viewed

@@ -40,6 +40,6 @@
 module URBANopt
   module CLI
-    VERSION = '0.9.1'.freeze
+    VERSION = '0.9.2'.freeze
   end
 end

data/lib/uo_cli.rb CHANGED Viewed

@@ -453,26 +453,26 @@ module URBANopt
     # One solution would be changing scenario_file to feature.
     #   Would that be confusing when creating a ScenarioFile from the FeatureFile?
     if @opthash.subopts[:feature]
-      @feature_path, @feature_name = File.split(File.expand_path(@opthash.subopts[:feature]))
+      @feature_path, @feature_name = Pathname(File.expand_path(@opthash.subopts[:feature])).split
     end
     if @opthash.subopts[:scenario]
-      @root_dir, @scenario_file_name = File.split(File.expand_path(@opthash.subopts[:scenario]))
+      @root_dir, @scenario_file_name = Pathname(File.expand_path(@opthash.subopts[:scenario])).split
       @scenario_name = File.basename(@scenario_file_name, File.extname(@scenario_file_name))
     end
     # Simulate energy usage as defined by ScenarioCSV
     def self.run_func
-      run_dir = File.join(@root_dir, 'run', @scenario_name.downcase)
-      csv_file = File.join(@root_dir, @scenario_file_name)
-      featurefile = File.join(@root_dir, @feature_name)
-      mapper_files_dir = File.join(@root_dir, 'mappers')
-      reopt_files_dir = File.join(@root_dir, 'reopt/')
+      run_dir = @root_dir / 'run' / @scenario_name.downcase
+      csv_file = @root_dir / @scenario_file_name
+      featurefile = @root_dir / @feature_name
+      mapper_files_dir = @root_dir / 'mappers'
+      reopt_files_dir = @root_dir / 'reopt/'
       num_header_rows = 1
       if @feature_id
-        feature_run_dir = File.join(run_dir, @feature_id)
+        feature_run_dir = run_dir / @feature_id
         # If run folder for feature exists, remove it
-        FileUtils.rm_rf(feature_run_dir) if File.exist?(feature_run_dir)
+        FileUtils.rm_rf(feature_run_dir) if feature_run_dir.exist?
       end
       feature_file = URBANopt::GeoJSON::GeoFile.from_file(featurefile)
@@ -578,6 +578,26 @@ module URBANopt
       end
     end
+    # Change num_parallel in runner.conf to set number of cores to use when running simulations
+    # This function is called during project_dir creation/updating so users aren't surprised if they look at the config file
+    def self.use_num_parallel(project_dir)
+      if ENV['UO_NUM_PARALLEL'] || @opthash.subopts[:num_parallel]
+        runner_file_path = Pathname(project_dir) / 'runner.conf'
+        runner_conf_hash = JSON.parse(File.read(runner_file_path))
+        if @opthash.subopts[:num_parallel]
+          runner_conf_hash['num_parallel'] = @opthash.subopts[:num_parallel]
+          File.open(runner_file_path, 'w+') do |f|
+            f << runner_conf_hash.to_json
+          end
+        elsif ENV['UO_NUM_PARALLEL']
+          runner_conf_hash['num_parallel'] = ENV['UO_NUM_PARALLEL'].to_i
+          File.open(runner_file_path, 'w+') do |f|
+            f << runner_conf_hash.to_json
+          end
+        end
+      end
+    end
     # Create project folder
     # params\
     # +dir_name+:: _string_ Name of new project folder
@@ -617,15 +637,7 @@ module URBANopt
             # copy config file
             FileUtils.cp(File.join(path_item, 'runner.conf'), dir_name)
-            # If the env var is set, change the num_parallel value to be what the env var is set to
-            if ENV['UO_NUM_PARALLEL']
-              runner_file_path = File.join(dir_name, 'runner.conf')
-              runner_conf_hash = JSON.parse(File.read(runner_file_path))
-              runner_conf_hash['num_parallel'] = ENV['UO_NUM_PARALLEL'].to_i
-              File.open(runner_file_path, 'w+') do |f|
-                f << runner_conf_hash.to_json
-              end
-            end
+            use_num_parallel(dir_name)
             # copy gemfile
             FileUtils.cp(File.join(path_item, 'Gemfile'), dir_name)
@@ -681,6 +693,9 @@ module URBANopt
                 FileUtils.cp(File.join(path_item, 'mappers/ThermalStorage.rb'), File.join(dir_name, 'mappers'))
                 FileUtils.cp(File.join(path_item, 'mappers/EvCharging.rb'), File.join(dir_name, 'mappers'))
                 FileUtils.cp(File.join(path_item, 'mappers/FlexibleHotWater.rb'), File.join(dir_name, 'mappers'))
+                FileUtils.cp(File.join(path_item, 'mappers/ChilledWaterStorage.rb'), File.join(dir_name, 'mappers'))
+                FileUtils.cp(File.join(path_item, 'mappers/PeakHoursThermostatAdjust.rb'), File.join(dir_name, 'mappers'))
+                FileUtils.cp(File.join(path_item, 'mappers/PeakHoursMelsShedding.rb'), File.join(dir_name, 'mappers'))
                 # copy osw file
                 FileUtils.cp(File.join(path_item, 'mappers/base_workflow.osw'), File.join(dir_name, 'mappers'))
@@ -811,19 +826,10 @@ module URBANopt
           # copy config file
           FileUtils.cp_r(File.join(path_item, 'runner.conf'), new_path, remove_destination: true)
-          # If the env var is set, change the num_parallel value to be what the env var is set to
-          # TODO: make this into a function...it's used in 2 places
-          if ENV['UO_NUM_PARALLEL']
-            runner_file_path = File.join(new_path, 'runner.conf')
-            runner_conf_hash = JSON.parse(File.read(runner_file_path))
-            runner_conf_hash['num_parallel'] = ENV['UO_NUM_PARALLEL'].to_i
-            File.open(runner_file_path, 'w+') do |f|
-              f << runner_conf_hash.to_json
-            end
-          end
+          use_num_parallel(new_path)
           # Replace standard mappers
-          # Note: this also copies createBar and Floorspace without checking project type (for now)
+          # FIXME: this also copies createBar and Floorspace without checking project type (for now)
           mappers = File.join(path_item, 'mappers')
           Pathname.new(mappers).children.each { |mapper| FileUtils.cp_r(mapper, File.join(new_path, 'mappers'), remove_destination: true) }
@@ -920,7 +926,7 @@ module URBANopt
     # Return UO python packages list from python_deps/dependencies.json
     def self.get_python_deps
       deps = []
-      the_path = ""
+      the_path = ''
       $LOAD_PATH.each do |path_item|
         if path_item.to_s.end_with?('example_files')
           # install python in cli gem's example_files/python_deps folder
@@ -980,18 +986,18 @@ module URBANopt
         puts "DEPENDENCIES RETRIEVED FROM FILE: #{deps}"
         errors = []
         deps.each do |dep|
-          #TODO: Update when there is a stable release for DISCO
-          if dep[:name].to_s.include? "disco"
+          # TODO: Update when there is a stable release for DISCO
+          if dep[:name].to_s.include? 'disco'
             stdout, stderr, status = Open3.capture3("#{pvars[:pip_path]} show NREL-disco")
-          else
+          else
             stdout, stderr, status = Open3.capture3("#{pvars[:pip_path]} show #{dep[:name]}")
           end
           if stderr.empty?
             # check versions
-            m = stdout.match /^Version: (\S{3,}$)/
+            m = stdout.match(/^Version: (\S{3,}$)/)
             err = true
-            if m and m.size > 1
-              if !dep[:version].nil? and dep[:version].to_s == m[1].to_s
+            if m && m.size > 1
+              if !dep[:version].nil? && dep[:version].to_s == m[1].to_s
                 puts "...#{dep[:name]} found with specified version #{dep[:version]}"
                 err = false
               elsif dep[:version].nil?
@@ -1107,14 +1113,14 @@ module URBANopt
         deps = get_python_deps
         deps.each do |dep|
           puts "Installing #{dep[:name]}..."
-          the_command = ""
+          the_command = ''
           if dep[:version].nil?
             the_command = "#{pvars[:pip_path]} install #{dep[:name]}"
           else
             the_command = "#{pvars[:pip_path]} install #{dep[:name]}~=#{dep[:version]}"
           end
           # system(the_command)
-          #puts "INSTALL COMMAND: #{the_command}"
+          # puts "INSTALL COMMAND: #{the_command}"
           stdout, stderr, status = Open3.capture3(the_command)
           if stderr && !stderr == ''
             puts "Error installing: #{stderr}"
@@ -1197,7 +1203,7 @@ module URBANopt
        @opthash.subopts[:scenario_file].nil? &&
        @opthash.subopts[:reopt_scenario_file].nil? &&
        @opthash.subopts[:project_folder].nil?
-      abort("\nNo options provided to the `create` command. Did you forget the `-p` flag? See `uo create --help` for all options\n")
+      abort("\nNo options provided for the `create` command. Did you forget a flag? Perhaps `-p`? See `uo create --help` for all options\n")
     end
     # Update existing URBANopt Project files
@@ -1217,26 +1223,10 @@ module URBANopt
     # Run simulations
     if @opthash.command == 'run' && @opthash.subopts[:scenario] && @opthash.subopts[:feature]
-      # Change num_parallel in runner.conf - Use case is for CI to use more cores
-      # If set by env variable, use that, otherwise use what the user specified in the cli
-      if ENV['UO_NUM_PARALLEL'] || @opthash.subopts[:num_parallel]
-        runner_file_path = File.join(@root_dir, 'runner.conf')
-        runner_conf_hash = JSON.parse(File.read(runner_file_path))
-        if @opthash.subopts[:num_parallel]
-          runner_conf_hash['num_parallel'] = @opthash.subopts[:num_parallel]
-          File.open(runner_file_path, 'w+') do |f|
-            f << runner_conf_hash.to_json
-          end
-        elsif ENV['UO_NUM_PARALLEL']
-          runner_conf_hash['num_parallel'] = ENV['UO_NUM_PARALLEL'].to_i
-          File.open(runner_file_path, 'w+') do |f|
-            f << runner_conf_hash.to_json
-          end
-        end
-      end
+      use_num_parallel(@root_dir)
       if @opthash.subopts[:scenario].to_s.include? '-'
-        @feature_id = (@feature_name.split(/\W+/)[1]).to_s
+        @feature_id = (@feature_name.to_s.split(/\W+/)[1])
       end
       puts "\nSimulating features of '#{@feature_name}' as directed by '#{@scenario_file_name}'...\n\n"
@@ -1414,12 +1404,12 @@ module URBANopt
         commands.each do |command|
           # TODO: This will be updated so stderr only reports error/warnings at DISCO level
           stdout, stderr, status = Open3.capture3(command)
-          if !stderr.empty?
+          if !stderr.empty?
             puts "ERROR running DISCO: #{stderr}"
           end
         end
-        puts "Refer to detailed log file #{File.join(run_folder,'disco','run_upgrade_cost_analysis.log')} for more information on the run."
-        puts "Refer to the output summary file #{File.join(run_folder,'disco','output_summary.json')} for a summary of the results."
+        puts "Refer to detailed log file #{File.join(run_folder, 'disco', 'run_upgrade_cost_analysis.log')} for more information on the run."
+        puts "Refer to the output summary file #{File.join(run_folder, 'disco', 'output_summary.json')} for a summary of the results."
       end
     end
@@ -1459,7 +1449,7 @@ module URBANopt
     # Post-process the scenario
     if @opthash.command == 'process'
-      if @opthash.subopts[:default] == false && @opthash.subopts[:opendss] == false && @opthash.subopts[:reopt_scenario] == false && @opthash.subopts[:reopt_feature] == false && @opthash.subopts[:disco] == false
+      if @opthash.subopts[:default] == false && @opthash.subopts[:opendss] == false && @opthash.subopts[:reopt_scenario] == false && @opthash.subopts[:reopt_feature] == false && @opthash.subopts[:disco] == false
         abort("\nERROR: No valid process type entered. Must enter a valid process type\n")
       end
@@ -1720,12 +1710,17 @@ module URBANopt
               abort("\nERROR: Units type not recognized. Please use a valid option in the CLI")
             end
             building_type = feature[:properties][:building_type] # From FeatureFile
-            if feature_eui_value > validation_params['EUI'][@opthash.subopts[:units]][building_type]['max']
-              puts "\nFeature #{File.basename(feature_path)} EUI of #{feature_eui_value.round(2)} #{unit_value} is greater than the validation maximum."
-            elsif feature_eui_value < validation_params['EUI'][@opthash.subopts[:units]][building_type]['min']
-              puts "\nFeature #{File.basename(feature_path)} (#{building_type}) EUI of #{feature_eui_value.round(2)} #{unit_value} is less than the validation minimum."
+            validation_upper_limit = validation_params['EUI'][@opthash.subopts[:units]][building_type]['max']
+            validation_lower_limit = validation_params['EUI'][@opthash.subopts[:units]][building_type]['min']
+            if feature_eui_value > validation_upper_limit
+              puts "\nFeature #{File.basename(feature_path)} (#{building_type}) EUI of #{feature_eui_value.round(2)} #{unit_value} " \
+              "is greater than the validation maximum of #{validation_upper_limit}."
+            elsif feature_eui_value < validation_lower_limit
+              puts "\nFeature #{File.basename(feature_path)} (#{building_type}) EUI of #{feature_eui_value.round(2)} #{unit_value} " \
+              "is less than the validation minimum of #{validation_lower_limit}."
             else
-              puts "\nFeature #{File.basename(feature_path)} (#{building_type}) EUI of #{feature_eui_value.round(2)} #{unit_value} is within bounds set by #{validation_file_name}."
+              puts "\nFeature #{File.basename(feature_path)} (#{building_type}) EUI of #{feature_eui_value.round(2)} #{unit_value} " \
+              "is within bounds set by #{validation_file_name} (#{validation_lower_limit} - #{validation_upper_limit})."
             end
           end
         end

data/uo_cli.gemspec CHANGED Viewed

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib', 'example_files']
   spec.required_ruby_version = '~> 2.7.0'
-  #   use specific versions of urbanopt and openstudio dependencies while under heavy development
+  # use specific versions of urbanopt and openstudio dependencies while under heavy development
   spec.add_runtime_dependency 'optimist', '~> 3'
   spec.add_runtime_dependency 'urbanopt-geojson', '~> 0.9.0'
   spec.add_runtime_dependency 'urbanopt-reopt', '~> 0.9.0'
@@ -47,4 +47,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 1.15.0'
   spec.add_development_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.11.3'
+  spec.add_development_dependency 'simplecov', '~> 0.18.2'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-cli
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Nathan Moore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -178,6 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.11.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: Interfacing with URBANopt
 email:
 - nathan.moore@nrel.gov
@@ -189,6 +217,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/nightly_build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -1087,7 +1116,6 @@ files:
 - example_files/xml_building/17/unit 4.xml
 - lib/uo_cli.rb
 - lib/uo_cli/version.rb
-- requirements.txt
 - scripts/setup-env-gitbash.sh
 - scripts/setup-env-unix.sh
 - scripts/setup-env.bat

data/requirements.txt DELETED Viewed

	@@ -1,2 +0,0 @@
1	- geojson-modelica-translator~=0.2.2
2	- urbanopt-ditto-reader~=0.3.8