From 02ba75d24e9afdcf1464279cd6cc0b4eef0cf827 Mon Sep 17 00:00:00 2001 From: kflemin <2205659+kflemin@users.noreply.github.com> Date: Fri, 28 Jun 2024 21:34:08 -0600 Subject: [PATCH 01/25] add emission factor details --- lib/measures/default_feature_reports/measure.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/measures/default_feature_reports/measure.rb b/lib/measures/default_feature_reports/measure.rb index 34bde92..4bf211c 100644 --- a/lib/measures/default_feature_reports/measure.rb +++ b/lib/measures/default_feature_reports/measure.rb @@ -932,9 +932,11 @@ def run(runner, user_arguments) conv_kbtu_J = 1054852.32 # KBtu to J (1kBtu = 1054852.32 J) ##### Emisison factors for natural gas, propane, and fuel oil based on https://portfoliomanager.energystar.gov/pdf/reference/Emissions.pdf + ## Emission factors are based on EPA eGRID data and calculated using a 100-year global warming potential (GWP) horizon based on ASHRAE 189.1 ## natural gas : 181.7 KG/MWH ## propane : 219.2 KG/MWH ## Fuel oil #1: 250.8 KG/MWH + ## Fuel oil #2: 253.2 KG/MWH nat_gas_val = 181.7 lpg_val = 219.2 fo1_val = 250.8 From 6657e2dd45e609723ffa3c7f8834d48a27ab1c0d Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:43:26 -0600 Subject: [PATCH 02/25] bump to v0.11.0 --- lib/urbanopt/reporting/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/urbanopt/reporting/version.rb b/lib/urbanopt/reporting/version.rb index 6302de4..081da51 100644 --- a/lib/urbanopt/reporting/version.rb +++ b/lib/urbanopt/reporting/version.rb @@ -5,6 +5,6 @@ module URBANopt module Reporting - VERSION = '0.10.1'.freeze + VERSION = '0.11.0'.freeze end end From 83df414b8855c46d1d309146bd8642e81597cd82 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:51:33 -0600 Subject: [PATCH 03/25] upgrade to ruby 3.2.2 and bump dependency versions --- urbanopt-reporting-gem.gemspec | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 659af3a..59042a8 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -21,15 +21,15 @@ Gem::Specification.new do |spec| spec.bindir = 'exe' spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } spec.require_paths = ['lib'] - spec.required_ruby_version = '~> 2.7.0' + spec.required_ruby_version = '~> 3.2' - spec.add_development_dependency 'bundler', '~> 2.1' - spec.add_development_dependency 'rake', '~> 13.1' - spec.add_development_dependency 'rspec', '~> 3.12' - spec.add_development_dependency 'simplecov', '~> 0.18.2' - spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0' + spec.add_development_dependency 'bundler', '~> 2.4.10' + spec.add_development_dependency 'rake', '~> 13.2' + spec.add_development_dependency 'rspec', '~> 3.13' + spec.add_development_dependency 'simplecov', '0.22.0' + spec.add_development_dependency 'simplecov-lcov', '0.8.0' spec.add_runtime_dependency 'json_pure', '~> 2.3' spec.add_runtime_dependency 'json-schema', '~> 2.7' - spec.add_dependency 'openstudio-extension', '~> 0.7.1' + spec.add_dependency 'openstudio-extension', '~> 0.8.0' end From 34bf21ebd941d91f7aeeeaa73a0fad2b62554f4a Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:51:48 -0600 Subject: [PATCH 04/25] experiment with not pinning problem dependencies --- Gemfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 0ae8b80..7d4f791 100644 --- a/Gemfile +++ b/Gemfile @@ -12,11 +12,11 @@ gemspec allow_local = ENV['FAVOR_LOCAL_GEMS'] # pin this dependency to avoid unicode_normalize error -gem 'addressable', '2.8.1' +# gem 'addressable', '2.8.1' # pin this dependency to avoid using racc dependency (which has native extensions) -gem 'parser', '3.2.2.2' +# gem 'parser', '3.2.2.2' # pin this dependency because 2.9.2 breaks OS tests (openstudio:test_with_openstudio) -gem 'regexp_parser', '2.9.0' +# gem 'regexp_parser', '2.9.0' # if allow_local && File.exist?('../openstudio-extension-gem') # gem 'openstudio-extension', path: '../openstudio-extension-gem' From 5c0e213e92a62fc2bdf41ac131c1733d16210bdd Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:51:57 -0600 Subject: [PATCH 05/25] use OS3.8 in CI --- .github/workflows/nightly_ci_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index af4ac75..ba0e9a6 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -21,7 +21,7 @@ jobs: weeknight-tests: runs-on: ubuntu-latest container: - image: docker://nrel/openstudio:3.7.0 + image: docker://nrel/openstudio:3.8.0 steps: - uses: actions/checkout@v4 - name: set git config options From 9ff584a500c7df6fe3a141a315aa00b9d4f6b79c Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:52:28 -0600 Subject: [PATCH 06/25] update measures --- lib/measures/default_feature_reports/measure.xml | 6 +++--- lib/measures/export_time_series_modelica/measure.xml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/measures/default_feature_reports/measure.xml b/lib/measures/default_feature_reports/measure.xml index f99d23e..186a86a 100644 --- a/lib/measures/default_feature_reports/measure.xml +++ b/lib/measures/default_feature_reports/measure.xml @@ -3,8 +3,8 @@ 3.1 default_feature_reports 9ee3135a-8070-4408-bfa1-b75fecf9dd4f - 1f0dd70a-ddad-4bb8-a54b-0aeb696e80d0 - 2024-06-20T19:28:12Z + 43be79bc-ba24-44e0-923f-3f618951a054 + 2024-07-16T17:52:08Z FB304155 DefaultFeatureReports DefaultFeatureReports @@ -128,7 +128,7 @@ measure.rb rb script - 005CDD6D + 2B9D1AAE USA_CO_Golden-NREL.724666_TMY3.epw diff --git a/lib/measures/export_time_series_modelica/measure.xml b/lib/measures/export_time_series_modelica/measure.xml index 078896b..302a19f 100644 --- a/lib/measures/export_time_series_modelica/measure.xml +++ b/lib/measures/export_time_series_modelica/measure.xml @@ -3,8 +3,8 @@ 3.1 export_time_series_loads_csv 9fcf6116-c2eb-43d6-93f0-e1bdd822f768 - 0b134568-d3a8-4ede-bf22-2010a173ea97 - 2024-01-08T22:54:07Z + 8bd4bc8e-f597-47f9-82b9-044a06977bb1 + 2024-07-16T17:52:07Z 9BF1E6AC ExportTimeSeriesLoadsCSV ExportTimeSeriesLoadsCSV @@ -111,7 +111,7 @@ measure.rb rb script - EC8615DF + EB4FBA91 os_lib_helper_methods.rb From 56d5a55767ef24bbe4e20534b8a15d6cdc48357a Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:53:01 -0600 Subject: [PATCH 07/25] add `.coverage` to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 90224ba..3c3a261 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ /lib/measures/*/tests/output out.txt .rubocop*s3* +.coverage # rspec failure tracking .rspec_status From 2e5fd077861e309d7ee246f8398f0ddc77fd8117 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 16 Jul 2024 11:55:24 -0600 Subject: [PATCH 08/25] changelog --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 31ad8f8..6ad8f07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # URBANopt Reporting Gem +## Version 0.11.0 +* Upgrade to OpenStudio 3.8 & Ruby 3.2 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/154 + +**Full Changelog**: https://github.com/urbanopt/urbanopt-reporting-gem/compare/v0.10.1...v0.11.0 + ## Version 0.10.1 * Other Fuel emission factors update by @rawadelkontar in https://github.com/urbanopt/urbanopt-reporting-gem/pull/153 From 341726b4e220e278ba74880719d28f87fdf760a4 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 18 Jul 2024 10:26:55 -0600 Subject: [PATCH 09/25] clarify ruby version, remove duplicate dependencies --- urbanopt-reporting-gem.gemspec | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 59042a8..bf82c64 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -21,10 +21,10 @@ Gem::Specification.new do |spec| spec.bindir = 'exe' spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } spec.require_paths = ['lib'] - spec.required_ruby_version = '~> 3.2' + # We support exactly Ruby v3.2.2 because os-extension requires bundler==2.4.10 and that requires Ruby 3.2.2: https://stdgems.org/bundler/ + # It would be nice to be able to use newer patches of Ruby 3.2, which would require os-extension to relax its dependency on bundler. + spec.required_ruby_version = '3.2.2' - spec.add_development_dependency 'bundler', '~> 2.4.10' - spec.add_development_dependency 'rake', '~> 13.2' spec.add_development_dependency 'rspec', '~> 3.13' spec.add_development_dependency 'simplecov', '0.22.0' spec.add_development_dependency 'simplecov-lcov', '0.8.0' From ff0121361284943768a70969ea99dbd01070e7aa Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Mon, 22 Jul 2024 10:07:26 -0600 Subject: [PATCH 10/25] WIP: use extension-gem branch. Might not be necessary in this gem --- Gemfile | 2 +- urbanopt-reporting-gem.gemspec | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 7d4f791..5647a04 100644 --- a/Gemfile +++ b/Gemfile @@ -21,5 +21,5 @@ 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: 'dont_raise_when_mistmatch' # end diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index bf82c64..eab2966 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'json_pure', '~> 2.3' spec.add_runtime_dependency 'json-schema', '~> 2.7' - spec.add_dependency 'openstudio-extension', '~> 0.8.0' + # spec.add_dependency 'openstudio-extension', '~> 0.8.0' end From ed6e1df3f27b5bdd786cdc719ac96c15da622b1a Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 25 Jul 2024 14:59:25 -0600 Subject: [PATCH 11/25] bump json-schema to 4.3.1 & json_pure to 2.7 --- urbanopt-reporting-gem.gemspec | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index eab2966..54d0c38 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -29,7 +29,7 @@ Gem::Specification.new do |spec| spec.add_development_dependency 'simplecov', '0.22.0' spec.add_development_dependency 'simplecov-lcov', '0.8.0' - spec.add_runtime_dependency 'json_pure', '~> 2.3' - spec.add_runtime_dependency 'json-schema', '~> 2.7' + spec.add_runtime_dependency 'json_pure', '~> 2.7' + spec.add_runtime_dependency 'json-schema', '~> 4.3.1' # spec.add_dependency 'openstudio-extension', '~> 0.8.0' end From 1c815f8b1ec41951ca92fd8fa072c3184dd3804e Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Tue, 30 Jul 2024 13:23:17 -0400 Subject: [PATCH 12/25] use newly released patch version 0.8.1 of extension-gem --- Gemfile | 3 ++- urbanopt-reporting-gem.gemspec | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 5647a04..7b6a84e 100644 --- a/Gemfile +++ b/Gemfile @@ -21,5 +21,6 @@ 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: 'dont_raise_when_mistmatch' + # gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop' +# gem 'openstudio-extension', '~> 0.8.1' # end diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 54d0c38..6f0de8f 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'json_pure', '~> 2.7' spec.add_runtime_dependency 'json-schema', '~> 4.3.1' - # spec.add_dependency 'openstudio-extension', '~> 0.8.0' + spec.add_dependency 'openstudio-extension', '~> 0.8.1' end From 155b1a3b19722dc17063104b4c165603991deefa Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 5 Sep 2024 10:08:37 -0600 Subject: [PATCH 13/25] restore pinned dependencies to make OS happy --- Gemfile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Gemfile b/Gemfile index 7b6a84e..99b611f 100644 --- a/Gemfile +++ b/Gemfile @@ -11,16 +11,16 @@ gemspec # checkout the latest version (develop) from github. allow_local = ENV['FAVOR_LOCAL_GEMS'] -# pin this dependency to avoid unicode_normalize error -# gem 'addressable', '2.8.1' +# pin this dependency to avoid unicode_normalize error (openstudio:test_with_openstudio) +gem 'addressable', '2.8.1' # pin this dependency to avoid using racc dependency (which has native extensions) # gem 'parser', '3.2.2.2' # pin this dependency because 2.9.2 breaks OS tests (openstudio:test_with_openstudio) -# gem 'regexp_parser', '2.9.0' +gem 'regexp_parser', '2.9.0' # 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' # gem 'openstudio-extension', '~> 0.8.1' # end From 1541142f8d0632316807ba10cf10a6db51fbe178 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 5 Sep 2024 10:20:01 -0600 Subject: [PATCH 14/25] `bundle install` during CI instead of `bundle update` --- .github/workflows/nightly_ci_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index ba0e9a6..bc2ea1b 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -31,7 +31,7 @@ jobs: - name: Update gems run: | ruby --version - bundle update + bundle install - name: List OpenStudio measures run: bundle exec rake openstudio:list_measures - name: Update OpenStudio measures From c1bf824b8c2b056c8c1323683f469027d705b6db Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 5 Sep 2024 10:25:31 -0600 Subject: [PATCH 15/25] add another `bundle install` to have the bundle actually install --- .github/workflows/nightly_ci_build.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index bc2ea1b..8ffe8dc 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -26,8 +26,7 @@ jobs: - 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: | ruby --version @@ -35,7 +34,9 @@ jobs: - name: List OpenStudio measures run: bundle exec rake openstudio:list_measures - name: Update OpenStudio measures - run: bundle exec rake openstudio:update_measures + run: | + bundle install + bundle exec rake openstudio:update_measures - name: Test OpenStudio measures run: bundle exec rake openstudio:test_with_openstudio - name: Run Rspec From 4480acac727caefb03048d16288e32b0b348df18 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 13 Nov 2024 11:43:23 -0700 Subject: [PATCH 16/25] work with OS 3.9 --- .github/workflows/nightly_ci_build.yml | 5 ++--- Gemfile | 4 ---- urbanopt-reporting-gem.gemspec | 2 +- 3 files changed, 3 insertions(+), 8 deletions(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index 8ffe8dc..f06a858 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -1,14 +1,12 @@ name: Reporting-gem CI on: - # push: + push: workflow_dispatch: schedule: # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule # 5 am UTC (11pm MDT the day before) every weekday night in MDT - cron: '22 5 * * 2-6' - pull_request: - types: [review_requested] env: # This env var should enforce develop branch of all dependencies @@ -31,6 +29,7 @@ jobs: run: | ruby --version bundle install + bundle update - name: List OpenStudio measures run: bundle exec rake openstudio:list_measures - name: Update OpenStudio measures diff --git a/Gemfile b/Gemfile index 99b611f..57e15d6 100644 --- a/Gemfile +++ b/Gemfile @@ -13,10 +13,6 @@ allow_local = ENV['FAVOR_LOCAL_GEMS'] # pin this dependency to avoid unicode_normalize error (openstudio:test_with_openstudio) gem 'addressable', '2.8.1' -# pin this dependency to avoid using racc dependency (which has native extensions) -# gem 'parser', '3.2.2.2' -# pin this dependency because 2.9.2 breaks OS tests (openstudio:test_with_openstudio) -gem 'regexp_parser', '2.9.0' # if allow_local && File.exist?('../openstudio-extension-gem') # gem 'openstudio-extension', path: '../openstudio-extension-gem' diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 6f0de8f..38bf635 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'json_pure', '~> 2.7' spec.add_runtime_dependency 'json-schema', '~> 4.3.1' - spec.add_dependency 'openstudio-extension', '~> 0.8.1' + spec.add_dependency 'openstudio-extension', '~> 0.8.2' end From 96f883dcc45ef64e0a124a3b33a17f58b6ff2284 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 13 Nov 2024 11:57:43 -0700 Subject: [PATCH 17/25] use os39 rc3 image in CI --- .github/workflows/nightly_ci_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index f06a858..8a866dc 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -19,7 +19,7 @@ jobs: weeknight-tests: runs-on: ubuntu-latest container: - image: docker://nrel/openstudio:3.8.0 + image: docker://nrel/openstudio:dev-3.9.0-rc3 steps: - uses: actions/checkout@v4 - name: set git config options From 423bd95f2d79ae1d425909bdd60a8dd3ef6bc04c Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Thu, 19 Dec 2024 11:52:31 -0700 Subject: [PATCH 18/25] use new extension-gem branch --- Gemfile | 5 +---- urbanopt-reporting-gem.gemspec | 2 +- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/Gemfile b/Gemfile index 57e15d6..6ea4efc 100644 --- a/Gemfile +++ b/Gemfile @@ -11,12 +11,9 @@ gemspec # checkout the latest version (develop) from github. allow_local = ENV['FAVOR_LOCAL_GEMS'] -# pin this dependency to avoid unicode_normalize error (openstudio:test_with_openstudio) -gem 'addressable', '2.8.1' - # 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: 'bundler-hack' # gem 'openstudio-extension', '~> 0.8.1' # end diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 38bf635..7ff0b3e 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'json_pure', '~> 2.7' spec.add_runtime_dependency 'json-schema', '~> 4.3.1' - spec.add_dependency 'openstudio-extension', '~> 0.8.2' + # spec.add_dependency 'openstudio-extension', '~> 0.8.2' end From c65500a98e6110f07f3b7c60afadae34677447f1 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 8 Jan 2025 09:18:35 -0700 Subject: [PATCH 19/25] improve error message for missing spaceType --- lib/measures/default_feature_reports/measure.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/measures/default_feature_reports/measure.rb b/lib/measures/default_feature_reports/measure.rb index 4bf211c..11b5f41 100644 --- a/lib/measures/default_feature_reports/measure.rb +++ b/lib/measures/default_feature_reports/measure.rb @@ -542,7 +542,7 @@ def run(runner, user_arguments) space_type_occupancy = {} spaces.each do |space| if space.spaceType.empty? - raise 'space.spaceType is empty. Make sure spaces have a space type' + raise "The #{space.name} spaceType is empty. Ensure all spaces have a space type" else building_type = space.spaceType.get.standardsBuildingType end From 1a6c994df6c1e6d2e24ad81490f2de3d0b709a74 Mon Sep 17 00:00:00 2001 From: kflemin <2205659+kflemin@users.noreply.github.com> Date: Mon, 13 Jan 2025 14:29:11 -0700 Subject: [PATCH 20/25] update dependencies --- Gemfile | 2 +- urbanopt-reporting-gem.gemspec | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 6ea4efc..73cf799 100644 --- a/Gemfile +++ b/Gemfile @@ -14,6 +14,6 @@ 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: 'bundler-hack' +# gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'bundler-hack' # gem 'openstudio-extension', '~> 0.8.1' # end diff --git a/urbanopt-reporting-gem.gemspec b/urbanopt-reporting-gem.gemspec index 7ff0b3e..0b7f8bd 100644 --- a/urbanopt-reporting-gem.gemspec +++ b/urbanopt-reporting-gem.gemspec @@ -31,5 +31,5 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'json_pure', '~> 2.7' spec.add_runtime_dependency 'json-schema', '~> 4.3.1' - # spec.add_dependency 'openstudio-extension', '~> 0.8.2' + spec.add_dependency 'openstudio-extension', '~> 0.8.3' end From c2a5db78ddab19c861c4e991a20cfb02fd7b5bd9 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 22 Jan 2025 14:27:06 -0700 Subject: [PATCH 21/25] use real OS3.9 docker image in CI --- .github/workflows/nightly_ci_build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/nightly_ci_build.yml b/.github/workflows/nightly_ci_build.yml index 8a866dc..5293a7f 100644 --- a/.github/workflows/nightly_ci_build.yml +++ b/.github/workflows/nightly_ci_build.yml @@ -19,7 +19,7 @@ jobs: weeknight-tests: runs-on: ubuntu-latest container: - image: docker://nrel/openstudio:dev-3.9.0-rc3 + image: docker://nrel/openstudio:3.9.0 steps: - uses: actions/checkout@v4 - name: set git config options From 634b151af9731a0fd65b3c7204771530d99942ef Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 22 Jan 2025 14:27:18 -0700 Subject: [PATCH 22/25] markdown linting in changelog --- CHANGELOG.md | 124 ++++++++++++++++++++++++++++----------------------- 1 file changed, 67 insertions(+), 57 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6ad8f07..e1b4c61 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,28 +1,31 @@ # URBANopt Reporting Gem ## Version 0.11.0 + * Upgrade to OpenStudio 3.8 & Ruby 3.2 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/154 **Full Changelog**: https://github.com/urbanopt/urbanopt-reporting-gem/compare/v0.10.1...v0.11.0 ## Version 0.10.1 -* Other Fuel emission factors update by @rawadelkontar in https://github.com/urbanopt/urbanopt-reporting-gem/pull/153 +* Other Fuel emission factors update by @rawadelkontar in https://github.com/urbanopt/urbanopt-reporting-gem/pull/153 **Full Changelog**: https://github.com/urbanopt/urbanopt-reporting-gem/compare/v0.10.0...v0.10.1 ## Version 0.10.0 + * Additional reporting tests by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/147 * Update formatting and version in export_modelica_loads by @nllong in https://github.com/urbanopt/urbanopt-reporting-gem/pull/149 * Update feature reports for Reopt v3 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/148 - **Full Changelog**: https://github.com/urbanopt/urbanopt-reporting-gem/compare/v0.9.1...0.10.0 ## Version 0.9.1 + * downgrade json-schema to 2.7 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/145 ## Version 0.9.0 + Date Range: 6/30/23 - 01/09/24 * Support OpenStudio 3.7 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/142 @@ -33,155 +36,162 @@ Date Range: 6/30/23 - 01/09/24 * Update export modelica loads by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/143 ## Version 0.8.0 + Date Range: 12/12/22 - 6/30/23 -- Added the `feature_location` argument in measure.xml -- Updated dependencies & CI for OpenStudio 3.6.1 -- Updated license and references to the license file +* Added the `feature_location` argument in measure.xml +* Updated dependencies & CI for OpenStudio 3.6.1 +* Updated license and references to the license file ## Version 0.7.0 -Date Range: 08/18/22 - 12/12/22 -- Update Dependencies for OpenStudio 3.5.0 -- Fixed [#106]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/106 ), Update UO reporting schema to include DISCO outputs -- Fixed [#107]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/107 ), QAQC reporting rollup in feature report and scenario report -- Fixed [#127]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/127 ), Clean up log output to stdout +Date Range: 08/18/22 - 12/12/22 +* Update Dependencies for OpenStudio 3.5.0 +* Fixed [#106]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/106 ), Update UO reporting schema to include DISCO outputs +* Fixed [#107]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/107 ), QAQC reporting rollup in feature report and scenario report +* Fixed [#127]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/127 ), Clean up log output to stdout ## Version 0.6.2 + Date Range: 06/28/22 - 08/17/22 -- Fixed [#118]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/118 ), set up actions with coveralls -- Fixed [#119]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/119 ), emissions bug fix +* Fixed [#118]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/118 ), set up actions with coveralls +* Fixed [#119]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/119 ), emissions bug fix ## Version 0.6.1 + Date Range: 05/10-22 - 06/27/22 -- Fixed [#114]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/114 ), added natural gas, propane and fuel oil emissions reporting +* Fixed [#114]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/114 ), added natural gas, propane and fuel oil emissions reporting ## Version 0.6.0 + Date Range: 11/22/21 - 05/09/22 -- Fixed [#95]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/95 ), adding additional PV fields to UO output reports -- Fixed [#98]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/98 ), add RNM results fields to schema -- Fixed [#100]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/100 ), add EV charging control EMS timeseries outputs in default reports -- Fixed [#101]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/101 ), add reopt and opendss fields to reporting schema -- Fixed [#104]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/104 ), Add renewable pct to reporting output -- Fixed [#108]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/108 ), Adding emissions results to UO reports +* Fixed [#95]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/95 ), adding additional PV fields to UO output reports +* Fixed [#98]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/98 ), add RNM results fields to schema +* Fixed [#100]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/100 ), add EV charging control EMS timeseries outputs in default reports +* Fixed [#101]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/101 ), add reopt and opendss fields to reporting schema +* Fixed [#104]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/104 ), Add renewable pct to reporting output +* Fixed [#108]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/108 ), Adding emissions results to UO reports ## Version 0.5.0 + Date Range: 11/13/21 - 11/22/21 -- Updated dependencies for OpenStudio 3.3 +* Updated dependencies for OpenStudio 3.3 ## Version 0.4.3 + Date Range: 10/16/21 - 11/12/21 -- Fixed [#93]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/93 ), Fix aggregation of storage system typo +* Fixed [#93]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/93 ), Fix aggregation of storage system typo ## Version 0.4.2 + Date Range: 07/01/21 - 10/15/21 -- Fixed [#86]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/86 ), Add location of PV to Scenario and Feature optimization reopt reports #86 -- Fixed [#77]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/77 ), Fix test_with_openstudio model failures +* Fixed [#86]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/86 ), Add location of PV to Scenario and Feature optimization reopt reports #86 +* Fixed [#77]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/77 ), Fix test_with_openstudio model failures ## Version 0.4.1 + Date Range: 04/27/23 - 07/01/21 -- Fixed [#80](https://github.com/urbanopt/urbanopt-reporting-gem/issues/80), Update rubocop configs to v4 +* Fixed [#80](https://github.com/urbanopt/urbanopt-reporting-gem/issues/80), Update rubocop configs to v4 ## Version 0.4.0 Date Range: 03/27/21 - 04/26/21 -- Update dependencies for OpenStudio 3.2.0 and Ruby 2.7 +* Update dependencies for OpenStudio 3.2.0 and Ruby 2.7 ## Version 0.3.7 Date Range: 02/12/21 - 03/26/21 -- Fixed [#47]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/47 ), Default features report bugfixes and updates -- Fixed [#67]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/67 ), Update copyrights for 2021 -- Fixed [#70]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/70 ), feature report bug fix +* Fixed [#47]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/47 ), Default features report bugfixes and updates +* Fixed [#67]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/67 ), Update copyrights for 2021 +* Fixed [#70]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/70 ), feature report bug fix ## Version 0.3.6 Date Range: 02/05/21 - 02/11/21 -- Fixed [#64]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/64 ), EnergyPlus changed output fuel names in version 9.4 +* Fixed [#64]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/64 ), EnergyPlus changed output fuel names in version 9.4 ## Version 0.3.5 Date Range: 01/16/21 - 02/04/21 -- Fixed [#58]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/58 ), Feature report saving bug fix. -- Fixed [#60]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/60 ), Added EV/ ExteriorEquipment results to csv and json reports -- Fixed [#61]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/61 ), Enhance the aggregation of enduses. - +* Fixed [#58]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/58 ), Feature report saving bug fix. +* Fixed [#60]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/60 ), Added EV/ ExteriorEquipment results to csv and json reports +* Fixed [#61]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/61 ), Enhance the aggregation of enduses. ## Version 0.3.4 Date Range: 01/14/21 - 01/15/21 -- Fixed [#53]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/53 ), Make subfolders in feature saving if necessary -- Fixed [#55]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/55 ), Fix new measures +* Fixed [#53]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/53 ), Make subfolders in feature saving if necessary +* Fixed [#55]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/55 ), Fix new measures ## Version 0.3.3 Date Range: 12/09/20 - 01/13/21 -- Fixed [#36]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/36 ), Add reporting measure for district heating/cooling system mass flow rates -- Fixed [#37]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/37 ), Add EUI to default report -- Fixed [#38]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/38 ), Add better error handling around convert_units -- Fixed [#43]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/43 ), Add available_roof_area calculation -- Fixed [#44]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/44 ), Fix coordinates order +* Fixed [#36]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/36 ), Add reporting measure for district heating/cooling system mass flow rates +* Fixed [#37]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/37 ), Add EUI to default report +* Fixed [#38]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/38 ), Add better error handling around convert_units +* Fixed [#43]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/43 ), Add available_roof_area calculation +* Fixed [#44]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/44 ), Fix coordinates order ## Version 0.3.2 Date Range: 12/07/20 - 12/08/20 -- Fixed [#27]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/27 ), reporting measure fails when there are no additional fuels in the model -- Fixed [#29]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/29 ), restore save_feature_report function for backward compatibility -- Fixed [#32]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/32 ), bump extension-gem dependency +* Fixed [#27]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/27 ), reporting measure fails when there are no additional fuels in the model +* Fixed [#29]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/29 ), restore save_feature_report function for backward compatibility +* Fixed [#32]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/32 ), bump extension-gem dependency ## Version 0.3.1 Date Range: 11/26/2020 - 12/07/2020 -- Fixed [#19]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/19 ), check for nil values to avoid crashing unit conversion -- Fixed [#24]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/24 ), Support reporting of other fuels -- Fixed [#28]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/28 ), fix for other_fuels being nil and restore save_feature_report function +* Fixed [#19]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/19 ), check for nil values to avoid crashing unit conversion +* Fixed [#24]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/24 ), Support reporting of other fuels +* Fixed [#28]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/28 ), fix for other_fuels being nil and restore save_feature_report function ## Version 0.3.0 Date Range: 11/12/2020 - 11/25/2020 -- Updating dependencies to support OpenStudio 3.1.0 +* Updating dependencies to support OpenStudio 3.1.0 ## Version 0.2.1 Date Range: 09/22/2020 - 11/12/2020 -- Fixed [#12]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/12 ), add units to the json report attributes -- Fixed [#14]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/14 ), Add rdocs -- Fixed [#16]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/16 ), increase sidebar width to show class names -- Fixed [#18]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/18 ), measure: Handle nil values that crash OpenStudio.convert -- Fixed [#20]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/20 ), fixed saving csv results bug +* Fixed [#12]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/12 ), add units to the json report attributes +* Fixed [#14]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/14 ), Add rdocs +* Fixed [#16]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/16 ), increase sidebar width to show class names +* Fixed [#18]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/18 ), measure: Handle nil values that crash OpenStudio.convert +* Fixed [#20]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/20 ), fixed saving csv results bug ## Version 0.2.0 Date Range: 08/27/2020 - 09/21/2020 -- Fixed [#5]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/5 ), bug fixes related to REopt classes -- Fixed [#7]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/7 ), adding TM symbol -- Fixed [#8]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/8 ), New reopt results +* Fixed [#5]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/5 ), bug fixes related to REopt classes +* Fixed [#7]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/7 ), adding TM symbol +* Fixed [#8]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/8 ), New reopt results ## Version 0.1.1 08/26/2020 -- Adding thermal storage reporting -- Fix paths for reporting and scenario gems split +* Adding thermal storage reporting +* Fix paths for reporting and scenario gems split ## Version 0.1.0 From 73f2b8458d188f2ea990deb054fde11440011ca9 Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 22 Jan 2025 14:28:00 -0700 Subject: [PATCH 23/25] bump to version 1.0.0 --- lib/urbanopt/reporting/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/urbanopt/reporting/version.rb b/lib/urbanopt/reporting/version.rb index 081da51..7bb6fe9 100644 --- a/lib/urbanopt/reporting/version.rb +++ b/lib/urbanopt/reporting/version.rb @@ -5,6 +5,6 @@ module URBANopt module Reporting - VERSION = '0.11.0'.freeze + VERSION = '1.0.0'.freeze end end From a804490c54f5a159f797db5f89f985d0f156979e Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 22 Jan 2025 14:29:50 -0700 Subject: [PATCH 24/25] update changelog for v1.0.0 --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e1b4c61..31a067f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # URBANopt Reporting Gem +## Version 1.0.0 + +* Upgrade to OpenStudio 3.9 and Ruby 3.2.2 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/155 + +**Full Changelog**: https://github.com/urbanopt/urbanopt-reporting-gem/compare/v0.10.1...v1.0.0 + ## Version 0.11.0 * Upgrade to OpenStudio 3.8 & Ruby 3.2 by @vtnate in https://github.com/urbanopt/urbanopt-reporting-gem/pull/154 From 463ff4b8049bd19a2b4e9974b84ec6cc591ff0ad Mon Sep 17 00:00:00 2001 From: Nathan Moore Date: Wed, 22 Jan 2025 14:32:05 -0700 Subject: [PATCH 25/25] update measure with rake task --- lib/measures/default_feature_reports/measure.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/measures/default_feature_reports/measure.xml b/lib/measures/default_feature_reports/measure.xml index 186a86a..c5156ab 100644 --- a/lib/measures/default_feature_reports/measure.xml +++ b/lib/measures/default_feature_reports/measure.xml @@ -3,8 +3,8 @@ 3.1 default_feature_reports 9ee3135a-8070-4408-bfa1-b75fecf9dd4f - 43be79bc-ba24-44e0-923f-3f618951a054 - 2024-07-16T17:52:08Z + 7864fba6-0915-4a17-ad41-3d2912856425 + 2025-01-22T21:31:39Z FB304155 DefaultFeatureReports DefaultFeatureReports @@ -128,7 +128,7 @@ measure.rb rb script - 2B9D1AAE + EA7A7994 USA_CO_Golden-NREL.724666_TMY3.epw