Upgrade to OpenStudio 3.9 and Ruby 3.2.2

.github/workflows/nightly_ci_build.yml

@@ -19,17 +19,16 @@ jobs:
     # https://github.com/rbenv/ruby-build/discussions/1940
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
       - name: set git config options
         shell: bash
-        run: |
-          git config --global --add safe.directory '*'
+        run: git config --global --add safe.directory '*'
       - name: Update gems
         run: |
+          bundle install
           bundle update
-          bundle exec certified-update
       - name: Run Rspec
         run: bundle exec rspec
       - name: Coveralls

.gitignore

@@ -16,7 +16,7 @@
 /lib/measures/test_results
 /lib/measures/.rubocop*
 # test files
-spec/files/run/baseline_scenario_ghe/reopt_ghp
+spec/files/run/baseline_scenario_ghe/reopt_ghp/
 
 developer_nrel_key.rb
 # rspec failure tracking

CHANGELOG.md

@@ -1,12 +1,29 @@
 # URBANopt REopt Gem
 
+## Version 1.0.0
+
+## What's Changed
+
+* Upgrade to OpenStudio 3.9 and Ruby 3.2.2 by @vtnate in https://github.com/urbanopt/urbanopt-reopt-gem/pull/155
+* Updates for REopt v3.11 by @vtnate in https://github.com/urbanopt/urbanopt-reopt-gem/pull/157
+
+### Other Changes
+
+* expose error messages for certificate verify failed by @kflemin in https://github.com/urbanopt/urbanopt-reopt-gem/pull/151
+* REopt GHP LCCA Analysis by @tanushree04 in https://github.com/urbanopt/urbanopt-reopt-gem/pull/153
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-reopt-gem/compare/v0.12.0...v1.0.0
+
 ## Version 0.12.0
+
 Date Range: 01/11/24 - 05/06/24
+
 * Use Reopt v3 by @vtnate in https://github.com/urbanopt/urbanopt-reopt-gem/pull/149
 
 **Full Changelog**: https://github.com/urbanopt/urbanopt-reopt-gem/compare/v0.11.0...v0.12.0
 
 ## Version 0.11.0
+
 Date Range: 07/06/23 - 01/11/24
 
 * Use different error messages in different places by @vtnate in https://github.com/urbanopt/urbanopt-reopt-gem/pull/145
@@ -17,6 +34,7 @@ Date Range: 07/06/23 - 01/11/24
 **Full Changelog**: https://github.com/urbanopt/urbanopt-reopt-gem/compare/v0.10.0...v0.11.0
 
 ## Version 0.10.0
+
 Date Range: 12/13/22 - 7/6/23
 
 - Update dependencies for OpenStudio 3.6.1

Gemfile

@@ -17,7 +17,9 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../OpenStudio-extension-gem')
 #   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
 # elsif allow_local
-#   gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+# gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+# else
+# gem 'openstudio-extension', '~> 0.8.1'
 # end
 #
 # if allow_local && File.exist?('../openstudio-common-measures-gem')
@@ -41,14 +43,17 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-model-articulation', '0.1.0'
 # 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: 'reopt-v3'
-# 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: 'develop'
+end
 
-# if allow_local && File.exists?('../urbanopt-geojson-gem')
-#   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
-# elsif allow_local
-#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
-# end
+# Temporary! Remove this once reporting-gem is merged/released
+# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+
+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'
+end

LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
 
   # Redistribution and use in source and binary forms, with or without modification,

docs/schemas/reopt-output-schema.md

@@ -1,6 +1,6 @@
 # REopt Lite Outputs Schema
 
-When the gem calls the REopt Lite APUI it recieves the following complete set of results described in the data dictionary below. Only those needed to update a Feature or Scenario Report's distributed_generation attibute set and timeseries CSV are pulled from the reponse and transferred to the Feature or Scenario Report. You may choose to modify the code to include more or less of the full REopt Lite response.
+When the gem calls the REopt Lite APUI it receives the following complete set of results described in the data dictionary below. Only those needed to update a Feature or Scenario Report's distributed_generation attribute set and timeseries CSV are pulled from the response and transferred to the Feature or Scenario Report. You may choose to modify the code to include more or less of the full REopt Lite response.
 
 ## Data Dictionary
 <ReoptOutputSchema />

lib/urbanopt/reopt/feature_report_adapter.rb

@@ -41,9 +41,9 @@ def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil,
         else
           @@logger.info('Using default REopt assumptions')
           reopt_inputs = {
-            Settings:{},
+            Settings: {},
             Site: {},
-            Financial:{},
+            Financial: {},
             ElectricTariff: {
               monthly_demand_rates: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
               monthly_energy_rates: [0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13]
@@ -158,7 +158,6 @@ def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil,
       # [*return:*] _URBANopt::Reporting::DefaultReports::FeatureReport_ - Returns an updated FeatureReport.
       ##
       def update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil, resilience_stats = nil)
-
         # Check if the \REopt response is valid
         if reopt_output['status'] != 'optimal'
           @@logger.error("ERROR cannot update Feature Report #{feature_report.name} #{feature_report.id}  - REopt optimization was non-optimal")
@@ -439,15 +438,15 @@ def modrow(x, i) # :nodoc:
           x[$storage_to_grid_col] = $storage_to_grid[i] || 0 if defined?(storage)
           x[$storage_soc_col] = $storage_soc[i] || 0 if defined?(storage)
           x[$generator_total_col] = $generator_total[i] || 0 if defined?(generator)
-          x[$generator_to_battery_col] = $generator_to_battery[i] || 0 if (defined?(generator) && defined?(storage))
+          x[$generator_to_battery_col] = $generator_to_battery[i] || 0 if defined?(generator) && defined?(storage)
           x[$generator_to_load_col] = $generator_to_load[i] || 0 if defined?(generator)
           x[$generator_to_grid_col] = $generator_to_grid[i] || 0 if defined?(generator)
           x[$pv_total_col] = $pv_total[i] || 0
           x[$pv_to_battery_col] = $pv_to_battery[i] || 0 if defined?(storage)
           x[$pv_to_load_col] = $pv_to_load[i] || 0
           x[$pv_to_grid_col] = $pv_to_grid[i] || 0
           x[$wind_total_col] = $wind_total[i] || 0 if defined?(wind)
-          x[$wind_to_battery_col] = $wind_to_battery[i] || 0 if (defined?(wind) && defined?(storage))
+          x[$wind_to_battery_col] = $wind_to_battery[i] || 0 if defined?(wind) && defined?(storage)
           x[$wind_to_load_col] = $wind_to_load[i] || 0 if defined?(wind)
           x[$wind_to_grid_col] = $wind_to_grid[i] || 0 if defined?(wind)
           return x

lib/urbanopt/reopt/reopt_ghp_adapter.rb

@@ -10,7 +10,7 @@ class REoptGHPAdapter
       def initialize
         # initialize @@logger
         @@logger ||= URBANopt::REopt.reopt_logger
-        # Define class variable 
+        # Define class variable
         @@hours_in_year = 8760
       end
 
@@ -247,7 +247,8 @@ def create_reopt_input_district(run_dir, system_parameter_hash, reopt_ghp_assump
         # This is not used in REopt calculation but required for formatting.
         reopt_inputs_district[:DomesticHotWaterLoad][:fuel_loads_mmbtu_per_hour] = [0.0000001]*@@hours_in_year
 
-        reopt_inputs_district[:ElectricLoad] = {}
+        # Adding year for ElectricLoad so district electric load can be calculated with REopt API v3.11
+        reopt_inputs_district[:ElectricLoad] = {:year => 2017}
         #required for reopt formatting
         reopt_inputs_district[:ElectricLoad][:loads_kw] = [0.00001]*@@hours_in_year
 

lib/urbanopt/reopt/reopt_ghp_api.rb

@@ -8,7 +8,6 @@
 require 'uri'
 require 'json'
 require 'securerandom'
-require 'certified'
 require_relative '../../../developer_nrel_key'
 require 'urbanopt/reopt/reopt_logger'
 

lib/urbanopt/reopt/reopt_ghp_files/reopt_ghp_assumption.json

@@ -5,19 +5,20 @@
     },
     "SpaceHeatingLoad": {
     },
-    "DomesticHotWaterLoad": {    
+    "DomesticHotWaterLoad": {
     },
-    "ElectricLoad": {    
+    "ElectricLoad": {
+        "year": 2017
     },
     "ElectricTariff": {
-        "urdb_label": "594976725457a37b1175d089"   
+        "urdb_label": "594976725457a37b1175d089"
     },
     "GHP":{
         "installed_cost_heatpump_per_ton": 1075,
         "installed_cost_ghx_per_ft": 14,
         "installed_cost_building_hydronic_loop_per_sqft": 1.7,
         "om_cost_per_sqft_year": 0,
-        "macrs_bonus_fraction": 0.6, 
+        "macrs_bonus_fraction": 0.6,
         "macrs_itc_reduction": 0.5,
         "federal_itc_fraction": 0.3
     },

lib/urbanopt/reopt/reopt_ghp_post_processor.rb

@@ -13,7 +13,6 @@
 module URBANopt # :nodoc:
   module REopt # :nodoc:
     class REoptGHPPostProcessor
-
       def initialize(run_dir, system_parameter, modelica_result, reopt_ghp_assumptions = nil, nrel_developer_key = nil, localhost)
         # initialize @@logger
         @@logger ||= URBANopt::REopt.reopt_logger
@@ -42,11 +41,11 @@ def initialize(run_dir, system_parameter, modelica_result, reopt_ghp_assumptions
           File.open(system_parameter, 'r') do |file|
             @system_parameter_input_hash = JSON.parse(file.read, symbolize_names: true)
           end
-          #Determine loop order
+          # Determine loop order
           loop_order = File.join(File.dirname(system_parameter), '_loop_order.json')
           if File.exist?(loop_order)
             File.open(loop_order, 'r') do |file|
-              loop_order_input= JSON.parse(file.read, symbolize_names: true)
+              loop_order_input = JSON.parse(file.read, symbolize_names: true)
               # Check the type of the parsed data
               if loop_order_input.is_a?(Array)
                 @loop_order_input_hash = loop_order_input
@@ -61,7 +60,7 @@ def initialize(run_dir, system_parameter, modelica_result, reopt_ghp_assumptions
                   puts "GHE IDs in group: #{item[:list_ghe_ids_in_group].inspect}"
                 end
               else
-                puts "Unexpected JSON structure"
+                puts 'Unexpected JSON structure'
               end
             end
           end
@@ -77,7 +76,6 @@ def initialize(run_dir, system_parameter, modelica_result, reopt_ghp_assumptions
 
       # # Create REopt input and output building report
       def run_reopt_lcca(system_parameter_hash: nil, reopt_ghp_assumptions_hash: nil, modelica_result: nil)
-
         adapter = URBANopt::REopt::REoptGHPAdapter.new
 
         # if these arguments are specified, use them
@@ -89,22 +87,21 @@ def run_reopt_lcca(system_parameter_hash: nil, reopt_ghp_assumptions_hash: nil,
           @reopt_ghp_assumptions_input_hash = reopt_ghp_assumptions_hash
         end
 
-
         if !modelica_result.nil?
           @modelica_result_input = modelica_result
         end
 
         # Create folder for REopt input files only if they dont exist
-        reopt_ghp_dir = File.join(@run_dir, "reopt_ghp")
-        reopt_ghp_input = File.join(reopt_ghp_dir, "reopt_ghp_inputs")
+        reopt_ghp_dir = File.join(@run_dir, 'reopt_ghp')
+        reopt_ghp_input = File.join(reopt_ghp_dir, 'reopt_ghp_inputs')
         unless Dir.exist?(reopt_ghp_dir)
           FileUtils.mkdir_p(reopt_ghp_dir)
         end
         unless Dir.exist?(reopt_ghp_input)
           FileUtils.mkdir_p(reopt_ghp_input)
         end
 
-        reopt_ghp_output = File.join(reopt_ghp_dir, "reopt_ghp_outputs")
+        reopt_ghp_output = File.join(reopt_ghp_dir, 'reopt_ghp_outputs')
         unless Dir.exist?(reopt_ghp_output)
           FileUtils.mkdir_p(reopt_ghp_output)
         end
@@ -142,14 +139,11 @@ def run_reopt_lcca(system_parameter_hash: nil, reopt_ghp_assumptions_hash: nil,
 
           # reopt_ghp_output_file
           reopt_output_file = File.join(reopt_ghp_output, "#{base_name}_output.json")
-          #call the REopt API
+          # call the REopt API
           api = URBANopt::REopt::REoptLiteGHPAPI.new(reopt_input_data, DEVELOPER_NREL_KEY, reopt_output_file, @localhost)
-          api.get_api_results()
-
+          api.get_api_results
         end
-
       end
-
-    end #REoptGHPPostProcessor
-  end #REopt
-end #URBANopt
+    end # REoptGHPPostProcessor
+  end # REopt
+end # URBANopt

lib/urbanopt/reopt/reopt_lite_api.rb

@@ -8,7 +8,6 @@
 require 'uri'
 require 'json'
 require 'securerandom'
-require 'certified'
 require_relative '../../../developer_nrel_key'
 require 'urbanopt/reopt/reopt_logger'
 
@@ -116,7 +115,7 @@ def make_request(http, req, max_tries = 3)
             if tries + 1 < max_tries
               @@logger.debug('trying again...')
             else
-              @@logger.debug('max tries reached!')
+              @@logger.warn('max tries reached!')
               return result
             end
             tries += 1

lib/urbanopt/reopt/reopt_post_processor.rb

@@ -33,7 +33,6 @@ def initialize(scenario_report, scenario_reopt_assumptions_file = nil, reopt_fea
         end
         @nrel_developer_key = nrel_developer_key
         @localhost = localhost
-        @reopt_base_post = { ElectricTariff: {}, ElectricLoad: {}, Wind: { max_kw: 0 } }
 
         @scenario_reopt_default_output_file = nil
         @scenario_timeseries_default_output_file = nil

lib/urbanopt/reopt/reopt_schema/REopt-GHP-input.json

@@ -44,7 +44,7 @@
         },
         "building_sqft": {
             "type": "float",
-            "requierd": true,
+            "required": true,
             "description": "to calculate cost of hydronic loop",
             "note": "for the GHX iteration, set building_sqft to a number close to 0 but not exactly 0"
         },
@@ -69,7 +69,7 @@
                 "number_of_boreholes": {
                     "type": "int",
                     "required": true,
-                    "note": "in the GHP iteration, set this value to 0"    
+                    "note": "in the GHP iteration, set this value to 0"
                 },
                 "length_boreholes_ft": {
                     "type": "float",
@@ -146,4 +146,3 @@
         }
     }
 }
-