urbanopt-reporting 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aab8d062f546b4a594cc0f86d7c27b8bfb065fe357aed461df3db761e43590d
-  data.tar.gz: 8a828838d4b881ccd81ca7541b247aad02f6aa560b2d14fa1ba213f9ab14de56
+  metadata.gz: b1877280e45c42b9a43bfd39dbd5305079fdcd3e4fad3cfba9894d0b7a05940c
+  data.tar.gz: 4380403c78776ac9ffa650859cf14a607b25bd910a0b1347c5c0f94362e21a55
 SHA512:
-  metadata.gz: 3318a28163610658c35f31a9192c69877e6ffe1aee565d1a5d3b5a5f6180a95c83f5f8ee4258eaff20cc09390764082d04d438560dca0310816207e26b2b6d0c
-  data.tar.gz: c90f19fd040dff797d0f2186ce11c1f18b2a8bb2b49e1c1934629bb3cae468ebe49466d38dee524bf2217ef69f099e08cb31b6130dd7d47e9f62429e1c8cf0b3
+  metadata.gz: 45de5ba3805fa748b1b6630ba7ca655643c28bc611c9aa4771944d6ffb40f296c0500f46dc700c293d54522a20a6d6f3c8205482e704436bff369f6386d1d569
+  data.tar.gz: 69a9b1ee7e94e14faa98f4cfd64f9f5cd0efdc9939f5c0ea8490018b14596f2a26590622efee2e23a602a1f1f34548756dabe2123f9b251df39c22a088a9dbd1

data/.github/workflows/nightly_ci_build.yml

@@ -2,6 +2,7 @@ name: Reporting-gem CI
 
 on:
   # 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

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # URBANopt Reporting Gem
 
+## Version 0.10.1
+* 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
 

data/Gemfile

@@ -15,6 +15,8 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 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'

data/lib/measures/default_feature_reports/measure.rb

@@ -798,7 +798,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       enduses.each do |eu|
         sql_r = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='#{eu}' AND ColumnName='#{ft}'")
 
-        # report each query in its corresponding feature report obeject
+        # report each query in its corresponding feature report object
         x = ft.tr(' ', '_').downcase
         if x.include? 'water'
           x_u = "#{x}_qbft"
@@ -931,14 +931,14 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     conv_kg_mt = 0.001 # kg to metric ton
     conv_kbtu_J = 1054852.32 # KBtu to J (1kBtu = 1054852.32 J)
 
-    ##### Emisison factors for natural gas, propane, and fuel oil based on EPA eGRID data and calculated using 20-year GWP horizon based on ASHRAE 189.1
-    ## natural gas :  277.358126 KG/MWH
-    ## propane : 323.896704 KG/MWH
-    ## Fuel oil : 294.962046 KG/MWH
-    nat_gas_val = 277.358126
-    lpg_val = 323.896704
-    fo1_val = 294.962046
-    fo2_val = 294.962046
+    ##### Emisison factors for natural gas, propane, and fuel oil based on https://portfoliomanager.energystar.gov/pdf/reference/Emissions.pdf
+    ## natural gas :  181.7 KG/MWH
+    ## propane : 219.2 KG/MWH
+    ## Fuel oil #1: 250.8 KG/MWH
+    nat_gas_val = 181.7
+    lpg_val = 219.2
+    fo1_val = 250.8
+    fo2_val = 253.2
 
     ##########################################################################################################################
     ######################################## Reporting TImeseries Results FOR CSV File #######################################
@@ -1046,7 +1046,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     total_hours = 1 / timesteps_per_hour.to_f # make sure timesteps_per_hour is a float in the division
     # set power_conversion
     power_conversion = total_hours # we set the power conversio to total_hours since we want to convert lWh to kW
-    puts "Power Converion: to convert kWh to kW values will be divided by #{power_conversion}"
+    puts "Power Conversion: to convert kWh to kW values will be divided by #{power_conversion}"
 
     # number of values in each timeseries
     n = nil
@@ -1184,14 +1184,13 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         # conv_kg_mt = 0.001 # kg to metric ton
         # conv_kbtu_J = 1054852.32 # KBtu to J (1kBtu = 1054852.32 J)
 
-        # ##### Emisison factors for natural gas, propane, and fuel oil based on EPA eGRID data and calculated using 20-year GWP horizon based on ASHRAE 189.1
-        # ## natural gas :  277.358126 KG/MWH
-        # ## propane : 323.896704 KG/MWH
-        # ## Fuel oil : 294.962046 KG/MWH
-        # nat_gas_val = 277.358126
-        # lpg_val = 323.896704
-        # fo1_val = 294.962046
-        # fo2_val = 294.962046
+        # ##### Emisison factors for natural gas, propane, and fuel oil based on https://portfoliomanager.energystar.gov/pdf/reference/Emissions.pdf
+        # ## natural gas :  181.7 KG/MWH
+        # ## propane : 219.2 KG/MWH
+        # nat_gas_val = 181.7
+        # lpg_val = 219.2
+        # fo1_val = 250.8
+        # fo2_val = 253.2
 
         if timeseries_name == 'Natural_Gas_Emissions'
           newVals = Array.new(n, 0)
@@ -1441,7 +1440,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     else
       raise 'ELECTRICITY and GAS results are not initiaized'
     end
-    # get formated datetimes
+    # get formatted datetimes
     timeseries_d.dateTimes.each do |datetime|
       datetimes << format_datetime(datetime.to_s)
     end

data/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>0d079df4-5b14-465d-9b3c-d00e30b3def2</version_id>
-  <version_modified>2024-01-08T22:54:10Z</version_modified>
+  <version_id>1f0dd70a-ddad-4bb8-a54b-0aeb696e80d0</version_id>
+  <version_modified>2024-06-20T19:28:12Z</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>A0464D25</checksum>
+      <checksum>005CDD6D</checksum>
     </file>
     <file>
       <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>

data/lib/measures/export_time_series_modelica/measure.rb

@@ -77,7 +77,7 @@ class ExportTimeSeriesLoadsCSV < OpenStudio::Measure::ReportingMeasure
     # use the built-in error checking
     return false unless runner.validateUserArguments(arguments(model), user_arguments)
 
-    # #Read in argumetns related to variables for output requests
+    # #Read in arguments related to variables for output requests
     hhw_loop_name = runner.getStringArgumentValue('hhw_loop_name', user_arguments)
     chw_loop_name = runner.getStringArgumentValue('chw_loop_name', user_arguments)
 

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

@@ -17,7 +17,7 @@ module URBANopt
         attr_accessor :category, :item_name, :unit_cost, :cost_units, :item_quantity, :total_cost # :nodoc:
 
         ##
-        # ConstructionCost class intialize all construction_cost attributes:
+        # ConstructionCost class initialize all construction_cost attributes:
         # +:category+ , +:item_name+ , +:unit_cost+ , +:cost_units+ , +:item_quantity+ , +:total_cost+
         ##
         # [parameters:]
@@ -108,7 +108,7 @@ module URBANopt
         end
 
         ##
-        # Merges muliple construction costs together.
+        # Merges multiple construction costs together.
         # - loops over the new_costs and find the index of the cost with identical +:item_name+.
         # - if +item_name+ is identical then modify the existing_cost array by summing the :total_cost and :item_quantity. Else add the new_cost to existing_costs array.
         ##

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

@@ -17,7 +17,7 @@ module URBANopt
         attr_accessor :month, :day_of_month, :year #:nodoc:
 
         ##
-        # Date class intialize all date attributes:
+        # Date class initialize all date attributes:
         # +:month+ , +:day_of_month+ , +:year+
         ##
         # [parameters:]

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

@@ -20,67 +20,67 @@ module URBANopt
         ##
         # _Float_ - Lifecycle costs for the complete distributed generation system in US Dollars
         #
-        attr_accessor :lcc_us_dollars
+        attr_accessor :lcc
 
         ##
         # _Float_ - Lifecycle costs for the complete distributed generation system in US Dollars
         #
-        attr_accessor :lcc_bau_us_dollars
+        attr_accessor :lcc_bau
 
         ##
         # _Float_ - Net present value of the complete distributed generation system in US Dollars
         #
-        attr_accessor :npv_us_dollars
+        attr_accessor :npv
 
         ##
         # _Float_ - Total amount paid for utility energy in US Dollars in the first year of operation
         #
-        attr_accessor :year_one_energy_cost_us_dollars
+        attr_accessor :year_one_energy_cost_before_tax
 
         ##
         # _Float_ - Total amount paid in utility demand charges in US Dollars in the first year of operation
         #
-        attr_accessor :year_one_demand_cost_us_dollars
+        attr_accessor :year_one_demand_cost_before_tax
 
         ##
         # _Float_ - Total amount paid to the utility in US Dollars in the first year of operation
         #
-        attr_accessor :year_one_bill_us_dollars
+        attr_accessor :year_one_bill_before_tax
 
         ##
         # _Float_ - Total energy costs in US Dollars over the life of the system after tax
         #
-        attr_accessor :total_energy_cost_us_dollars
+        attr_accessor :lifecycle_energy_cost_after_tax
 
         ##
         # _Float_ - Total demand costs in US Dollars over the life of the system after tax
         #
-        attr_accessor :total_demand_cost_us_dollars
+        attr_accessor :lifecycle_demand_cost_after_tax
 
         ##
-        # _Float_ -  Year one energy cost in the business as usual scenario (i.e no new system) after tax, us dollars
+        # _Float_ -  Year one energy cost in the business as usual scenario (i.e no new system) before tax, us dollars
         #
-        attr_accessor :year_one_energy_cost_bau_us_dollars
+        attr_accessor :year_one_energy_cost_before_tax_bau
 
         ##
         # _Float_ -  Year one demand cost in the business as usual scenario (i.e no new system), us dollars
         #
-        attr_accessor :year_one_demand_cost_bau_us_dollars
+        attr_accessor :year_one_demand_cost_before_tax_bau
 
         ##
         # _Float_ -  Year one demand energy bill in the business as usual scenario (i.e no new system), us dollars
         #
-        attr_accessor :year_one_bill_bau_us_dollars
+        attr_accessor :year_one_bill_before_tax_bau
 
         ##
         # _Float_ -  Total lifetime demand costs in the business as usual scenario (i.e no new system) after tax, us dollars
         #
-        attr_accessor :total_demand_cost_bau_us_dollars
+        attr_accessor :lifecycle_demand_cost_after_tax_bau
 
         ##
         # _Float_ -  Total lifetime energy costs in the business as usual scenario (i.e no new system) after tax, us dollars
         #
-        attr_accessor :total_energy_cost_bau_us_dollars
+        attr_accessor :lifecycle_energy_cost_after_tax_bau
 
         ##
         # _Array_ - List of _SolarPV_ systems
@@ -162,16 +162,16 @@ module URBANopt
         attr_accessor :reopt_assumptions_file_path
 
         ##
-        # _Float_ - Annual percentage of electricity supplied by renewable sources
+        # _Float_ - Annual fraction of electricity supplied by renewable sources
         #
-        attr_accessor :annual_renewable_electricity_pct
+        attr_accessor :renewable_electricity_fraction
 
         ##
         # Initialize distributed generation system design and financial metrics.
         #
         # * Technologies include +:solar_pv+, +:wind+, +:generator+, and +:storage+.
-        # * Financial metrics include +:lcc_us_dollars+, +:npv_us_dollars+, +:year_one_energy_cost_us_dollars+, +:year_one_demand_cost_us_dollars+,
-        # +:year_one_bill_us_dollars+, and +:total_energy_cost_us_dollars+
+        # * Financial metrics include +:lcc+, +:npv+, +:year_one_energy_cost_before_tax+, +:year_one_demand_cost_before_tax+,
+        # +:year_one_bill_before_tax+, and +:lifecycle_energy_cost_after_tax+
         ##
         # [parameters:]
         #
@@ -180,20 +180,20 @@ module URBANopt
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }
 
-          @annual_renewable_electricity_pct = hash[:annual_renewable_electricity_pct]
-          @lcc_us_dollars = hash[:lcc_us_dollars]
-          @lcc_bau_us_dollars = hash[:lcc_bau_us_dollars]
-          @npv_us_dollars = hash[:npv_us_dollars]
-          @year_one_energy_cost_us_dollars = hash[:year_one_energy_cost_us_dollars]
-          @year_one_energy_cost_bau_us_dollars = hash[:year_one_energy_cost_bau_us_dollars]
-          @year_one_demand_cost_us_dollars = hash[:year_one_demand_cost_us_dollars]
-          @year_one_demand_cost_bau_us_dollars = hash[:year_one_demand_cost_bau_us_dollars]
-          @year_one_bill_us_dollars = hash[:year_one_bill_us_dollars]
-          @year_one_bill_bau_us_dollars = hash[:year_one_bill_bau_us_dollars]
-          @total_energy_cost_us_dollars = hash[:total_energy_cost_us_dollars]
-          @total_energy_cost_bau_us_dollars = hash[:total_energy_cost_bau_us_dollars]
-          @total_demand_cost_us_dollars = hash[:total_demand_cost_us_dollars]
-          @total_demand_cost_bau_us_dollars = hash[:total_demand_cost_bau_us_dollars]
+          @renewable_electricity_fraction = hash[:renewable_electricity_fraction]
+          @lcc = hash[:lcc]
+          @lcc_bau = hash[:lcc_bau]
+          @npv = hash[:npv]
+          @year_one_energy_cost_before_tax = hash[:year_one_energy_cost_before_tax]
+          @year_one_energy_cost_before_tax_bau = hash[:year_one_energy_cost_before_tax_bau]
+          @year_one_demand_cost_before_tax = hash[:year_one_demand_cost_before_tax]
+          @year_one_demand_cost_before_tax_bau = hash[:year_one_demand_cost_before_tax_bau]
+          @year_one_bill_before_tax = hash[:year_one_bill_before_tax]
+          @year_one_bill_before_tax_bau = hash[:year_one_bill_before_tax_bau]
+          @lifecycle_energy_cost_after_tax = hash[:lifecycle_energy_cost_after_tax]
+          @lifecycle_energy_cost_after_tax_bau = hash[:lifecycle_energy_cost_after_tax_bau]
+          @lifecycle_demand_cost_after_tax = hash[:lifecycle_demand_cost_after_tax]
+          @lifecycle_demand_cost_after_tax_bau = hash[:lifecycle_demand_cost_after_tax_bau]
 
           @resilience_hours_min = hash[:resilience_hours_min]
           @resilience_hours_max = hash[:resilience_hours_max]
@@ -345,22 +345,22 @@ module URBANopt
         def to_hash
           result = {}
           result[:reopt_assumptions_file_path] = @reopt_assumptions_file_path if @reopt_assumptions_file_path
-          result[:annual_renewable_electricity_pct] = @annual_renewable_electricity_pct if @annual_renewable_electricity_pct
-          result[:lcc_us_dollars] = @lcc_us_dollars if @lcc_us_dollars
-          result[:lcc_bau_us_dollars] = @lcc_bau_us_dollars if @lcc_bau_us_dollars
-          result[:npv_us_dollars] = @npv_us_dollars if @npv_us_dollars
-
-          result[:year_one_energy_cost_us_dollars] = @year_one_energy_cost_us_dollars if @year_one_energy_cost_us_dollars
-          result[:year_one_demand_cost_us_dollars] = @year_one_demand_cost_us_dollars if @year_one_demand_cost_us_dollars
-          result[:year_one_bill_us_dollars] = @year_one_bill_us_dollars if @year_one_bill_us_dollars
-          result[:total_demand_cost_us_dollars] = @total_demand_cost_us_dollars if @total_demand_cost_us_dollars
-          result[:total_energy_cost_us_dollars] = @total_energy_cost_us_dollars if @total_energy_cost_us_dollars
-
-          result[:year_one_energy_cost_bau_us_dollars] = @year_one_energy_cost_bau_us_dollars if @year_one_energy_cost_bau_us_dollars
-          result[:year_one_demand_cost_bau_us_dollars] = @year_one_demand_cost_bau_us_dollars if @year_one_demand_cost_bau_us_dollars
-          result[:year_one_bill_bau_us_dollars] = @year_one_bill_bau_us_dollars if @year_one_bill_bau_us_dollars
-          result[:total_energy_cost_bau_us_dollars] = @total_energy_cost_bau_us_dollars if @total_energy_cost_bau_us_dollars
-          result[:total_demand_cost_bau_us_dollars] = @total_demand_cost_bau_us_dollars if @total_demand_cost_bau_us_dollars
+          result[:renewable_electricity_fraction] = @renewable_electricity_fraction if @renewable_electricity_fraction
+          result[:lcc] = @lcc if @lcc
+          result[:lcc_bau] = @lcc_bau if @lcc_bau
+          result[:npv] = @npv if @npv
+
+          result[:year_one_energy_cost_before_tax] = @year_one_energy_cost_before_tax if @year_one_energy_cost_before_tax
+          result[:year_one_demand_cost_before_tax] = @year_one_demand_cost_before_tax if @year_one_demand_cost_before_tax
+          result[:year_one_bill_before_tax] = @year_one_bill_before_tax if @year_one_bill_before_tax
+          result[:lifecycle_demand_cost_after_tax] = @lifecycle_demand_cost_after_tax if @lifecycle_demand_cost_after_tax
+          result[:lifecycle_energy_cost_after_tax] = @lifecycle_energy_cost_after_tax if @lifecycle_energy_cost_after_tax
+
+          result[:year_one_energy_cost_before_tax_bau] = @year_one_energy_cost_before_tax_bau if @year_one_energy_cost_before_tax_bau
+          result[:year_one_demand_cost_before_tax_bau] = @year_one_demand_cost_before_tax_bau if @year_one_demand_cost_before_tax_bau
+          result[:year_one_bill_before_tax_bau] = @year_one_bill_before_tax_bau if @year_one_bill_before_tax_bau
+          result[:lifecycle_energy_cost_after_tax_bau] = @lifecycle_energy_cost_after_tax_bau if @lifecycle_energy_cost_after_tax_bau
+          result[:lifecycle_demand_cost_after_tax_bau] = @lifecycle_demand_cost_after_tax_bau if @lifecycle_demand_cost_after_tax_bau
 
           result[:total_solar_pv_kw] = @total_solar_pv_kw if @total_solar_pv_kw
           result[:total_wind_kw] = @total_wind_kw if @total_wind_kw
@@ -415,22 +415,22 @@ module URBANopt
         # Merge a distributed generation system with a new system
         ##
         def self.merge_distributed_generation(existing_dgen, new_dgen)
-          existing_dgen.annual_renewable_electricity_pct = add_values(existing_dgen.annual_renewable_electricity_pct, new_dgen.annual_renewable_electricity_pct)
-          existing_dgen.lcc_us_dollars = add_values(existing_dgen.lcc_us_dollars, new_dgen.lcc_us_dollars)
-          existing_dgen.lcc_bau_us_dollars = add_values(existing_dgen.lcc_bau_us_dollars, new_dgen.lcc_bau_us_dollars)
-          existing_dgen.npv_us_dollars = add_values(existing_dgen.npv_us_dollars, new_dgen.npv_us_dollars)
-
-          existing_dgen.year_one_energy_cost_us_dollars = add_values(existing_dgen.year_one_energy_cost_us_dollars, new_dgen.year_one_energy_cost_us_dollars)
-          existing_dgen.year_one_demand_cost_us_dollars = add_values(existing_dgen.year_one_demand_cost_us_dollars, new_dgen.year_one_demand_cost_us_dollars)
-          existing_dgen.year_one_bill_us_dollars = add_values(existing_dgen.year_one_bill_us_dollars, new_dgen.year_one_bill_us_dollars)
-          existing_dgen.total_energy_cost_us_dollars = add_values(existing_dgen.total_energy_cost_us_dollars, new_dgen.total_energy_cost_us_dollars)
-          existing_dgen.total_demand_cost_us_dollars = add_values(existing_dgen.total_demand_cost_us_dollars, new_dgen.total_demand_cost_us_dollars)
-
-          existing_dgen.year_one_energy_cost_bau_us_dollars = add_values(existing_dgen.year_one_energy_cost_bau_us_dollars, new_dgen.year_one_energy_cost_bau_us_dollars)
-          existing_dgen.year_one_demand_cost_bau_us_dollars = add_values(existing_dgen.year_one_demand_cost_bau_us_dollars, new_dgen.year_one_demand_cost_bau_us_dollars)
-          existing_dgen.year_one_bill_bau_us_dollars = add_values(existing_dgen.year_one_bill_bau_us_dollars, new_dgen.year_one_bill_bau_us_dollars)
-          existing_dgen.total_energy_cost_bau_us_dollars = add_values(existing_dgen.total_energy_cost_bau_us_dollars, new_dgen.total_energy_cost_bau_us_dollars)
-          existing_dgen.total_demand_cost_bau_us_dollars = add_values(existing_dgen.total_demand_cost_bau_us_dollars, new_dgen.total_demand_cost_bau_us_dollars)
+          existing_dgen.renewable_electricity_fraction = add_values(existing_dgen.renewable_electricity_fraction, new_dgen.renewable_electricity_fraction)
+          existing_dgen.lcc = add_values(existing_dgen.lcc, new_dgen.lcc)
+          existing_dgen.lcc_bau = add_values(existing_dgen.lcc_bau, new_dgen.lcc_bau)
+          existing_dgen.npv = add_values(existing_dgen.npv, new_dgen.npv)
+
+          existing_dgen.year_one_energy_cost_before_tax = add_values(existing_dgen.year_one_energy_cost_before_tax, new_dgen.year_one_energy_cost_before_tax)
+          existing_dgen.year_one_demand_cost_before_tax = add_values(existing_dgen.year_one_demand_cost_before_tax, new_dgen.year_one_demand_cost_before_tax)
+          existing_dgen.year_one_bill_before_tax = add_values(existing_dgen.year_one_bill_before_tax, new_dgen.year_one_bill_before_tax)
+          existing_dgen.lifecycle_energy_cost_after_tax = add_values(existing_dgen.lifecycle_energy_cost_after_tax, new_dgen.lifecycle_energy_cost_after_tax)
+          existing_dgen.lifecycle_demand_cost_after_tax = add_values(existing_dgen.lifecycle_demand_cost_after_tax, new_dgen.lifecycle_demand_cost_after_tax)
+
+          existing_dgen.year_one_energy_cost_before_tax_bau = add_values(existing_dgen.year_one_energy_cost_before_tax_bau, new_dgen.year_one_energy_cost_before_tax_bau)
+          existing_dgen.year_one_demand_cost_before_tax_bau = add_values(existing_dgen.year_one_demand_cost_before_tax_bau, new_dgen.year_one_demand_cost_before_tax_bau)
+          existing_dgen.year_one_bill_before_tax_bau = add_values(existing_dgen.year_one_bill_before_tax_bau, new_dgen.year_one_bill_before_tax_bau)
+          existing_dgen.lifecycle_energy_cost_after_tax_bau = add_values(existing_dgen.lifecycle_energy_cost_after_tax_bau, new_dgen.lifecycle_energy_cost_after_tax_bau)
+          existing_dgen.lifecycle_demand_cost_after_tax_bau = add_values(existing_dgen.lifecycle_demand_cost_after_tax_bau, new_dgen.lifecycle_demand_cost_after_tax_bau)
 
           existing_dgen.resilience_hours_min = add_values(existing_dgen.resilience_hours_min, new_dgen.resilience_hours_min)
           existing_dgen.resilience_hours_max = add_values(existing_dgen.resilience_hours_max, new_dgen.resilience_hours_max)
@@ -470,7 +470,7 @@ module URBANopt
 
           new_dgen.generator.each do |generator|
             existing_dgen.generator.push generator
-            if existing_dgen.total_wind_kw.nil?
+            if existing_dgen.total_generator_kw.nil?
               existing_dgen.total_generator_kw = generator.size_kw
             else
               existing_dgen.total_generator_kw += generator.size_kw

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

@@ -17,7 +17,7 @@ module URBANopt
                       :fans, :pumps, :heat_rejection, :humidification, :heat_recovery, :water_systems, :refrigeration, :generators # :nodoc:
 
         ##
-        # EndUse class intialize all enduse atributes: +:heating+ , +:cooling+ , +:interior_lighting+ ,
+        # EndUse class initialize all enduse attributes: +:heating+ , +:cooling+ , +:interior_lighting+ ,
         # +:exterior_lighting+ , +:interior_equipment+ , +:exterior_equipment+ ,
         # +:fans+ , +:pumps+ , +:heat_rejection+ , +:humidification+ , +:heat_recovery+ , +:water_systems+ , +:refrigeration+ , +:generators+
         ##

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

@@ -11,13 +11,13 @@ module URBANopt
   module Reporting
     module DefaultReports
       ##
-      # Enduses class inlclude results for each fuel type.
+      # Enduses class include results for each fuel type.
       ##
       class EndUses
         attr_accessor :electricity_kwh, :natural_gas_kwh, :propane_kwh, :fuel_oil_kwh, :other_fuels_kwh, :district_cooling_kwh, :district_heating_kwh, :water_qbft # :nodoc:
 
         ##
-        # EndUses class intialize end_uses(fuel type) attributes: +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ ,
+        # EndUses class initialize end_uses(fuel type) attributes: +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ ,
         # +:district_cooling_kwh+ , +:district_heating_kwh+ , +:water_qbft+
         ##
         # [parameters:]

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

@@ -55,7 +55,7 @@ module URBANopt
           # design_parameters to add later
           @construction_costs = []
           hash[:construction_costs].each do |cc|
-            @constructiion_costs << ConstructionCost.new(cc)
+            @construction_costs << ConstructionCost.new(cc)
           end
 
           @reporting_periods = []
@@ -212,7 +212,6 @@ module URBANopt
         def save(file_name = 'default_feature_report')
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
-
           # save the feature reports csv and json data
           old_timeseries_path = nil
           if !@timeseries_csv.path.nil?
@@ -298,7 +297,7 @@ module URBANopt
         ##
         # Saves the 'default_feature_report.csv' file to the results directory
         # This method only copies the CSV feature reports from the folder generated by the reporting measure
-        # (<meausure number>_default_feature_reports/) to the new feature_reports/ folder
+        # (<measure number>_default_feature_reports/) to the new feature_reports/ folder
         ##
         # [parameters]:
         # +file_name+ - _String_ - Assign a name to the saved feature report file without an extension

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

@@ -19,11 +19,11 @@ module URBANopt
         attr_accessor :size_kw
 
         ##
-        # Intialize Generator attributes from a hash. Generator attributes currently are limited to power capacity.
+        # Initialize Generator attributes from a hash. Generator attributes currently are limited to power capacity.
         ##
         # [parameters:]
         #
-        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        # * +hash+ - _Hash_ - A hash containing a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
         #
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }

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

@@ -12,7 +12,7 @@ module URBANopt
 
       @@logger.level = Logger::WARN
       ##
-      # Definining class variable "@@logger" to log errors, info and warning messages.
+      # Defining class variable "@@logger" to log errors, info and warning messages.
       def self.logger
         @@logger
       end

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

@@ -12,7 +12,7 @@ module URBANopt
   module Reporting
     module DefaultReports
       ##
-      # power_distributio include eletrical power distribution systems information.
+      # power_distribution include eletrical power distribution systems information.
       ##
       class PowerDistribution
         attr_accessor :under_voltage_hours, :over_voltage_hours, :nominal_capacity,
@@ -89,7 +89,7 @@ module URBANopt
         end
 
         ##
-        # Merges muliple power distribution results together.
+        # Merges multiple power distribution results together.
         ##
         # +new_costs+ - _Array_ - An array of ConstructionCost objects.
         def merge_power_distribution

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

@@ -16,9 +16,9 @@ module URBANopt
         ##
         # _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,
+        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
 
         ##
@@ -46,14 +46,11 @@ module URBANopt
           @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.
         ##
@@ -72,9 +69,9 @@ module URBANopt
           hash[:mechanical_system_efficiency] = nil
           hash[:total_qaqc_flags] = nil
 
-
           return hash
         end
+
         ##
         # Convert to a Hash equivalent for JSON serialization
         ##
@@ -99,7 +96,6 @@ module URBANopt
           end
 
           return result
-
         end
 
         ##
@@ -126,7 +122,6 @@ module URBANopt
         # +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)
@@ -138,9 +133,7 @@ module URBANopt
           @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

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

@@ -24,9 +24,9 @@ module URBANopt
                       :fuel_type, :total_cost_dollar, :usage_cost_dollar, :demand_cost_dollar, :comfort_result, :time_setpoint_not_met_during_occupied_cooling,
                       :time_setpoint_not_met_during_occupied_heating, :time_setpoint_not_met_during_occupied_hours, :hours_out_of_comfort_bounds_PMV, :hours_out_of_comfort_bounds_PPD,
                       :emissions, :future_annual_electricity_emissions_mt, :future_hourly_electricity_emissions_mt, :historical_annual_electricity_emissions_mt, :historical_hourly_electricity_emissions_mt,
-                      :future_annual_electricity_emissions_intensity_kg_per_ft2, :future_hourly_electricity_emissions_intensity_kg_per_ft2, :historical_annual_electricity_emissions_intensity_kg_per_ft2, :historical_hourly_electricity_emissions_intensity_kg_per_ft2 ,
+                      :future_annual_electricity_emissions_intensity_kg_per_ft2, :future_hourly_electricity_emissions_intensity_kg_per_ft2, :historical_annual_electricity_emissions_intensity_kg_per_ft2, :historical_hourly_electricity_emissions_intensity_kg_per_ft2,
                       :natural_gas_emissions_mt, :natural_gas_emissions_intensity_kg_per_ft2, :propane_emissions_mt, :propane_emissions_intensity_kg_per_ft2,
-                      :fueloil_no2_emissions_mt, :fueloil_no2_emissions_intensity_kg_per_ft2  #:nodoc:
+                      :fueloil_no2_emissions_mt, :fueloil_no2_emissions_intensity_kg_per_ft2 #:nodoc:
 
         # ReportingPeriod class initializes the reporting period attributes:
         # +:id+ , +:name+ , +:multiplier+ , +:start_date+ , +:end_date+ , +:month+ , +:day_of_month+ , +:year+ , +:total_site_energy_kwh+ , +:total_source_energy_kwh+ , +:site_EUI_kwh_per_m2+, +:site_EUI_kbtu_per_ft2+, +:source_EUI_kwh_per_m2+, +:source_EUI_kbtu_per_ft2+,
@@ -123,11 +123,11 @@ module URBANopt
           hash[:comfort_result] = { time_setpoint_not_met_during_occupied_cooling: nil, time_setpoint_not_met_during_occupied_heating: nil,
                                     time_setpoint_not_met_during_occupied_hours: nil, hours_out_of_comfort_bounds_PMV: nil, hours_out_of_comfort_bounds_PPD: nil }
           hash[:emissions] = { future_annual_electricity_emissions_mt: nil, future_hourly_electricity_emissions_mt: nil, historical_annual_electricity_emissions_mt: nil,
-                              historical_hourly_electricity_emissions_mt: nil, future_annual_electricity_emissions_intensity_kg_per_ft2: nil,
-                              future_hourly_electricity_emissions_intensity_kg_per_ft2: nil, historical_annual_electricity_emissions_intensity_kg_per_ft2: nil,
-                              historical_hourly_electricity_emissions_intensity_kg_per_ft2: nil, natural_gas_emissions_mt: nil,
-                              natural_gas_emissions_intensity_kg_per_ft2: nil, propane_emissions_mt: nil, propane_emissions_intensity_kg_per_ft2: nil,
-                              fueloil_no2_emissions_mt: nil, fueloil_no2_emissions_intensity_kg_per_ft2: nil }
+                               historical_hourly_electricity_emissions_mt: nil, future_annual_electricity_emissions_intensity_kg_per_ft2: nil,
+                               future_hourly_electricity_emissions_intensity_kg_per_ft2: nil, historical_annual_electricity_emissions_intensity_kg_per_ft2: nil,
+                               historical_hourly_electricity_emissions_intensity_kg_per_ft2: nil, natural_gas_emissions_mt: nil,
+                               natural_gas_emissions_intensity_kg_per_ft2: nil, propane_emissions_mt: nil, propane_emissions_intensity_kg_per_ft2: nil,
+                               fueloil_no2_emissions_mt: nil, fueloil_no2_emissions_intensity_kg_per_ft2: nil }
 
           return hash
         end

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

@@ -9,169 +9,165 @@ require 'json'
 require 'json-schema'
 
 module URBANopt
-    module Reporting
-        module DefaultReports
-            ##
-            # scenario_power_distribution_cost include eletrical power distribution system violation and
-            # upgrade cost information.
-            ##
-            class ScenarioPowerDistributionCost
-                attr_accessor :results, :outputs, :violation_summary, :costs_per_equipment, :equipment
-
-                ##
-                # ScenarioPowerDistributionCost class initializes all
-                # scenario_power_distribution_cost attributes:
-                # +:results+, +:outputs+, +:violation_summary+, +:costs_per_equipment+, +:equipment+
-                ##
-                def initialize(hash = {})
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-
-                  @results = hash[:results]
-                  @outputs = hash[:outputs]
-                  @violation_summary = hash[:violation_summary]
-                  @costs_per_equipment = hash[:costs_per_equipment]
-                  @equipment = hash[:equipment]
-
-                  # initialize class variables @@validator and @@schema
-                  @@validator ||= Validator.new
-                  @@schema ||= @@validator.schema
-                end
-
-                ##
-                # Assigns default values if attribute values do not exist.##
-                def defaults
-                  hash = {}
-                  hash[:results] = []
-                  hash[:outputs] = {}
-                  hash[:violation_summary] = []
-                  hash[:costs_per_equipment] = []
-                  hash[:equipment] = []
-
-                  return hash
-                end
-
-                ##
-                # Converts to a Hash equivalent for JSON serialization.
-                ##
-                # - Exclude attributes with nil values.
-                # - Validate power_distribution_cost hash properties against schema.
-                ##
-                def to_hash
-                  result = {}
-                  result[:results] = @results if @results
-                  result[:outputs] = @outputs if !@outputs.empty?
-                  result[:violation_summary] = @violation_summary if @violation_summary
-                  result[:costs_per_equipment] = @costs_per_equipment if @costs_per_equipment
-                  result[:equipment] = @equipment if @equipment
-
-                  # validate power_distribution_cost properties against schema
-                  if @@validator.validate(@@schema[:definitions][:ScenarioPowerDistributionCost][:properties], result).any?
-                    raise "scenario_power_distribution_cost properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ScenarioPowerDistributionCost][:properties], result)}"
-                  end
-
-                  return result
-                end
-
-                ##
-                # Add a result
-                ##
-                def add_result(hash = {})
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-                  result = {}
-                  result['num_violations'] = hash[:num_violations]
-                  @results << result
-                end
-
-                ##
-                ## Add outputs
-                ##
-                def add_outputs(hash = {})
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-                  output = {}
-                  output['log_file'] = hash[:log_file]
-                  output['jobs'] = []
-                  hash[:jobs].each do |job|
-                    output['jobs'] << job
-                  end
-                  @outputs = output
-                end
-
-                ##
-                ## Add a violation summary
-                ##
-                def add_violation_summary(hash = {})
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-                  violation_summary = {}
-                  violation_summary['scenario'] = hash[:scenario]
-                  violation_summary['stage'] = hash[:stage]
-                  violation_summary['upgrade_type'] = hash[:upgrade_type]
-                  violation_summary['simulation_time_s'] = hash[:simulation_time_s]
-                  violation_summary['thermal_violations_present'] = hash[:thermal_violations_present]
-                  violation_summary['voltage_violations_present'] = hash[:voltage_violations_present]
-                  violation_summary['max_bus_voltage'] = hash[:max_bus_voltage]
-                  violation_summary['min_bus_voltage'] = hash[:min_bus_voltage]
-                  violation_summary['num_voltage_violation_buses'] = hash[:num_voltage_violation_buses]
-                  violation_summary['num_overvoltage_violation_buses'] = hash[:num_overvoltage_violation_buses]
-                  violation_summary['voltage_upper_limit'] = hash[:voltage_upper_limit]
-                  violation_summary['num_undervoltage_violation_buses'] = hash[:num_undervoltage_violation_buses]
-                  violation_summary['voltage_lower_limit'] = hash[:voltage_lower_limit]
-                  violation_summary['max_line_loading'] = hash[:max_line_loading]
-                  violation_summary['max_transformer_loading'] = hash[:max_transformer_loading]
-                  violation_summary['num_line_violations'] = hash[:num_line_violations]
-                  violation_summary['line_upper_limit'] = hash[:line_upper_limit]
-                  violation_summary['num_transformer_violations'] = hash[:num_transformer_violations]
-                  violation_summary['transformer_upper_limit'] = hash[:transformer_upper_limit]
-
-                  @violation_summary << violation_summary
-                end
-
-                ##
-                # Add costs per equipment
-                ##
-                def add_costs_per_equipment
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-                  costs_per_equipment = {}
-                  costs_per_equipment['name'] = hash[:name]
-                  costs_per_equipment['type'] = hash[:type]
-                  costs_per_equipment['count'] = hash[:count]
-                  costs_per_equipment['total_cost_usd'] = hash[:costs_per_equipment]
-
-                  @costs_per_equipment << costs_per_equipment
-                end
-
-                ##
-                # Add equipment
-                ##
-                def add_equipment
-                  hash.delete_if { |k, v| v.nil? }
-                  hash = defaults.merge(hash)
-                  equipment = {}
-                  equipment['equipment_type'] = hash[:equipment_type]
-                  equipment['equipment_name'] = hash[:equipment_name]
-                  equipment['status'] = hash[:status]
-                  equipment['parameter1_name'] = hash[:parameter1_name]
-                  equipment['parameter1_original'] = hash[:parameter1_original]
-                  equipment['parameter1_upgraded'] = hash[:parameter1_upgraded]
-                  equipment['parameter2_name'] = hash[:parameter2_name]
-                  equipment['parameter2_original'] = hash[:parameter2_original]
-                  equipment['parameter2_upgraded'] = hash[:parameter2_upgraded]
-                  equipment['parameter3_name'] = hash[:parameter3_name]
-                  equipment['parameter3_original'] = hash[:parameter3_original]
-                  equipment['parameter3_upgraded'] = hash[:parameter3_upgraded]
-                  equipment['name'] = hash[:name]
-
-                  @equipment << equipment
-                end
-
-
-
-            end # ScenarioPowerDistributionCost
-
-        end # DefaultReports
-    end # Reporting
-end # URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # scenario_power_distribution_cost include eletrical power distribution system violation and
+      # upgrade cost information.
+      ##
+      class ScenarioPowerDistributionCost
+        attr_accessor :results, :outputs, :violation_summary, :costs_per_equipment, :equipment
+
+        ##
+        # ScenarioPowerDistributionCost class initializes all
+        # scenario_power_distribution_cost attributes:
+        # +:results+, +:outputs+, +:violation_summary+, +:costs_per_equipment+, +:equipment+
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @results = hash[:results]
+          @outputs = hash[:outputs]
+          @violation_summary = hash[:violation_summary]
+          @costs_per_equipment = hash[:costs_per_equipment]
+          @equipment = hash[:equipment]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Assigns default values if attribute values do not exist.##
+        def defaults
+          hash = {}
+          hash[:results] = []
+          hash[:outputs] = {}
+          hash[:violation_summary] = []
+          hash[:costs_per_equipment] = []
+          hash[:equipment] = []
+
+          return hash
+        end
+
+        ##
+        # Converts to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate power_distribution_cost hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:results] = @results if @results
+          result[:outputs] = @outputs if !@outputs.empty?
+          result[:violation_summary] = @violation_summary if @violation_summary
+          result[:costs_per_equipment] = @costs_per_equipment if @costs_per_equipment
+          result[:equipment] = @equipment if @equipment
+
+          # validate power_distribution_cost properties against schema
+          if @@validator.validate(@@schema[:definitions][:ScenarioPowerDistributionCost][:properties], result).any?
+            raise "scenario_power_distribution_cost properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ScenarioPowerDistributionCost][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Add a result
+        ##
+        def add_result(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          result = {}
+          result['num_violations'] = hash[:num_violations]
+          @results << result
+        end
+
+        ##
+        ## Add outputs
+        ##
+        def add_outputs(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          output = {}
+          output['log_file'] = hash[:log_file]
+          output['jobs'] = []
+          hash[:jobs].each do |job|
+            output['jobs'] << job
+          end
+          @outputs = output
+        end
+
+        ##
+        ## Add a violation summary
+        ##
+        def add_violation_summary(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          violation_summary = {}
+          violation_summary['scenario'] = hash[:scenario]
+          violation_summary['stage'] = hash[:stage]
+          violation_summary['upgrade_type'] = hash[:upgrade_type]
+          violation_summary['simulation_time_s'] = hash[:simulation_time_s]
+          violation_summary['thermal_violations_present'] = hash[:thermal_violations_present]
+          violation_summary['voltage_violations_present'] = hash[:voltage_violations_present]
+          violation_summary['max_bus_voltage'] = hash[:max_bus_voltage]
+          violation_summary['min_bus_voltage'] = hash[:min_bus_voltage]
+          violation_summary['num_voltage_violation_buses'] = hash[:num_voltage_violation_buses]
+          violation_summary['num_overvoltage_violation_buses'] = hash[:num_overvoltage_violation_buses]
+          violation_summary['voltage_upper_limit'] = hash[:voltage_upper_limit]
+          violation_summary['num_undervoltage_violation_buses'] = hash[:num_undervoltage_violation_buses]
+          violation_summary['voltage_lower_limit'] = hash[:voltage_lower_limit]
+          violation_summary['max_line_loading'] = hash[:max_line_loading]
+          violation_summary['max_transformer_loading'] = hash[:max_transformer_loading]
+          violation_summary['num_line_violations'] = hash[:num_line_violations]
+          violation_summary['line_upper_limit'] = hash[:line_upper_limit]
+          violation_summary['num_transformer_violations'] = hash[:num_transformer_violations]
+          violation_summary['transformer_upper_limit'] = hash[:transformer_upper_limit]
+
+          @violation_summary << violation_summary
+        end
+
+        ##
+        # Add costs per equipment
+        ##
+        def add_costs_per_equipment
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          costs_per_equipment = {}
+          costs_per_equipment['name'] = hash[:name]
+          costs_per_equipment['type'] = hash[:type]
+          costs_per_equipment['count'] = hash[:count]
+          costs_per_equipment['total_cost_usd'] = hash[:costs_per_equipment]
+
+          @costs_per_equipment << costs_per_equipment
+        end
+
+        ##
+        # Add equipment
+        ##
+        def add_equipment
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+          equipment = {}
+          equipment['equipment_type'] = hash[:equipment_type]
+          equipment['equipment_name'] = hash[:equipment_name]
+          equipment['status'] = hash[:status]
+          equipment['parameter1_name'] = hash[:parameter1_name]
+          equipment['parameter1_original'] = hash[:parameter1_original]
+          equipment['parameter1_upgraded'] = hash[:parameter1_upgraded]
+          equipment['parameter2_name'] = hash[:parameter2_name]
+          equipment['parameter2_original'] = hash[:parameter2_original]
+          equipment['parameter2_upgraded'] = hash[:parameter2_upgraded]
+          equipment['parameter3_name'] = hash[:parameter3_name]
+          equipment['parameter3_original'] = hash[:parameter3_original]
+          equipment['parameter3_upgraded'] = hash[:parameter3_upgraded]
+          equipment['name'] = hash[:name]
+
+          @equipment << equipment
+        end
+      end
+    end
+  end
+end

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

@@ -33,7 +33,7 @@ module URBANopt
                       :timeseries_csv, :location, :program, :construction_costs, :reporting_periods, :feature_reports, :distributed_generation,
                       :scenario_power_distribution, :scenario_power_distribution_cost, :qaqc_flags # :nodoc:
 
-        # ScenarioReport class intializes the scenario report attributes:
+        # ScenarioReport class initializes the scenario report attributes:
         # +:id+ , +:name+ , +:directory_name+, +:timesteps_per_hour+ , +:number_of_not_started_simulations+ ,
         # +:number_of_started_simulations+ , +:number_of_complete_simulations+ , +:number_of_failed_simulations+ ,
         # +:timeseries_csv+ , +:location+ , +:program+ , +:construction_costs+ , +:reporting_periods+ , +:feature_reports+,
@@ -74,7 +74,7 @@ module URBANopt
             @reporting_periods << ReportingPeriod.new(rp)
           end
 
-          # feature_report is intialized here to be used in the add_feature_report method
+          # feature_report is initialized here to be used in the add_feature_report method
           @feature_reports = []
           hash[:feature_reports].each do |fr|
             @feature_reports << FeatureReport.new(fr)
@@ -246,7 +246,7 @@ module URBANopt
         # - add the array of feature_reports
         # - scenario report location takes the location of the first feature in the list
         ##
-        # [parmeters:]
+        # [parameters:]
         # +feature_report+ - _FeatureReport_ - An object of FeatureReport class.
         ##
         def add_feature_report(feature_report)

data/lib/urbanopt/reporting/default_reports/schema/scenario_schema.json

@@ -412,32 +412,73 @@
           "description": "File path of REopt assumptions file used to generate results, if known",
           "type": "string"
         },
-        "annual_renewable_electricity_pct": {
-          "description": "Percentage of annual renewable electricity generation",
+        "renewable_electricity_fraction": {
+          "description": "Fraction of annual renewable electricity generation",
           "type": "number"
         },
-        "lcc_us_dollars": {
-          "description": "Optimal lifecycle cost",
+        "lcc": {
+          "description": "Lifecycle costs for the complete distributed generation system",
+          "units": "dollars",
           "type": "number"
         },
-        "npv_us_dollars": {
-          "description": "Net present value of savings realized by the project",
+        "lcc_bau": {
+          "description": "Lifecycle cost in the business as usual scenario (i.e no new system)",
+          "units": "dollars",
           "type": "number"
         },
-        "year_one_energy_cost_us_dollars": {
-          "description": "Optimal year one utility energy cost",
+        "npv": {
+          "description": "Net present value of the complete distributed generation system",
+          "units": "dollars",
           "type": "number"
         },
-        "year_one_demand_cost_us_dollars": {
-          "description": "Optimal year one utility demand cost",
+        "lifecycle_demand_cost_after_tax": {
+          "description": "Total demand costs in US Dollars over the life of the system after tax",
+          "units": "dollars",
           "type": "number"
         },
-        "year_one_bill_us_dollars": {
-          "description": "Optimal year one utility bill",
+        "year_one_energy_cost_before_tax": {
+          "description": "Total amount paid for utility energy in US Dollars in the first year of operation",
+          "units": "dollars",
           "type": "number"
         },
-        "total_energy_cost_us_dollars": {
-          "description": "Total utility energy cost over the lifecycle, after-tax",
+        "year_one_energy_cost_before_tax_bau": {
+          "description": "Year one energy cost in the business as usual scenario (i.e no new system) before tax",
+          "units": "dollars",
+          "type": "number"
+        },
+        "year_one_demand_cost_before_tax": {
+          "description": "Total amount paid in utility demand charges in US Dollars in the first year of operation",
+          "units": "dollars",
+          "type": "number"
+        },
+        "year_one_demand_cost_before_tax_bau": {
+          "description": "Year one demand cost in the business as usual scenario (i.e no new system) before tax",
+          "units": "dollars",
+          "type": "number"
+        },
+        "year_one_bill_before_tax": {
+          "description": "Total amount paid to the utility in US Dollars in the first year of operation",
+          "units": "dollars",
+          "type": "number"
+        },
+        "year_one_bill_before_tax_bau": {
+          "description": "Year one bill in the business as usual scenario (i.e no new system) before tax",
+          "units": "dollars",
+          "type": "number"
+        },
+        "lifecycle_energy_cost_after_tax": {
+          "description": "Total energy costs in US Dollars over the life of the system after tax",
+          "units": "dollars",
+          "type": "number"
+        },
+        "lifecycle_demand_cost_after_tax_bau": {
+          "description": "Total demand costs in US Dollars over the life of the system in the business as usual scenario (i.e no new system) after tax",
+          "units": "dollars",
+          "type": "number"
+        },
+        "lifecycle_energy_cost_after_tax_bau": {
+          "description": "Total energy costs in US Dollars over the life of the system in the business as usual scenario (i.e no new system) after tax",
+          "units": "dollars",
           "type": "number"
         },
         "SolarPV": {
@@ -678,7 +719,7 @@
           ]
         },
         "simultaneous_heating_and_cooling": {
-          "description": "Whether heating and cooling are occuring during the same hour when cooling load exists",
+          "description": "Whether heating and cooling are occurring during the same hour when cooling load exists",
           "type": [
             "integer",
             "null"
@@ -743,7 +784,7 @@
           "type": "string"
         },
         "name": {
-          "description": "name refers to the name of the feature (eg. Building 1, tranformer 5)",
+          "description": "name refers to the name of the feature (eg. Building 1, transformer 5)",
           "type": "string"
         },
         "directory_name": {
@@ -829,7 +870,7 @@
           "type": "string"
         },
         "multiplier": {
-          "description": "Multiplier used if this reporting period is representative of mulitple periods.  For example one week simulation that represents entire month.",
+          "description": "Multiplier used if this reporting period is representative of multiple periods.  For example one week simulation that represents entire month.",
           "type": "number",
           "default": 1
         },

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

@@ -24,7 +24,7 @@ module URBANopt
         ##
         # [parameters:]
         #
-        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        # * +hash+ - _Hash_ - A hash containing a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
         #
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }

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

@@ -28,7 +28,7 @@ module URBANopt
         ##
         # [parameters:]
         #
-        # * +hash+ - _Hash_ - A hash containting +:size_kw+ and +:size_kwh+ key/value pair which represents the power and storage capacity in kilowatts (kW) and kilowatt-hours respectively.
+        # * +hash+ - _Hash_ - A hash containing +:size_kw+ and +:size_kwh+ key/value pair which represents the power and storage capacity in kilowatts (kW) and kilowatt-hours respectively.
         #
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }

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

@@ -14,7 +14,7 @@ module URBANopt
   module Reporting
     module DefaultReports
       ##
-      # TimeseriesCSV include timesries reults reported in a CSV file.
+      # TimeseriesCSV include timesries results reported in a CSV file.
       ##
       class TimeseriesCSV
         attr_accessor :path, :first_report_datetime, :column_names #:nodoc:
@@ -33,7 +33,7 @@ module URBANopt
           @path = hash[:path]
           @first_report_datetime = hash[:first_report_datetime]
 
-          # from scenario csv shema get required reults to be aggregated
+          # from scenario csv shema get required results to be aggregated
           @required_column_names = load_scenario_csv_schema_headers
 
           @column_names = hash[:column_names]

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

@@ -23,7 +23,7 @@ module URBANopt
         ##
         # [parameters:]
         #
-        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        # * +hash+ - _Hash_ - A hash containing a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
         #
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }

data/lib/urbanopt/reporting/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler