Merge pull request #158 from urbanopt/develop

Version 1.0.0

.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
@@ -21,21 +19,23 @@ jobs:
   weeknight-tests:
     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: |
           ruby --version
+          bundle install
           bundle update
       - 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

.gitignore

@@ -14,6 +14,7 @@
 /lib/measures/*/tests/output
 out.txt
 .rubocop*s3*
+.coverage
 
 # rspec failure tracking
 .rspec_status

CHANGELOG.md

@@ -1,23 +1,37 @@
 # 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
+
+**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
@@ -28,155 +42,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
 

Gemfile

@@ -11,15 +11,9 @@ 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 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'
 # 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

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
@@ -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

lib/measures/default_feature_reports/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>1f0dd70a-ddad-4bb8-a54b-0aeb696e80d0</version_id>
-  <version_modified>2024-06-20T19:28:12Z</version_modified>
+  <version_id>7864fba6-0915-4a17-ad41-3d2912856425</version_id>
+  <version_modified>2025-01-22T21:31:39Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -128,7 +128,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>005CDD6D</checksum>
+      <checksum>EA7A7994</checksum>
     </file>
     <file>
       <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>

lib/measures/export_time_series_modelica/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>export_time_series_loads_csv</name>
   <uid>9fcf6116-c2eb-43d6-93f0-e1bdd822f768</uid>
-  <version_id>0b134568-d3a8-4ede-bf22-2010a173ea97</version_id>
-  <version_modified>2024-01-08T22:54:07Z</version_modified>
+  <version_id>8bd4bc8e-f597-47f9-82b9-044a06977bb1</version_id>
+  <version_modified>2024-07-16T17:52:07Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>ExportTimeSeriesLoadsCSV</class_name>
   <display_name>ExportTimeSeriesLoadsCSV</display_name>
@@ -111,7 +111,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>EC8615DF</checksum>
+      <checksum>EB4FBA91</checksum>
     </file>
     <file>
       <filename>os_lib_helper_methods.rb</filename>

lib/urbanopt/reporting/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.10.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end