urbanopt-reporting 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88fd3280248540278799a2b19f5d970ad199bf75acab0efe08bd3c4c11d7ec75
-  data.tar.gz: 32acb1d1523bcbd7bbcf86c8eeec200f4c03bd86ee12ccefd4f936888a3bdb4b
+  metadata.gz: 186e2233b38a2f167fadd907eb6d768a589ca55dfc0a11e238b363bbc9574c27
+  data.tar.gz: 5cdb0f89a17ea078ef7ed61ed5710892ae956620a5370fe140fd4c8107ab73e8
 SHA512:
-  metadata.gz: 5520b1958d1037868b5daf041d618bf0be93673235bf65d21ccb8e7f5354ea52ac12e1b4b0d39bb9f6dcf09c6f648c8eeb53136365162bfd0f31858f826a9822
-  data.tar.gz: f0b2ddc2128321e99b3590924db5b2ac29c7deb9f31f326f2639ff9efcaf44aa86e223e1b56801ba24e05333e38d5cd4be80983f48d997e61f2451f1617a6ee9
+  metadata.gz: 2bce9e36d7098ceb88b559d01b4e2eeeb5a30b78c0cacfd476a9501592df3b65b2d9807c45203fb3b2bccb53b3e8334e35acd362f5c848ac089635ce3f9ff932
+  data.tar.gz: 218468f4c8beb0b2dc4c4afa7ef4b7e05410d42bf7898236e58de93048f32c1b3be290a47260bd7d457811821562223e3fbd49845cb77334c5a7e3a9a256bdea

data/.github/workflows/nightly_build.yml

@@ -0,0 +1,41 @@
+name: nightly_build
+
+on:
+  # push:
+  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'
+
+# Cancels an existing job (of the same workflow) if it is still running
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow
+# concurrency:
+#   group: ${{ github.workflow }}-${{ github.ref }}
+#   cancel-in-progress: true
+
+env:
+  # This env var should enforce develop branch of all dependencies
+  # FAVOR_LOCAL_GEMS: true
+  GEM_DEVELOPER_KEY: ${{ secrets.GEM_DEVELOPER_KEY }}
+
+jobs:
+  weeknight-tests:
+    # Pinned to `ubuntu-20.04`. When ubuntu-latest adopts 22.04 it would break for us since 22 only supports Ruby 3.1
+    # https://github.com/ruby/setup-ruby#supported-platforms
+    runs-on: ubuntu-20.04
+    container:
+      image: docker://nrel/openstudio:3.4.0
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Update gems
+        run: |
+          bundle update
+      - name: Run Rspec
+        run: bundle exec rspec
+      # coveralls action docs: https://github.com/marketplace/actions/coveralls-github-action
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: "./coverage/lcov/urbanopt-reporting-gem.lcov"

data/CHANGELOG.md

@@ -1,12 +1,27 @@
 # URBANopt Reporting Gem
 
+## 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
+
+
+## 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
+
 ## Version 0.6.1
-Date Range: 05/10-22 - 06/27/22:
+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
 
 ## Version 0.6.0
-Date Range: 11/22/21 - 05/09/22:
+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

data/Gemfile

@@ -11,8 +11,8 @@ gemspec
 # checkout the latest version (develop) from github.
 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'
-end
+# 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'
+# end

data/README.md

@@ -1,5 +1,7 @@
 # URBANopt Reporting Gem
 
+[![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-reporting-gem/badge.svg?branch=develop)](https://coveralls.io/github/urbanopt/urbanopt-reporting-gem?branch=develop)
+
 The URBANopt<sup>&trade;</sup> Reporting Gem defines the URABNopt reports (Scenario and Feature reports). It also includes the default reporting measure which query results from the energyplus sql database and reports it in the Feature reports.
 
 
@@ -27,9 +29,9 @@ Or install it yourself as:
 Check out the repository and then execute:
 
     $ bundle install
-    $ bundle update    
+    $ bundle update
     $ bundle exec rake
-    
+
 ## Releasing
 
 * Update CHANGELOG.md

data/lib/measures/default_feature_reports/measure.rb

@@ -41,12 +41,12 @@
 require 'urbanopt/reporting/default_reports'
 require 'csv'
 require 'benchmark'
+require 'json'
 require 'logger'
 
-@@logger = Logger.new($stdout)
-
 # start the measure
 class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
+  @@logger = Logger.new($stdout)
   # human readable name
   def name
     return 'DefaultFeatureReports'
@@ -233,7 +233,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # result << OpenStudio::IdfObject.load("Output:Variable,*,Exterior Equipment:Electric Vehicles,#{reporting_frequency};").get
 
     ## add environmental factor outputs
-    #result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Output:EnvironmentalImpactFactors,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Output:EnvironmentalImpactFactors,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Variable,*,Environmental Impact Total N2O Emissions Carbon Equivalent Mass,#{reporting_frequency}; !- HVAC Sum [kg];").get
     # result << OpenStudio::IdfObject.load("Output:Variable,*,Environmental Impact Total CH4 Emissions Carbon Equivalent Mass,#{reporting_frequency}; !- HVAC Sum [kg];").get
     # result << OpenStudio::IdfObject.load("Output:Variable,*,Environmental Impact Total CO2 Emissions Carbon Equivalent Mass,#{reporting_frequency}; !- HVAC Sum [kg];").get
@@ -252,11 +252,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     ev_timeseries_data = ['Exterior Equipment:Electric Vehicles']
 
     emissions_timeseries_data = ['Future_Annual_Electricity_Emissions', 'Future_Hourly_Electricity_Emissions',
-                                  'Historical_Annual_Electricity_Emissions', 'Historical_Hourly_Electricity_Emissions',
-                                  'Future_Annual_Electricity_Emissions_Intensity', 'Future_Hourly_Electricity_Emissions_Intensity',
-                                  'Historical_Annual_Electricity_Emissions_Intensity', 'Historical_Hourly_Electricity_Emissions_Intensity']
-
-
+                                 'Historical_Annual_Electricity_Emissions', 'Historical_Hourly_Electricity_Emissions',
+                                 'Future_Annual_Electricity_Emissions_Intensity', 'Future_Hourly_Electricity_Emissions_Intensity',
+                                 'Historical_Annual_Electricity_Emissions_Intensity', 'Historical_Hourly_Electricity_Emissions_Intensity']
 
     timeseries_data += tes_timeseries_data
     timeseries_data += emissions_timeseries_data
@@ -291,6 +289,85 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     return val
   end
 
+  def feature_qaqc_flags(runner)
+    # QAQC flags by category
+    qaqc_flags_hash = {} # Make a hash for count of flags of each category
+
+    runner.workflow.workflowSteps.each do |step| # Go through all the steps
+
+      if step.to_MeasureStep.is_initialized
+        measure_step = step.to_MeasureStep.get
+
+        measure_name = measure_step.measureDirName
+
+        if measure_step.name.is_initialized
+          measure_name = measure_step.name.get
+        end
+
+        if measure_name.include? 'qaqc'
+          puts "measure_name = #{measure_name}"
+          if measure_step.result.is_initialized
+            result = measure_step.result.get
+            puts " result = #{result}"
+
+            ## Adding quaqc_flags_list to check the step value name since units key is missing from the result 
+            ## It does show in the out.osw but not in the runner.workflow.workflowSteps object
+            # use this list to define the flags you want to report 
+            qaqc_flags_list = ['eui_reasonableness' , 'end_use_by_category',
+            'mechanical_system_part_load_efficiency', 'simultaneous_heating_and_cooling', 
+            'internal_loads', 'schedules', 'envelope_r_value', 'domestic_hot_water',
+            'mechanical_system_efficiency', 'supply_and_zone_air_temperature', 'total_qaqc_flags' ]
+            
+            result.stepValues.each do |step_value|
+              
+              #get name 
+              name = step_value.name
+
+              if qaqc_flags_list.include? name
+
+                # get value
+                # check if value, double, int, or bool
+                value_type = step_value.variantType.valueDescription
+                if value_type == "Double"
+                  value = step_value.valueAsDouble
+                elsif value_type == "Integer"
+                  value = step_value.valueAsInteger
+                elsif value_type == "Boolean"
+                  value = step_value.valueAsBoolean
+                elsif value_type == "String"
+                  value = step_value.valueAsString
+                else
+                  # catchall for unexpected value types
+                  value = step_value.valueAsVariant.to_s
+                end
+                
+                if qaqc_flags_hash[name]
+                  qaqc_flags_hash[name] += value
+                else 
+                  qaqc_flags_hash[name] = value
+                end
+
+              end
+
+            end
+
+            puts "qaqc_flags_hash = #{qaqc_flags_hash}"
+
+            # Hack to put 'total_qaqc_flags' at the end of the hash
+            temp_hash_for_ordering = { 'total_qaqc_flags' => qaqc_flags_hash['total_qaqc_flags'] }
+            qaqc_flags_hash.delete('total_qaqc_flags')
+            qaqc_flags_hash['total_qaqc_flags'] = temp_hash_for_ordering['total_qaqc_flags']
+
+          end
+        
+        end
+
+      end
+
+    end
+    return qaqc_flags_hash
+  end
+
   # unit conversion method
   def convert_units(value, from_units, to_units)
     if value.nil?
@@ -836,7 +913,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     # electricity emissions
     begin
-
       # future_annual_emissions
       future_annual_emissions_ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, 'Future_Annual_Electricity_Emissions', 'EMS')
       feature_report.reporting_periods[0].emissions[:future_annual_electricity_emissions_mt] = future_annual_emissions_ts.get.values.sum
@@ -868,11 +944,24 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       # historical_hourly_emissions_intensity
       historical_hourly_emissions_intensity_ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, 'Historical_Hourly_Electricity_Emissions_Intensity', 'EMS')
       feature_report.reporting_periods[0].emissions[:historical_hourly_electricity_emissions_intensity_kg_per_ft2] = historical_hourly_emissions_intensity_ts.get.values.sum
-
     rescue StandardError
       @@logger.info('Emissions are not reported for this feature')
     end
 
+    # add qaqc results to feature report 
+    qaqc_flags_hash = feature_qaqc_flags(runner)
+    feature_report.qaqc_flags.eui_reasonableness = qaqc_flags_hash['eui_reasonableness']
+    feature_report.qaqc_flags.end_use_by_category = qaqc_flags_hash['end_use_by_category']
+    feature_report.qaqc_flags.mechanical_system_part_load_efficiency = qaqc_flags_hash['mechanical_system_part_load_efficiency']
+    feature_report.qaqc_flags.simultaneous_heating_and_cooling = qaqc_flags_hash['simultaneous_heating_and_cooling']
+    feature_report.qaqc_flags.internal_loads = qaqc_flags_hash['internal_loads']
+    feature_report.qaqc_flags.schedules = qaqc_flags_hash['schedules']
+    feature_report.qaqc_flags.envelope_r_value = qaqc_flags_hash['envelope_r_value']
+    feature_report.qaqc_flags.domestic_hot_water = qaqc_flags_hash['domestic_hot_water']
+    feature_report.qaqc_flags.mechanical_system_efficiency = qaqc_flags_hash['mechanical_system_efficiency']
+    feature_report.qaqc_flags.supply_and_zone_air_temperature = qaqc_flags_hash['supply_and_zone_air_temperature']
+    feature_report.qaqc_flags.total_qaqc_flags = qaqc_flags_hash['total_qaqc_flags']
+
     ##########################################################################################################################
     # set conversion variables
     conv_J_mwh = 1000000 * 60 * 60 # J to MWh (1000000J/MJ * 60hr/min * 60 min/sec)
@@ -888,7 +977,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     fo1_val = 294.962046
     fo2_val = 294.962046
 
-
     ##########################################################################################################################
     ######################################## Reporting TImeseries Results FOR CSV File #######################################
 
@@ -948,7 +1036,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Historical_Hourly_Electricity_Emissions_Intensity',
       'Natural_Gas_Emissions',
       'Natural_Gas_Emissions_Intensity',
-      'Propane_Emissions', 
+      'Propane_Emissions',
       'Propane_Emissions_Intensity',
       'FuelOilNo2_Emissions',
       'FuelOilNo2_Emissions_Intensity',
@@ -980,7 +1068,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     runner.registerInfo("All timeseries: #{requested_timeseries_names}")
 
     # timeseries variables to keep to calculate power
-    tsToKeep = ['Electricity:Facility', 'ElectricityProduced:Facility','Propane:Facility', 'NaturalGas:Facility', 'FuelOilNo2:Facility', 'FuelOilNo1:Facility']
+    tsToKeep = ['Electricity:Facility', 'ElectricityProduced:Facility', 'Propane:Facility', 'NaturalGas:Facility', 'FuelOilNo2:Facility', 'FuelOilNo1:Facility']
     tsToKeepIndexes = {}
 
     ### powerFactor ###
@@ -1145,7 +1233,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if timeseries_name == 'Natural_Gas_Emissions'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (nat_gas_val * (values[tsToKeepIndexes['NaturalGas:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f 
+            newVals[j] = (nat_gas_val * (values[tsToKeepIndexes['NaturalGas:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f
             j += 1
           end
           new_unit = 'MT'
@@ -1158,7 +1246,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if timeseries_name == 'Propane_Emissions'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (lpg_val * (values[tsToKeepIndexes['Propane:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f 
+            newVals[j] = (lpg_val * (values[tsToKeepIndexes['Propane:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f
             j += 1
           end
           new_unit = 'MT'
@@ -1171,7 +1259,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if timeseries_name == 'FuelOilNo2_Emissions'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (fo2_val * (values[tsToKeepIndexes['FuelOilNo2:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f 
+            newVals[j] = (fo2_val * (values[tsToKeepIndexes['FuelOilNo2:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f
             j += 1
           end
           new_unit = 'MT'
@@ -1183,12 +1271,12 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
         ### calculate emissions intensity metric
         # get flr_area
-        flr_area = building.floorArea * 10.764 #change from m2 to ft2
+        flr_area = building.floorArea * 10.764 # change from m2 to ft2
 
         if timeseries_name == 'Natural_Gas_Emissions_Intensity'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (((nat_gas_val * (values[tsToKeepIndexes['NaturalGas:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f ) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
+            newVals[j] = (((nat_gas_val * (values[tsToKeepIndexes['NaturalGas:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
             j += 1
           end
           new_unit = 'KG/FT2'
@@ -1201,7 +1289,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if timeseries_name == 'Propane_Emissions_Intensity'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (((lpg_val * (values[tsToKeepIndexes['Propane:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f ) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
+            newVals[j] = (((lpg_val * (values[tsToKeepIndexes['Propane:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
             j += 1
           end
           new_unit = 'KG/FT2'
@@ -1214,7 +1302,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if timeseries_name == 'FuelOilNo2_Emissions_Intensity'
           newVals = Array.new(n, 0)
           (0..n - 1).each do |j|
-            newVals[j] = (((fo2_val * (values[tsToKeepIndexes['FuelOilNo2:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f ) * conv_kg_mt.to_f ) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
+            newVals[j] = (((fo2_val * (values[tsToKeepIndexes['FuelOilNo2:Facility']][j].to_f * conv_kbtu_J.to_f) / conv_J_mwh.to_f) * conv_kg_mt.to_f) * 1000 / flr_area) # unit: kg/ft2 - changed mt to kg
             j += 1
           end
           new_unit = 'KG/FT2'
@@ -1280,8 +1368,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
               end
             end
           end
-        end          
-          
+        end
 
         # append units to headers
         new_timeseries_name += "(#{new_unit})"
@@ -1414,7 +1501,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
-    puts "values = #{values}"
+    #puts "values = #{values}"
 
     # closing the sql file
     sql_file.close
@@ -1425,8 +1512,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_report.timeseries_csv.first_report_datetime = '0'
     feature_report.timeseries_csv.column_names = final_timeseries_names
 
-    ##### Save the 'default_feature_reports.json' file
 
+    ##### Save the 'default_feature_reports.json' file
     feature_report_hash = feature_report.to_hash
 
     File.open('default_feature_reports.json', 'w') do |f|

data/lib/urbanopt/reporting/default_reports/distributed_generation.rb

@@ -210,7 +210,7 @@ module URBANopt
         ##
         # [parameters:]
         #
-        # * +hash+ - _Hash_ - A hash containting key/value pairs for the distributed generation system attributes listed above.
+        # * +hash+ - _Hash_ - A hash containing key/value pairs for the distributed generation system attributes listed above.
         #
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }

data/lib/urbanopt/reporting/default_reports/feature_report.rb

@@ -63,7 +63,7 @@ module URBANopt
       # The DefaultPostProcessor reads these feature reports and aggregates them to create a ScenarioReport.
       ##
       class FeatureReport
-        attr_accessor :id, :name, :directory_name, :feature_type, :timesteps_per_hour, :simulation_status,
+        attr_accessor :id, :name, :directory_name, :feature_type, :timesteps_per_hour, :simulation_status, :qaqc_flags,
                       :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation, :power_distribution, :thermal_storage # :nodoc:
 
         ##
@@ -82,6 +82,7 @@ module URBANopt
           @feature_type = hash[:feature_type]
           @timesteps_per_hour = hash[:timesteps_per_hour]
           @simulation_status = hash[:simulation_status]
+          @qaqc_flags = QAQC.new(hash[:qaqc_flags])
           @timeseries_csv = TimeseriesCSV.new(hash[:timeseries_csv])
           @timeseries_csv.run_dir_name(@directory_name)
           @location = Location.new(hash[:location])
@@ -124,6 +125,7 @@ module URBANopt
           hash[:distributed_generation] = {}
           hash[:power_distribution] = {}
           hash[:thermal_storage] = {}
+          hash[:qaqc_flags] = {}
           return hash
         end
 
@@ -227,6 +229,8 @@ module URBANopt
 
           result[:thermal_storage] = @thermal_storage.to_hash if @thermal_storage
 
+          result[:qaqc_flags] = @qaqc_flags.to_hash if @qaqc_flags
+
           # validate feature_report properties against schema
           if @@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result).any?
             raise "feature_report properties does not match schema: #{@@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result)}"

data/lib/urbanopt/reporting/default_reports/logger.rb

@@ -44,6 +44,8 @@ module URBANopt
   module Reporting
     module DefaultReports
       @@logger = Logger.new($stdout)
+
+      @@logger.level = Logger::WARN
       ##
       # Definining class variable "@@logger" to log errors, info and warning messages.
       def self.logger

data/lib/urbanopt/reporting/default_reports/qaqc_flags.rb

@@ -0,0 +1,182 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'json'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # QAQC flags for each feature
+      ##
+      class QAQC
+        ##
+        # _Hash_ - Hash of flags raised by QAQC measure for this feature during this reporting period
+        #
+        attr_accessor :eui_reasonableness,:end_use_by_category,:mechanical_system_part_load_efficiency,
+                      :simultaneous_heating_and_cooling , :internal_loads , :schedules, :envelope_r_value, 
+                      :domestic_hot_water , :mechanical_system_efficiency , :supply_and_zone_air_temperature, 
+                      :total_qaqc_flags
+
+        ##
+        # QAQC class initialize quaqc attributes: +:eui_reasonableness,+:end_use_by_category,+:mechanical_system_part_load_efficiency,
+        # +:simultaneous_heating_and_cooling , +:internal_loads , +:schedules, +:envelope_r_value, 
+        # +:domestic_hot_water , +:mechanical_system_efficiency , +:supply_and_zone_air_temperature, +:total_qaqc_flags
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containing qaqc attributes listed above.
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @eui_reasonableness = hash[:eui_reasonableness]
+          @end_use_by_category = hash[:end_use_by_category]
+          @mechanical_system_part_load_efficiency = hash[:mechanical_system_part_load_efficiency]
+          @simultaneous_heating_and_cooling = hash[:simultaneous_heating_and_cooling]
+          @supply_and_zone_air_temperature = hash[:supply_and_zone_air_temperature]
+          @internal_loads = hash[:internal_loads]
+          @schedules = hash[:schedules]
+          @envelope_r_value = hash[:envelope_r_value]
+          @domestic_hot_water = hash[:domestic_hot_water]
+          @mechanical_system_efficiency = hash[:mechanical_system_efficiency]
+          @total_qaqc_flags = hash[:total_qaqc_flags]
+
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+        end
+
+
+        ##
+        # Assigns default values if values do not exist.
+        ##
+        def defaults
+          hash = {}
+
+          hash[:eui_reasonableness] = nil
+          hash[:end_use_by_category] = nil
+          hash[:mechanical_system_part_load_efficiency] = nil
+          hash[:simultaneous_heating_and_cooling] = nil
+          hash[:supply_and_zone_air_temperature] = nil
+          hash[:internal_loads] = nil
+          hash[:schedules] = nil
+          hash[:envelope_r_value] = nil
+          hash[:domestic_hot_water] = nil
+          hash[:mechanical_system_efficiency] = nil
+          hash[:total_qaqc_flags] = nil
+
+
+          return hash
+        end
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:eui_reasonableness] = @eui_reasonableness 
+          result[:end_use_by_category] = @end_use_by_category
+          result[:mechanical_system_part_load_efficiency] = @mechanical_system_part_load_efficiency 
+          result[:simultaneous_heating_and_cooling] = @simultaneous_heating_and_cooling
+          result[:supply_and_zone_air_temperature] = @supply_and_zone_air_temperature 
+          result[:internal_loads] = @internal_loads
+          result[:schedules] = @schedules
+          result[:envelope_r_value] = @envelope_r_value
+          result[:domestic_hot_water] = @domestic_hot_water
+          result[:mechanical_system_efficiency] = @mechanical_system_efficiency
+          result[:total_qaqc_flags] = @total_qaqc_flags
+
+          # validate program properties against schema
+          if @@validator.validate(@@schema[:definitions][:qaqc_flags][:properties], result).any?
+            raise "qaqc properties does not match schema: #{@@validator.validate(@@schema[:definitions][:qaqc_flags][:properties], result)}"
+          end
+
+          return result
+          
+        end
+
+        ##
+        # Adds up +existing_value+ and +new_values+ if not nill.
+        ##
+        # [parameters:]
+        # +existing_value+ - _Float_ - A value corresponding to a qaqc_flags attribute.
+        ##
+        # +new_value+ - _Float_ - A value corresponding to a qaqc_flags attribute.
+        ##
+        def add_values(existing_value, new_value) #:nodoc:
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
+
+        ##
+        # Merges qaqc_flags objects to each other by summing up values.
+        ##
+        # [parameters:]
+        # +other+ - _QAQC_ - An object of Program class.
+        ##
+        def add_qaqc_flags(other)
+
+          @eui_reasonableness = add_values(@eui_reasonableness, other.eui_reasonableness)
+          @end_use_by_category = add_values(@end_use_by_category, other.end_use_by_category)
+          @mechanical_system_part_load_efficiency = add_values(@mechanical_system_part_load_efficiency, other.mechanical_system_part_load_efficiency)
+          @simultaneous_heating_and_cooling = add_values(@simultaneous_heating_and_cooling, other.simultaneous_heating_and_cooling)
+          @supply_and_zone_air_temperature = add_values(@supply_and_zone_air_temperature, other.supply_and_zone_air_temperature)
+          @internal_loads = add_values(@internal_loads, other.internal_loads)
+          @schedules = add_values(@schedules, other.schedules)
+          @envelope_r_value = add_values(@envelope_r_value, other.envelope_r_value)
+          @domestic_hot_water = add_values(@domestic_hot_water, other.domestic_hot_water)
+          @mechanical_system_efficiency = add_values(@mechanical_system_efficiency, other.mechanical_system_efficiency)
+          @total_qaqc_flags = add_values(@total_qaqc_flags, other.total_qaqc_flags)
+
+        end
+
+      end
+    end
+  end
+end

data/lib/urbanopt/reporting/default_reports/reporting_period.rb

@@ -222,7 +222,7 @@ module URBANopt
           result[:comfort_result] = comfort_result_hash if @comfort_result
 
           emissions_hash = @emissions if @emissions
-          #emissions_hash.delete_if { |k, v| v.nil? }
+          emissions_hash.delete_if { |k, v| v.nil? }
           result[:emissions] = emissions_hash if @emissions
 
           # validates +reporting_period+ properties against schema for reporting period.