urbanopt-cli 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4748528e1bec16cb2fd5ceee5a33e8eb971e0413c98afc8749c25713e48b8115
-  data.tar.gz: 38ddd809cc529d9424d8fd53bb8bf577cee995c1cc2d8fe9cfa6e01893329c31
+  metadata.gz: 6e5df564dfc3eb3721c92cdbd5b891f4dbe30f25fdbd1675a524bb83405c693e
+  data.tar.gz: 77066270f710fd6e0740b6b4f19a594d9c1678f627e0d44899ef0441631dcfb8
 SHA512:
-  metadata.gz: 8b2411b0c69344f0280cddd43027ed866288c0cc9f15a2535677b7e2ef94aded45067927b3a1fcc5eee094aa180c2160fd36139b5a6ceb4d6ece0d31a3c7c590
-  data.tar.gz: 779a0410116101dede994285d6b15c6639f98fd52f9e3157d6251eca847ebf63976c6d585ab05fe0c3bc467a09d14edbdde16ac81d182f3e0561882b514bf909
+  metadata.gz: b90a53b3af3ff7c9834e2f1d0d258055dd87ec086605e2f4192ba3f8e8d265c9eeca1b244315c821c69a4d789dfb02cca25b75208939631e2d5e58af111aca81
+  data.tar.gz: 91167c44034b9c50ae4399a08d11d11145271f65dea54da400cf7a6b8ac27cb1c3c3dc77961b243f49e6bd6ce0f1c7f8eb4faab51ab81266b9cec92f243d8a44

data/.github/workflows/nightly_ci_build.yml

@@ -1,8 +1,9 @@
 name: CLI CI
 
 on:
-  # Run on weeknights, and also whenever a push is made
-  push:
+  workflow_dispatch:
+  # Run on demand and weeknights
+  # 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
@@ -16,6 +17,7 @@ env:
   # 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 }}
+  # RUBYLIB: /usr/local/openstudio-3.7.0/Ruby
   UO_NUM_PARALLEL: 4
   # GHA machines have 4 cores. Trying to run more concurrently will slow everything down.
   # https://github.blog/2024-01-17-github-hosted-runners-double-the-power-for-open-source/
@@ -24,29 +26,25 @@ jobs:
     strategy:
       matrix:
         # os: container operations in GHA only work on Ubuntu
-        simulation-type: [basic, GEB, residential, electric]
-        # python-version: No need to test more than 1 python-version
+        # https://docs.github.com/en/actions/using-containerized-services/about-service-containers
+        simulation-type: [basic, GHE, GEB, residential, electric]
     runs-on: ubuntu-latest
     container:
       image: docker://nrel/openstudio:3.7.0
     steps:
       - uses: actions/checkout@v4
       - name: Change Owner of Container Working Directory
-      # working dir permissions workaround from https://github.com/actions/runner-images/issues/6775#issuecomment-1377299658
-        run: chown root:root .
-      - name: Set up Python
-        if: ${{ matrix.simulation-type == 'electric' }}
-        uses: actions/setup-python@v5
-        with:
-          # Disco needs python ~=3.10
-          python-version: '3.10'
+      # working dir permissions workaround from https://github.com/actions/runner-images/issues/6775s#issuecomment-1377299658
+        run: |
+          chown root:root .
       - name: Install Ruby dependencies
         run: |
+          which ruby
           ruby --version
           bundle update
           bundle exec certified-update
       - name: Install python dependencies
-        if: ${{ matrix.simulation-type == 'electric' || matrix.simulation-type == 'basic' }}
+        if: ${{ matrix.simulation-type == 'electric' || matrix.simulation-type == 'GHE' }}
         run: bundle exec rspec -e 'Install python dependencies'
       - name: Test project setup
         # We only need to run these tests once, not every matrix iteration.
@@ -66,6 +64,5 @@ jobs:
         if: failure()
         with:
           name: rspec_results
-          path: |
-            spec/test_directory**/
-          retention-days: 7 # save for 1 week before deleting
+          path: artifact.zip
+          retention-days: 7 # save for 1 week then delete

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Version 0.12.0
+Date Range: 02/08/2024 - 05/15/2024
+
+### Exciting New Features 🎉
+* Update CLI sub-commands to be consistent across commands by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/455
+* Update commands, paths, and example files for Reopt v3 by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/463
+### Other Changes
+* Update installer 0.11.1 by @tijcolem in https://github.com/urbanopt/urbanopt-cli/pull/452
+* adding rescue blocks to catch errors by @kflemin in https://github.com/urbanopt/urbanopt-cli/pull/454
+* update error handling for installing python and dependencies by @kflemin in https://github.com/urbanopt/urbanopt-cli/pull/458
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-cli/compare/v0.11.1...v0.12.0
+
+## Version 0.11.1
+Date Range: 01/26/2024 - 02/08/2024
+
+* Call GMT-cli correctly by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/449
+
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-cli/compare/v0.11.0...v0.11.1
+
 ## Version 0.11.0
 Date Range: 07/20/23 - 01/26/24
 

data/CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.10.2)
 cmake_policy(SET CMP0048 NEW)
 
-project(URBANoptCLI VERSION 0.10.0)
+project(URBANoptCLI VERSION 0.11.1)
 
 include(FindOpenStudioSDK.cmake)
 
@@ -89,16 +89,21 @@ 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-20230731-darwin.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "6dcaeb17c6567d5e5242c470b0ff2eb0")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240220-darwin.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "1f735d71eab98df9be7b72f9d5d8a940")
    else()
-     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20230731-linux.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "ff67d59a162288cb7e5d4632e970e53d")
+     if (ARCH MATCHES "arm64")
+       set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240220-linux-arm.tar.gz")
+       set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "ceb41bdd108a77bc43c6d260725a399f")
+     else() 
+       set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240220-linux.tar.gz")
+       set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "715c40a3bf59d539a18a03ad3932ca67")
+     endif()	
    endif()
 elseif(WIN32)
   if(CMAKE_CL_64)
-    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20230801-windows.tar.gz")
-    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "2293f9f07643d110a84afaa0c1049c03")
+    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240220-windows.tar.gz")
+    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "944c39e178651173a03efae1d99713e3")
   endif()
 endif()
 

data/FindOpenStudioSDK.cmake

@@ -1,6 +1,6 @@
 set(OPENSTUDIO_VERSION_MAJOR 3)
-set(OPENSTUDIO_VERSION_MINOR 6)
-set(OPENSTUDIO_VERSION_PATCH 1)
+set(OPENSTUDIO_VERSION_MINOR 7)
+set(OPENSTUDIO_VERSION_PATCH 0)
 set(OPENSTUDIO_VERSION "${OPENSTUDIO_VERSION_MAJOR}.${OPENSTUDIO_VERSION_MINOR}.${OPENSTUDIO_VERSION_PATCH}")
 
 find_package(openstudio "${OPENSTUDIO_VERSION}" CONFIG)
@@ -13,26 +13,31 @@ else()
 #  find_package(openstudio "${OPENSTUDIO_VERSION}" CONFIG REQUIRED)
 
 
-  set(OPENSTUDIO_BASELINK "https://openstudio-builds.s3.amazonaws.com/${OPENSTUDIO_VERSION}"
+  set(OPENSTUDIO_BASELINK "https://github.com/NREL/OpenStudio/releases/download/v${OPENSTUDIO_VERSION}"
     CACHE STRING "Base link to where the openstudio archives are hosted" FORCE)
 
-  set(OPENSTUDIO_VERSION_SHA "+bb9481519e")
+  set(OPENSTUDIO_VERSION_SHA "+d5269793f1")
 
   if(APPLE)
-    set(OPENSTUDIO_EXPECTED_HASH ba881908f683ec695c209399f261b299)
+    set(OPENSTUDIO_EXPECTED_HASH a4585ef0a3523168f8975ecd1cff1d12)
     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 5e67958249d99f96149b4d5576c3d0ef)
+      if (ARCH MATCHES "arm64")
+        set(OPENSTUDIO_EXPECTED_HASH d98b3d3d133a7c5bc1b9581553d23811)
+      else()
+        set(OPENSTUDIO_EXPECTED_HASH 1e48f36417d3d118d6a10f1a7d61f46e)
+      endif()
+      set(OPENSTUDIO_EXPECTED_HASH 5c006e5e66e5e859206a63626ea2966f)
       set(OPENSTUDIO_PLATFORM "Ubuntu-20.04-x86_64")
     else() # Assumes 20.04
-      set(OPENSTUDIO_EXPECTED_HASH 5e67958249d99f96149b4d5576c3d0ef)
+      set(OPENSTUDIO_EXPECTED_HASH 5c006e5e66e5e859206a63626ea2966f)
       set(OPENSTUDIO_PLATFORM "Ubuntu-20.04-x86_64")
     endif()
     set(OPENSTUDIO_EXT "tar.gz")
   elseif(WIN32)
-    set(OPENSTUDIO_EXPECTED_HASH 802f8cffeac24f011e636baf1e6ffd40)
+    set(OPENSTUDIO_EXPECTED_HASH f192860357fdbffb5705942a991b072b)
     set(OPENSTUDIO_PLATFORM "Windows")
     set(OPENSTUDIO_EXT "tar.gz")
   endif()

data/Gemfile

@@ -40,16 +40,16 @@ gem 'parser', '3.2.2.2'
 # 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'
+# gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'develop'
 # 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: 'develop'
+# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 # end
 
-#if allow_local && File.exist?('../urbanopt-rnm-us-gem')
+# if allow_local && File.exist?('../urbanopt-rnm-us-gem')
 # gem 'urbanopt-rnm-us', path: '../urbanopt-rnm-us-gem'
 # elsif allow_local
 #  gem 'urbanopt-rnm-us', github: 'URBANopt/urbanopt-rnm-us-gem', branch: 'develop'

data/bin/console

@@ -3,12 +3,5 @@
 require 'bundler/setup'
 require 'uo_cli'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require 'irb'
 IRB.start(__FILE__)

data/example_files/Gemfile

@@ -51,7 +51,7 @@ if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
 elsif allow_local
   gem 'openstudio-load-flexibility-measures', github: 'NREL/openstudio-load-flexibility-measures-gem', branch: 'develop'
 else
-   gem 'openstudio-load-flexibility-measures', '~> 0.8.0'
+  gem 'openstudio-load-flexibility-measures', '~> 0.8.0'
 end
 
 if allow_local && File.exist?('../openstudio-ee-gem')
@@ -78,7 +78,7 @@ else
   gem 'openstudio-geb', '~> 0.4.0'
 end
 
-if allow_local && File.exists?('../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'
@@ -94,5 +94,5 @@ if allow_local && File.exist?('../urbanopt-reporting-gem')
 elsif allow_local
   gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 else
-  gem 'urbanopt-reporting', '~> 0.9.1'
+  gem 'urbanopt-reporting', '~> 0.10.0'
 end

data/example_files/mappers/Baseline.rb

@@ -1105,6 +1105,6 @@ module URBANopt
 
         return osw
       end
-    end # end class
+    end
   end
 end

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

@@ -3,7 +3,6 @@
 # See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
 # *********************************************************************************
 
-
 def residential_template(args, template, climate_zone)
   '''Assign arguments from tsv files.'''
 
@@ -44,7 +43,6 @@ def residential_template(args, template, climate_zone)
     { args[:heating_system_type] => 'iecc/heating_system.tsv',
       args[:cooling_system_type] => 'iecc/cooling_system.tsv',
       args[:heat_pump_type] => 'iecc/heat_pump.tsv' }.each do |type, path|
-
       if type != 'none'
         filepath = File.join(File.dirname(__FILE__), path)
         lookup_tsv = get_lookup_tsv(args, filepath)

data/example_files/mappers/residential/util.rb

@@ -3,7 +3,6 @@
 # See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
 # *********************************************************************************
 
-
 def residential(scenario, feature, args, building_type)
   '''Assign arguments from geojson file.'''
 

data/example_files/measures/BuildResidentialModel/measure.rb

@@ -125,7 +125,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
 
       standards_number_of_living_units = units.size
     else
-      xml_building_folder = "xml_building"
+      xml_building_folder = 'xml_building'
       hpxml_dir = File.join(File.dirname(__FILE__), "../../#{xml_building_folder}/#{args[:hpxml_dir]}")
 
       if !File.exist?(hpxml_dir)
@@ -158,7 +158,6 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
 
     hpxml_path = File.expand_path(args[:hpxml_path])
     units.each_with_index do |unit, unit_num|
-
       measures = {}
       if !unit.key?('hpxml_path') # create a single new HPXML file describing all dwelling units of the feature
 
@@ -167,7 +166,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
         check_file_exists(full_measure_path, runner)
 
-        measure_args = args.clone.collect { |k, v| [k.to_s, v] }.to_h
+        measure_args = args.clone.transform_keys(&:to_s)
         measure_args['hpxml_path'] = hpxml_path
         if unit_num > 0
           measure_args['existing_hpxml_path'] = hpxml_path
@@ -208,7 +207,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         FileUtils.cp(File.expand_path(unit['hpxml_path']), hpxml_path)
 
       end
-    end # end units.each_with_index do |unit, unit_num|
+    end
 
     # call BuildResidentialScheduleFile / HPXMLtoOpenStudio after HPXML file is created
     measures = {}

data/example_files/measures/BuildResidentialModel/tests/test_build_residential_model.rb

@@ -10,7 +10,7 @@ require_relative '../../../mappers/residential/util'
 require_relative '../../../mappers/residential/template//util'
 require 'openstudio'
 require 'openstudio/measure/ShowRunnerOutput'
-require_relative '../measure.rb'
+require_relative '../measure'
 require 'csv'
 
 class BuildResidentialModelTest < Minitest::Test
@@ -21,14 +21,14 @@ class BuildResidentialModelTest < Minitest::Test
     FileUtils.mkdir_p(@run_path)
 
     @args = {}
-    _initialize_arguments()
+    _initialize_arguments
   end
 
   def teardown
     FileUtils.rm_rf(@run_path)
   end
 
-  def _initialize_arguments()
+  def _initialize_arguments
     # BuildResidentialModel arguments
     @args[:hpxml_path] = @hpxml_path
     @args[:output_dir] = @run_path
@@ -77,7 +77,7 @@ class BuildResidentialModelTest < Minitest::Test
 
     @args[:geometry_building_num_units] = 4
 
-    _test_measure()
+    _test_measure
   end
 
   def test_schedules_type
@@ -88,8 +88,8 @@ class BuildResidentialModelTest < Minitest::Test
     schedules_types.each do |schedules_type|
       @args[:schedules_type] = schedules_type
 
-      _apply_residential()
-      _test_measure()
+      _apply_residential
+      _test_measure
     end
   end
 
@@ -118,7 +118,7 @@ class BuildResidentialModelTest < Minitest::Test
             end
           end
 
-          _apply_residential()
+          _apply_residential
           _test_measure(expected_errors: expected_errors)
         end
       end
@@ -157,7 +157,7 @@ class BuildResidentialModelTest < Minitest::Test
               end
             end
 
-            _apply_residential()
+            _apply_residential
             _test_measure(expected_errors: expected_errors)
           end
         end
@@ -182,8 +182,8 @@ class BuildResidentialModelTest < Minitest::Test
           @args[:geometry_building_num_units] = feature_number_of_residential_units
           @number_of_bedrooms = feature_number_of_bedrooms
 
-          _apply_residential()
-          _test_measure()
+          _apply_residential
+          _test_measure
         end
       end
     end
@@ -210,8 +210,8 @@ class BuildResidentialModelTest < Minitest::Test
             @args[:geometry_building_num_units] = feature_number_of_residential_units
             @number_of_occupants = feature_number_of_occupants
 
-            _apply_residential()
-            _test_measure()
+            _apply_residential
+            _test_measure
           end
         end
       end
@@ -244,7 +244,7 @@ class BuildResidentialModelTest < Minitest::Test
             expected_errors = ['Conditioned basement/crawlspace foundation type for apartment units is not currently supported.']
           end
 
-          _apply_residential()
+          _apply_residential
           _test_measure(expected_errors: expected_errors)
         end
       end
@@ -264,8 +264,8 @@ class BuildResidentialModelTest < Minitest::Test
         @system_type = feature_system_type
         @heating_system_fuel_type = feature_heating_system_fuel_type
 
-        _apply_residential()
-        _test_measure()
+        _apply_residential
+        _test_measure
       end
     end
   end
@@ -278,17 +278,17 @@ class BuildResidentialModelTest < Minitest::Test
 
     feature_templates.each do |feature_template|
       @args = {}
-      _initialize_arguments()
+      _initialize_arguments
 
       @template = feature_template
 
-      _apply_residential()
-      _apply_residential_template()
-      _test_measure()
+      _apply_residential
+      _apply_residential_template
+      _test_measure
     end
   end
 
-  def _apply_residential()
+  def _apply_residential
     residential_simulation(@args, @timestep, @run_period, @calendar_year, @weather_filename)
     residential_geometry_unit(@args, @building_type, @floor_area, @number_of_bedrooms, @geometry_unit_orientation, @geometry_unit_aspect_ratio, @occupancy_calculation_type, @number_of_occupants, @maximum_roof_height)
     residential_geometry_foundation(@args, @foundation_type)
@@ -299,7 +299,7 @@ class BuildResidentialModelTest < Minitest::Test
     residential_appliances(@args)
   end
 
-  def _apply_residential_template()
+  def _apply_residential_template
     residential_template(@args, @template, @climate_zone)
   end
 
@@ -317,7 +317,7 @@ class BuildResidentialModelTest < Minitest::Test
     # populate argument with specified hash value if specified
     arguments.each do |arg|
       temp_arg_var = arg.clone
-      if @args.has_key?(arg.name.to_sym)
+      if @args.key?(arg.name.to_sym)
         assert(temp_arg_var.setValue(@args[arg.name.to_sym]))
       end
       argument_map[arg.name] = temp_arg_var
@@ -332,7 +332,7 @@ class BuildResidentialModelTest < Minitest::Test
       # show_output(result) unless result.value.valueName == 'Fail'
       assert_equal('Fail', result.value.valueName)
 
-      error_msgs = result.errors.map { |x| x.logMessage }
+      error_msgs = result.errors.map(&:logMessage)
       expected_errors.each do |expected_error|
         assert_includes(error_msgs, expected_error)
       end

data/example_files/python_deps/dependencies.json

@@ -1,6 +1,6 @@
 [
-  { "name": "ThermalNetwork", "version": "0.2.3"},
-  { "name": "urbanopt-ditto-reader", "version": "0.6.3"},
-  { "name": "NREL-disco", "version": "0.5.0"},
-  { "name": "geojson-modelica-translator", "version": "0.6.0"}
+  { "name": "ThermalNetwork", "version": "0.2.5"},
+  { "name": "urbanopt-ditto-reader", "version": "0.6.4"},
+  { "name": "NREL-disco", "version": "0.5.1"},
+  { "name": "geojson-modelica-translator", "version": "0.7.0"}
 ]

data/example_files/python_deps/install_python.ps1

@@ -39,7 +39,7 @@ function Get-Python {
         Remove-Item $path
     }
     if ($result.ExitCode -ne 0) {
-        $msg = "Failed to run Python installer: ExitCode=${result.ExitCode}" 
+        $msg = "Failed to run Python installer: ExitCode=${result.ExitCode}"
         Write-Error $msg
         exit $result.ExitCode
     }