urbanopt-reporting 0.1.1 → 0.3.2

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -224,30 +224,35 @@ module URBANopt
         end
 
         ##
-        # Saves the 'default_feature_report.json' and 'default_feature_report.csv' files
+        # Calls the individual functions to save 'default_feature_report.json' and 'default_feature_report.csv'
+        # For backward compatibility and ease of use
         ##
         # [parameters]:
-        # +file_name+ - _String_ - Assign a name to the saved feature report results file without an extension
+        # +file_name+ - _String_ - Assign a name to the saved feature report file without an extension
         def save_feature_report(file_name = 'default_feature_report')
+          save_json_report(file_name)
+          save_csv_report(file_name)
+        end
+
+        ##
+        # Saves the 'default_feature_report.json' file to the results directory
+        ##
+        # [parameters]:
+        # +file_name+ - _String_ - Assign a name to the saved feature report file without an extension
+        def save_json_report(file_name = 'default_feature_report')
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
 
+          # define the results_dir_path
+          results_dir_path = File.join(@directory_name, 'feature_reports')
           # create feature reports directory
-          Dir.mkdir(File.join(@directory_name, 'feature_reports')) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
-
-          # save the csv data
-          old_timeseries_path = nil
-          if !@timeseries_csv.path.nil?
-            old_timeseries_path = @timeseries_csv.path
-          end
-
-          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
-          @timeseries_csv.save_data
+          Dir.mkdir(results_dir_path) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
 
+          ## save json rport
           # feature_hash
           feature_hash = to_hash
 
-          json_name_path = File.join(@directory_name, 'feature_reports', file_name + '.json')
+          json_name_path = File.join(results_dir_path, file_name + '.json')
 
           File.open(json_name_path, 'w') do |f|
             f.puts JSON.pretty_generate(feature_hash)
@@ -258,13 +263,31 @@ module URBANopt
               f.flush
             end
           end
+        end
 
-          if !old_timeseries_path.nil?
-            @timeseries_csv.path = old_timeseries_path
-          else
-            @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+        ##
+        # Saves the 'default_feature_report.csv' file to the results directory
+        ##
+        # [parameters]:
+        # +file_name+ - _String_ - Assign a name to the saved feature report file without an extension
+        def save_csv_report(file_name = 'default_feature_report')
+          # reassign the initialize local variable @file_name to the file name input.
+          @file_name = file_name
+
+          # define the results_dir_path
+          results_dir_path = File.join(@directory_name, 'feature_reports')
+          # create feature reports directory
+          Dir.mkdir(results_dir_path) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
+
+          ## copy CSV report to the new feature_reports folder
+          # get all folder names in the feature diectory
+          directory_folders = Dir.glob "#{@directory_name}/*/"
+          # copy the CSV report to the new feature_reports folder
+          directory_folders.each do |f|
+            if f.include? '_default_feature_reports'
+              FileUtils.cp(File.join(f, 'default_feature_reports.csv'), File.join(results_dir_path, @file_name + '.csv'))
+            end
           end
-          return true
         end
       end
     end

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -60,7 +60,7 @@ module URBANopt
           @@schema ||= @@validator.schema
 
           # initialize @@logger
-          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+          @@logger ||= URBANopt::Reporting::DefaultReports.logger
         end
 
         ##

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -39,9 +39,9 @@ module URBANopt
       # Location include all location information.
       ##
       class Location
-        attr_accessor :latitude, :longitude, :surface_elevation, :weather_filename #:nodoc:
+        attr_accessor :latitude_deg, :longitude_deg, :surface_elevation_ft, :weather_filename #:nodoc:
         ##
-        # Location class initialize location attributes: +:latitude+ , +:longitude+ , +:surface_elevation+ , +:weather_filename+
+        # Location class initialize location attributes: +:latitude_deg+ , +:longitude_deg+ , +:surface_elevation_ft+ , +:weather_filename+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized location.
@@ -50,9 +50,9 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
           hash = defaults.merge(hash)
 
-          @latitude = hash[:latitude]
-          @longitude = hash[:longitude]
-          @surface_elevation = hash[:surface_elevation]
+          @latitude_deg = hash[:latitude_deg]
+          @longitude_deg = hash[:longitude_deg]
+          @surface_elevation_ft = hash[:surface_elevation_ft]
           @weather_filename = hash[:weather_filename]
 
           # initialize class variables @@validator and @@schema
@@ -68,9 +68,9 @@ module URBANopt
         ##
         def to_hash
           result = {}
-          result[:latitude] = @latitude if @latitude
-          result[:longitude] = @longitude if @longitude
-          result[:surface_elevation] = @surface_elevation if @surface_elevation
+          result[:latitude_deg] = @latitude_deg if @latitude_deg
+          result[:longitude_deg] = @longitude_deg if @longitude_deg
+          result[:surface_elevation_ft] = @surface_elevation_ft if @surface_elevation_ft
           result[:weather_filename] = @weather_filename if @weather_filename
 
           # validate location properties against schema
@@ -86,9 +86,9 @@ module URBANopt
         ##
         def defaults
           hash = {}
-          hash[:latitude] = nil
-          hash[:longitude] = nil
-          hash[:surface_elevation] = nil
+          hash[:latitude_deg] = nil
+          hash[:longitude_deg] = nil
+          hash[:surface_elevation_ft] = nil
           hash[:weather_filename] = nil
 
           return hash

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

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

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

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

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -40,18 +40,18 @@ module URBANopt
       # Program includes all building program related information.
       ##
       class Program
-        attr_accessor :site_area, :floor_area, :conditioned_area, :unconditioned_area, :footprint_area, :maximum_roof_height,
-                      :maximum_number_of_stories, :maximum_number_of_stories_above_ground, :parking_area, :number_of_parking_spaces,
-                      :number_of_parking_spaces_charging, :parking_footprint_area, :maximum_parking_height, :maximum_number_of_parking_stories,
+        attr_accessor :site_area_sqft, :floor_area_sqft, :conditioned_area_sqft, :unconditioned_area_sqft, :footprint_area_sqft, :maximum_roof_height_ft,
+                      :maximum_number_of_stories, :maximum_number_of_stories_above_ground, :parking_area_sqft, :number_of_parking_spaces,
+                      :number_of_parking_spaces_charging, :parking_footprint_area_sqft, :maximum_parking_height_ft, :maximum_number_of_parking_stories,
                       :maximum_number_of_parking_stories_above_ground, :number_of_residential_units, :building_types, :building_type, :maximum_occupancy,
-                      :area, :window_area, :north_window_area, :south_window_area, :east_window_area, :west_window_area, :wall_area, :roof_area, :equipment_roof_area,
-                      :photovoltaic_roof_area, :available_roof_area, :total_roof_area, :orientation, :aspect_ratio, :total_construction_cost # :nodoc:
-        # Program class initialize building program attributes: +:site_area+ , +:floor_area+ , +:conditioned_area+ , +:unconditioned_area+ ,
-        # +:footprint_area+ , +:maximum_roof_height, +:maximum_number_of_stories+ , +:maximum_number_of_stories_above_ground+ , +:parking_area+ ,
-        # +:number_of_parking_spaces+ , +:number_of_parking_spaces_charging+ , +:parking_footprint_area+ , +:maximum_parking_height+ , +:maximum_number_of_parking_stories+ ,
+                      :area_sqft, :window_area_sqft, :north_window_area_sqft, :south_window_area_sqft, :east_window_area_sqft, :west_window_area_sqft, :wall_area_sqft, :roof_area_sqft, :equipment_roof_area_sqft,
+                      :photovoltaic_roof_area_sqft, :available_roof_area_sqft, :total_roof_area_sqft, :orientation_deg, :aspect_ratio, :total_construction_cost_dollar # :nodoc:
+        # Program class initialize building program attributes: +:site_area_sqft+ , +:floor_area_sqft+ , +:conditioned_area_sqft+ , +:unconditioned_area_sqft+ ,
+        # +:footprint_area_sqft+ , +:maximum_roof_height_ft, +:maximum_number_of_stories+ , +:maximum_number_of_stories_above_ground+ , +:parking_area_sqft+ ,
+        # +:number_of_parking_spaces+ , +:number_of_parking_spaces_charging+ , +:parking_footprint_area_sqft+ , +:maximum_parking_height_ft+ , +:maximum_number_of_parking_stories+ ,
         # +:maximum_number_of_parking_stories_above_ground+ , +:number_of_residential_units+ , +:building_types+ , +:building_type+ , +:maximum_occupancy+ ,
-        # +:area+ , +:window_area+ , +:north_window_area+ , +:south_window_area+ , +:east_window_area+ , +:west_window_area+ , +:wall_area+ , +:roof_area+ ,
-        # +:equipment_roof_area+ , +:photovoltaic_roof_area+ , +:available_roof_area+ , +:total_roof_area+ , +:orientation+ , +:aspect_ratio+
+        # +:area_sqft+ , +:window_area_sqft+ , +:north_window_area_sqft+ , +:south_window_area_sqft+ , +:east_window_area_sqft+ , +:west_window_area_sqft+ , +:wall_area_sqft+ , +:roof_area_sqft+ ,
+        # +:equipment_roof_area_sqft+ , +:photovoltaic_roof_area_sqft+ , +:available_roof_area_sqft+ , +:total_roof_area_sqft+ , +:orientation_deg+ , +:aspect_ratio+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized program.
@@ -60,29 +60,29 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
           hash = defaults.merge(hash)
 
-          @site_area = hash[:site_area]
-          @floor_area = hash[:floor_area]
-          @conditioned_area = hash[:conditioned_area]
-          @unconditioned_area = hash[:unconditioned_area]
-          @footprint_area = hash[:footprint_area]
-          @maximum_roof_height = hash[:maximum_roof_height]
+          @site_area_sqft = hash[:site_area_sqft]
+          @floor_area_sqft = hash[:floor_area_sqft]
+          @conditioned_area_sqft = hash[:conditioned_area_sqft]
+          @unconditioned_area_sqft = hash[:unconditioned_area_sqft]
+          @footprint_area_sqft = hash[:footprint_area_sqft]
+          @maximum_roof_height_ft = hash[:maximum_roof_height_ft]
           @maximum_number_of_stories = hash[:maximum_number_of_stories]
           @maximum_number_of_stories_above_ground = hash[:maximum_number_of_stories_above_ground]
-          @parking_area = hash[:parking_area]
+          @parking_area_sqft = hash[:parking_area_sqft]
           @number_of_parking_spaces = hash[:number_of_parking_spaces]
           @number_of_parking_spaces_charging = hash[:number_of_parking_spaces_charging]
-          @parking_footprint_area = hash[:parking_footprint_area]
-          @maximum_parking_height = hash[:maximum_parking_height]
+          @parking_footprint_area_sqft = hash[:parking_footprint_area_sqft]
+          @maximum_parking_height_ft = hash[:maximum_parking_height_ft]
           @maximum_number_of_parking_stories = hash[:maximum_number_of_parking_stories]
           @maximum_number_of_parking_stories_above_ground = hash[:maximum_number_of_parking_stories_above_ground]
           @number_of_residential_units = hash[:number_of_residential_units]
           @building_types = hash[:building_types]
-          @window_area = hash[:window_area]
-          @wall_area = hash[:wall_area]
-          @roof_area = hash[:roof_area]
-          @orientation = hash[:orientation]
+          @window_area_sqft = hash[:window_area_sqft]
+          @wall_area_sqft = hash[:wall_area_sqft]
+          @roof_area_sqft = hash[:roof_area_sqft]
+          @orientation_deg = hash[:orientation_deg]
           @aspect_ratio = hash[:aspect_ratio]
-          @total_construction_cost = hash[:total_construction_cost]
+          @total_construction_cost_dollar = hash[:total_construction_cost_dollar]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -94,29 +94,29 @@ module URBANopt
         ##
         def defaults
           hash = {}
-          hash[:site_area] = nil
-          hash[:floor_area] = nil
-          hash[:conditioned_area] = nil
-          hash[:unconditioned_area] = nil
-          hash[:footprint_area] = nil
-          hash[:maximum_roof_height] = nil
+          hash[:site_area_sqft] = nil
+          hash[:floor_area_sqft] = nil
+          hash[:conditioned_area_sqft] = nil
+          hash[:unconditioned_area_sqft] = nil
+          hash[:footprint_area_sqft] = nil
+          hash[:maximum_roof_height_ft] = nil
           hash[:maximum_number_of_stories] = nil
           hash[:maximum_number_of_stories_above_ground] = nil
-          hash[:parking_area] = nil
+          hash[:parking_area_sqft] = nil
           hash[:number_of_parking_spaces] = nil
           hash[:number_of_parking_spaces_charging] = nil
-          hash[:parking_footprint_area] = nil
-          hash[:maximum_parking_height] = nil
+          hash[:parking_footprint_area_sqft] = nil
+          hash[:maximum_parking_height_ft] = nil
           hash[:maximum_number_of_parking_stories] = nil
           hash[:maximum_number_of_parking_stories_above_ground] = nil
           hash[:number_of_residential_units] = nil
-          hash[:building_types] = [{ building_type: nil, maximum_occupancy: nil, floor_area: nil }]
-          hash[:window_area] = { north_window_area: nil, south_window_area: nil, east_window_area: nil, west_window_area: nil, total_window_area: nil }
-          hash[:wall_area] = { north_wall_area: nil, south_wall_area: nil, east_wall_area: nil, west_wall_area: nil, total_wall_area: nil }
-          hash[:roof_area] = { equipment_roof_area: nil, photovoltaic_roof_area: nil, available_roof_area: nil, total_roof_area: nil }
-          hash[:orientation] = nil
+          hash[:building_types] = [{ building_type: nil, maximum_occupancy: nil, floor_area_sqft: nil }]
+          hash[:window_area_sqft] = { north_window_area_sqft: nil, south_window_area_sqft: nil, east_window_area_sqft: nil, west_window_area_sqft: nil, total_window_area_sqft: nil }
+          hash[:wall_area_sqft] = { north_wall_area_sqft: nil, south_wall_area_sqft: nil, east_wall_area_sqft: nil, west_wall_area_sqft: nil, total_wall_area_sqft: nil }
+          hash[:roof_area_sqft] = { equipment_roof_area_sqft: nil, photovoltaic_roof_area_sqft: nil, available_roof_area_sqft: nil, total_roof_area_sqft: nil }
+          hash[:orientation_deg] = nil
           hash[:aspect_ratio] = nil
-          hash[:total_construction_cost] = nil
+          hash[:total_construction_cost_dollar] = nil
           return hash
         end
 
@@ -128,19 +128,19 @@ module URBANopt
         ##
         def to_hash
           result = {}
-          result[:site_area] = @site_area if @site_area
-          result[:floor_area] = @floor_area if @floor_area
-          result[:conditioned_area] = @conditioned_area if @conditioned_area
-          result[:unconditioned_area] = @unconditioned_area if @unconditioned_area
-          result[:footprint_area] = @footprint_area if @footprint_area
-          result[:maximum_roof_height] = @maximum_roof_height if @maximum_roof_height
+          result[:site_area_sqft] = @site_area_sqft if @site_area_sqft
+          result[:floor_area_sqft] = @floor_area_sqft if @floor_area_sqft
+          result[:conditioned_area_sqft] = @conditioned_area_sqft if @conditioned_area_sqft
+          result[:unconditioned_area_sqft] = @unconditioned_area_sqft if @unconditioned_area_sqft
+          result[:footprint_area_sqft] = @footprint_area_sqft if @footprint_area_sqft
+          result[:maximum_roof_height_ft] = @maximum_roof_height_ft if @maximum_roof_height_ft
           result[:maximum_number_of_stories] = @maximum_number_of_stories if @maximum_number_of_stories
           result[:maximum_number_of_stories_above_ground] = @maximum_number_of_stories_above_ground if @maximum_number_of_parking_stories_above_ground
-          result[:parking_area] = @parking_area if @parking_area
+          result[:parking_area_sqft] = @parking_area_sqft if @parking_area_sqft
           result[:number_of_parking_spaces] = @number_of_parking_spaces if @number_of_parking_spaces
           result[:number_of_parking_spaces_charging] = @number_of_parking_spaces_charging if @number_of_parking_spaces_charging
-          result[:parking_footprint_area] = @parking_footprint_area if @parking_footprint_area
-          result[:maximum_parking_height] = @maximum_parking_height if @maximum_parking_height
+          result[:parking_footprint_area_sqft] = @parking_footprint_area_sqft if @parking_footprint_area_sqft
+          result[:maximum_parking_height_ft] = @maximum_parking_height_ft if @maximum_parking_height_ft
           result[:maximum_number_of_parking_stories] = @maximum_number_of_parking_stories if @maximum_number_of_parking_stories
           result[:maximum_number_of_parking_stories_above_ground] = @maximum_number_of_parking_stories_above_ground if @maximum_number_of_parking_stories_above_ground
           result[:number_of_residential_units] = @number_of_residential_units if @number_of_residential_units
@@ -152,25 +152,25 @@ module URBANopt
             end
           end
 
-          # result[:window_area] = @window_area if @window_area
-          window_area_hash = @window_area if @window_area
-          window_area_hash.delete_if { |k, v| v.nil? }
-          result[:window_area] = window_area_hash if @window_area
+          # result[:window_area_sqft] = @window_area_sqft if @window_area_sqft
+          window_area_sqft_hash = @window_area_sqft if @window_area_sqft
+          window_area_sqft_hash.delete_if { |k, v| v.nil? }
+          result[:window_area_sqft] = window_area_sqft_hash if @window_area_sqft
 
-          # result[:wall_area] = @wall_area if @wall_area
-          wall_area_hash = @wall_area if @wall_area
-          wall_area_hash.delete_if { |k, v| v.nil? }
-          result[:wall_area] = wall_area_hash if @wall_area
+          # result[:wall_area_sqft] = @wall_area_sqft if @wall_area_sqft
+          wall_area_sqft_hash = @wall_area_sqft if @wall_area_sqft
+          wall_area_sqft_hash.delete_if { |k, v| v.nil? }
+          result[:wall_area_sqft] = wall_area_sqft_hash if @wall_area_sqft
 
-          # result[:roof_area] = @roof_area if @roof_area
-          roof_area_hash = @roof_area if @roof_area
-          roof_area_hash.delete_if { |k, v| v.nil? }
-          result[:roof_area] = roof_area_hash if @roof_area
+          # result[:roof_area_sqft] = @roof_area_sqft if @roof_area_sqft
+          roof_area_sqft_hash = @roof_area_sqft if @roof_area_sqft
+          roof_area_sqft_hash.delete_if { |k, v| v.nil? }
+          result[:roof_area_sqft] = roof_area_sqft_hash if @roof_area_sqft
 
-          result[:orientation] = @orientation if @orientation
+          result[:orientation_deg] = @orientation_deg if @orientation_deg
           result[:aspect_ratio] = @aspect_ratio if @aspect_ratio
 
-          result[:total_construction_cost] = @total_construction_cost if @total_construction_cost
+          result[:total_construction_cost_dollar] = @total_construction_cost_dollar if @total_construction_cost_dollar
 
           # validate program properties against schema
           if @@validator.validate(@@schema[:definitions][:Program][:properties], result).any?
@@ -221,43 +221,43 @@ module URBANopt
         # +other+ - _Program_ - An object of Program class.
         ##
         def add_program(other)
-          @site_area = add_values(@site_area, other.site_area)
+          @site_area_sqft = add_values(@site_area_sqft, other.site_area_sqft)
 
-          @floor_area = add_values(@floor_area, other.floor_area)
-          @conditioned_area = add_values(@conditioned_area, other.conditioned_area)
-          @unconditioned_area = add_values(@unconditioned_area, other.unconditioned_area)
-          @footprint_area = add_values(@footprint_area, other.footprint_area)
-          @maximum_roof_height = max_value(@maximum_roof_height, other.maximum_roof_height)
+          @floor_area_sqft = add_values(@floor_area_sqft, other.floor_area_sqft)
+          @conditioned_area_sqft = add_values(@conditioned_area_sqft, other.conditioned_area_sqft)
+          @unconditioned_area_sqft = add_values(@unconditioned_area_sqft, other.unconditioned_area_sqft)
+          @footprint_area_sqft = add_values(@footprint_area_sqft, other.footprint_area_sqft)
+          @maximum_roof_height_ft = max_value(@maximum_roof_height_ft, other.maximum_roof_height_ft)
           @maximum_number_of_stories = max_value(@maximum_number_of_stories, other.maximum_number_of_stories)
           @maximum_number_of_stories_above_ground = max_value(@maximum_number_of_stories_above_ground, other.maximum_number_of_stories_above_ground)
-          @parking_area = add_values(@parking_area, other.parking_area)
+          @parking_area_sqft = add_values(@parking_area_sqft, other.parking_area_sqft)
           @number_of_parking_spaces = add_values(@number_of_parking_spaces, other.number_of_parking_spaces)
           @number_of_parking_spaces_charging = add_values(@number_of_parking_spaces_charging, other.number_of_parking_spaces_charging)
-          @parking_footprint_area = add_values(@parkig_footprint_area, other.parking_footprint_area)
-          @maximum_parking_height = max_value(@maximum_parking_height, other.maximum_parking_height)
+          @parking_footprint_area_sqft = add_values(@parkig_footprint_area_sqft, other.parking_footprint_area_sqft)
+          @maximum_parking_height_ft = max_value(@maximum_parking_height_ft, other.maximum_parking_height_ft)
           @maximum_number_of_parking_stories = max_value(@maximum_number_of_parking_stories, other.maximum_number_of_parking_stories)
           @maximum_number_of_parking_stories_above_ground = max_value(maximum_number_of_parking_stories_above_ground, other.maximum_number_of_parking_stories_above_ground)
           @number_of_residential_units = add_values(@number_of_residential_units, other.number_of_residential_units)
-          @total_construction_cost = add_values(@total_construction_cost, other.total_construction_cost)
+          @total_construction_cost_dollar = add_values(@total_construction_cost_dollar, other.total_construction_cost_dollar)
 
           @building_types = other.building_types
 
-          @window_area[:north_window_area] = add_values(@window_area[:north_window_area], other.window_area[:north_window_area])
-          @window_area[:south_window_area] = add_values(@window_area[:south_window_area], other.window_area[:south_window_area])
-          @window_area[:east_window_area] = add_values(@window_area[:east_window_area], other.window_area[:east_window_area])
-          @window_area[:west_window_area] = add_values(@window_area[:west_window_area], other.window_area[:west_window_area])
-          @window_area[:total_window_area] =  add_values(@window_area[:total_window_area], other.window_area[:total_window_area])
+          @window_area_sqft[:north_window_area_sqft] = add_values(@window_area_sqft[:north_window_area_sqft], other.window_area_sqft[:north_window_area_sqft])
+          @window_area_sqft[:south_window_area_sqft] = add_values(@window_area_sqft[:south_window_area_sqft], other.window_area_sqft[:south_window_area_sqft])
+          @window_area_sqft[:east_window_area_sqft] = add_values(@window_area_sqft[:east_window_area_sqft], other.window_area_sqft[:east_window_area_sqft])
+          @window_area_sqft[:west_window_area_sqft] = add_values(@window_area_sqft[:west_window_area_sqft], other.window_area_sqft[:west_window_area_sqft])
+          @window_area_sqft[:total_window_area_sqft] =  add_values(@window_area_sqft[:total_window_area_sqft], other.window_area_sqft[:total_window_area_sqft])
 
-          @wall_area[:north_wall_area] = add_values(@wall_area[:north_wall_area], other.wall_area[:north_wall_area])
-          @wall_area[:south_wall_area] = add_values(@wall_area[:south_wall_area], other.wall_area[:south_wall_area])
-          @wall_area[:east_wall_area] = add_values(@wall_area[:east_wall_area], other.wall_area[:east_wall_area])
-          @wall_area[:west_wall_area] = add_values(@wall_area[:west_wall_area], other.wall_area[:west_wall_area])
-          @wall_area[:total_wall_area] = add_values(@wall_area[:total_wall_area], other.wall_area[:total_wall_area])
+          @wall_area_sqft[:north_wall_area_sqft] = add_values(@wall_area_sqft[:north_wall_area_sqft], other.wall_area_sqft[:north_wall_area_sqft])
+          @wall_area_sqft[:south_wall_area_sqft] = add_values(@wall_area_sqft[:south_wall_area_sqft], other.wall_area_sqft[:south_wall_area_sqft])
+          @wall_area_sqft[:east_wall_area_sqft] = add_values(@wall_area_sqft[:east_wall_area_sqft], other.wall_area_sqft[:east_wall_area_sqft])
+          @wall_area_sqft[:west_wall_area_sqft] = add_values(@wall_area_sqft[:west_wall_area_sqft], other.wall_area_sqft[:west_wall_area_sqft])
+          @wall_area_sqft[:total_wall_area_sqft] = add_values(@wall_area_sqft[:total_wall_area_sqft], other.wall_area_sqft[:total_wall_area_sqft])
 
-          @roof_area[:equipment_roof_area] = add_values(@roof_area[:equipment_roof_area], other.roof_area[:equipment_roof_area])
-          @roof_area[:photovoltaic_roof_area] = add_values(@roof_area[:photovoltaic_roof_area], other.roof_area[:photovoltaic_roof_area])
-          @roof_area[:available_roof_area] = add_values(@roof_area[:available_roof_area], other.roof_area[:available_roof_area])
-          @roof_area[:total_roof_area] = add_values(@roof_area[:total_roof_area], other.roof_area[:total_roof_area])
+          @roof_area_sqft[:equipment_roof_area_sqft] = add_values(@roof_area_sqft[:equipment_roof_area_sqft], other.roof_area_sqft[:equipment_roof_area_sqft])
+          @roof_area_sqft[:photovoltaic_roof_area_sqft] = add_values(@roof_area_sqft[:photovoltaic_roof_area_sqft], other.roof_area_sqft[:photovoltaic_roof_area_sqft])
+          @roof_area_sqft[:available_roof_area_sqft] = add_values(@roof_area_sqft[:available_roof_area_sqft], other.roof_area_sqft[:available_roof_area_sqft])
+          @roof_area_sqft[:total_roof_area_sqft] = add_values(@roof_area_sqft[:total_roof_area_sqft], other.roof_area_sqft[:total_roof_area_sqft])
         end
       end
     end

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -43,16 +43,16 @@ module URBANopt
       # ReportingPeriod includes all the results of a specific reporting period.
       ##
       class ReportingPeriod
-        attr_accessor :id, :name, :multiplier, :start_date, :end_date, :month, :day_of_month, :year, :total_site_energy, :total_source_energy,
-                      :net_site_energy, :net_source_energy, :total_utility_cost, :net_utility_cost, :utility_costs, :electricity, :natural_gas, :additional_fuel, :district_cooling,
-                      :district_heating, :water, :electricity_produced, :end_uses, :energy_production, :photovoltaic,
-                      :fuel_type, :total_cost, :usage_cost, :demand_cost, :comfort_result, :time_setpoint_not_met_during_occupied_cooling,
+        attr_accessor :id, :name, :multiplier, :start_date, :end_date, :month, :day_of_month, :year, :total_site_energy_kwh, :total_source_energy_kwh,
+                      :net_site_energy_kwh, :net_source_energy_kwh, :total_utility_cost_dollar, :net_utility_cost_dollar, :utility_costs_dollar, :electricity_kwh, :natural_gas_kwh, :propane_kwh, :fuel_oil_kwh, :other_fuels_kwh, :district_cooling_kwh,
+                      :district_heating_kwh, :water_qbft, :electricity_produced_kwh, :end_uses, :energy_production_kwh, :photovoltaic,
+                      :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 #:nodoc:
         # ReportingPeriod class initializes the reporting period attributes:
-        # +:id+ , +:name+ , +:multiplier+ , +:start_date+ , +:end_date+ , +:month+ , +:day_of_month+ , +:year+ , +:total_site_energy+ , +:total_source_energy+ ,
-        # +:net_site_energy+ , +:net_source_energy+ , +:total_utility_cost , +:net_utility_cost+ , +:utility_costs+ , +:electricity+ , +:natural_gas+ , +:additional_fuel+ , +:district_cooling+ ,
-        # +:district_heating+ , +:water+ , +:electricity_produced+ , +:end_uses+ , +:energy_production+ , +:photovoltaic+ ,
-        # +:fuel_type+ , +:total_cost+ , +:usage_cost+ , +:demand_cost+ , +:comfort_result+ , +:time_setpoint_not_met_during_occupied_cooling+ ,
+        # +:id+ , +:name+ , +:multiplier+ , +:start_date+ , +:end_date+ , +:month+ , +:day_of_month+ , +:year+ , +:total_site_energy_kwh+ , +:total_source_energy_kwh+ ,
+        # +:net_site_energy_kwh+ , +:net_source_energy_kwh+ , +:total_utility_cost_dollar , +:net_utility_cost_dollar+ , +:utility_costs_dollar+ , +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ , +:district_cooling_kwh+ ,
+        # +:district_heating_kwh+ , +:water_qbft+ , +:electricity_produced_kwh+ , +:end_uses+ , +:energy_production_kwh+ , +:photovoltaic_kwh+ ,
+        # +: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+
         ##
         # [parameters:]
@@ -68,24 +68,26 @@ module URBANopt
           @start_date = Date.new(hash[:start_date])
           @end_date = Date.new(hash[:end_date])
 
-          @total_site_energy = hash[:total_site_energy]
-          @total_source_energy = hash[:total_source_energy]
-          @net_site_energy = hash [:net_site_energy]
-          @net_source_energy = hash [:net_source_energy]
-          @net_utility_cost = hash [:net_utility_cost]
-          @total_utility_cost = hash [:total_utility_cost]
-          @electricity = hash [:electricity]
-          @natural_gas = hash [:natural_gas]
-          @additional_fuel = hash [:additional_fuel]
-          @district_cooling = hash [:district_cooling]
-          @district_heating = hash[:district_heating]
-          @water = hash[:water]
-          @electricity_produced = hash[:electricity_produced]
+          @total_site_energy_kwh = hash[:total_site_energy_kwh]
+          @total_source_energy_kwh = hash[:total_source_energy_kwh]
+          @net_site_energy_kwh = hash[:net_site_energy_kwh]
+          @net_source_energy_kwh = hash[:net_source_energy_kwh]
+          @net_utility_cost_dollar = hash[:net_utility_cost_dollar]
+          @total_utility_cost_dollar = hash[:total_utility_cost_dollar]
+          @electricity_kwh = hash[:electricity_kwh]
+          @natural_gas_kwh = hash[:natural_gas_kwh]
+          @propane_kwh = hash[:propane_kwh]
+          @fuel_oil_kwh = hash[:fuel_oil_kwh]
+          @other_fuels_kwh = hash[:other_fuels_kwh]
+          @district_cooling_kwh = hash[:district_cooling_kwh]
+          @district_heating_kwh = hash[:district_heating_kwh]
+          @water_qbft = hash[:water_qbft]
+          @electricity_produced_kwh = hash[:electricity_produced_kwh]
           @end_uses = EndUses.new(hash[:end_uses])
 
-          @energy_production = hash[:energy_production]
+          @energy_production_kwh = hash[:energy_production_kwh]
 
-          @utility_costs = hash[:utility_costs]
+          @utility_costs_dollar = hash[:utility_costs_dollar]
 
           @comfort_result = hash[:comfort_result]
 
@@ -106,22 +108,24 @@ module URBANopt
           hash[:start_date] = Date.new.to_hash
           hash[:end_date] = Date.new.to_hash
 
-          hash[:total_site_energy] = nil
-          hash[:total_source_energy] = nil
-          hash [:net_site_energy] = nil
-          hash [:net_source_energy] = nil
-          hash [:net_utility_cost] = nil
-          hash [:total_utility_cost] = nil
-          hash [:electricity] = nil
-          hash [:natural_gas] = nil
-          hash [:additional_fuel] = nil
-          hash [:district_cooling] = nil
-          hash[:district_heating] = nil
-
-          hash[:electricity_produced] = nil
+          hash[:total_site_energy_kwh] = nil
+          hash[:total_source_energy_kwh] = nil
+          hash[:net_site_energy_kwh] = nil
+          hash[:net_source_energy_kwh] = nil
+          hash[:net_utility_cost_dollar] = nil
+          hash[:total_utility_cost_dollar] = nil
+          hash[:electricity_kwh] = nil
+          hash[:natural_gas_kwh] = nil
+          hash[:propane_kwh] = nil
+          hash[:fuel_oil_kwh] = nil
+          hash[:other_fuels_kwh] = nil
+          hash[:district_cooling_kwh] = nil
+          hash[:district_heating_kwh] = nil
+
+          hash[:electricity_produced_kwh] = nil
           hash[:end_uses] = EndUses.new.to_hash
-          hash[:energy_production] = { electricity_produced: { photovoltaic: nil } }
-          hash[:utility_costs] = [{ fuel_type: nil, total_cost: nil, usage_cost: nil, demand_cost: nil }]
+          hash[:energy_production_kwh] = { electricity_produced: { photovoltaic: nil } }
+          hash[:utility_costs_dollar] = [{ fuel_type: nil, total_cost_dollar: nil, usage_cost_dollar: nil, demand_cost_dollar: nil }]
           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 }
 
@@ -142,32 +146,34 @@ module URBANopt
           result[:multiplier] = @multiplier if @multiplier
           result[:start_date] = @start_date.to_hash if @start_date
           result[:end_date] = @end_date.to_hash if @end_date
-          result[:total_site_energy] = @total_site_energy if @total_site_energy
-          result[:total_source_energy] = @total_source_energy if @total_source_energy
-          result[:net_site_energy] = @net_site_energy if @net_site_energy
-          result[:net_source_energy] = @net_source_energy if @net_source_energy
-          result[:net_utility_cost] = @net_utility_cost if @net_utility_cost
-          result[:total_utility_cost] = @total_utility_cost if @total_utility_cost
-          result[:electricity] = @electricity if @electricity
-          result[:natural_gas] = @natural_gas if @natural_gas
-          result[:additional_fuel] = @additional_fuel if @additional_fuel
-          result[:district_cooling] = @district_cooling if @district_cooling
-          result[:district_heating] = @district_heating if @district_heating
-          result[:water] = @water if @water
-          result[:electricity_produced] = @electricity_produced if @electricity_produced
+          result[:total_site_energy_kwh] = @total_site_energy_kwh if @total_site_energy_kwh
+          result[:total_source_energy_kwh] = @total_source_energy_kwh if @total_source_energy_kwh
+          result[:net_site_energy_kwh] = @net_site_energy_kwh if @net_site_energy_kwh
+          result[:net_source_energy_kwh] = @net_source_energy_kwh if @net_source_energy_kwh
+          result[:net_utility_cost_dollar] = @net_utility_cost_dollar if @net_utility_cost_dollar
+          result[:total_utility_cost_dollar] = @total_utility_cost_dollar if @total_utility_cost_dollar
+          result[:electricity_kwh] = @electricity_kwh if @electricity_kwh
+          result[:natural_gas_kwh] = @natural_gas_kwh if @natural_gas_kwh
+          result[:propane_kwh] = @propane_kwh if @propane_kwh
+          result[:fuel_oil_kwh] = @fuel_oil_kwh if @fuel_oil_kwh
+          result[:other_fuels_kwh] = @other_fuels_kwh if @other_fuels_kwh
+          result[:district_cooling_kwh] = @district_cooling_kwh if @district_cooling_kwh
+          result[:district_heating_kwh] = @district_heating_kwh if @district_heating_kwh
+          result[:water_qbft] = @water_qbft if @water_qbft
+          result[:electricity_produced_kwh] = @electricity_produced_kwh if @electricity_produced_kwh
           result[:end_uses] = @end_uses.to_hash if @end_uses
 
-          energy_production_hash = @energy_production if @energy_production
-          energy_production_hash.delete_if { |k, v| v.nil? }
-          energy_production_hash.each do |eph|
+          energy_production_kwh_hash = @energy_production_kwh if @energy_production_kwh
+          energy_production_kwh_hash.delete_if { |k, v| v.nil? }
+          energy_production_kwh_hash.each do |eph|
             eph.delete_if { |k, v| v.nil? }
           end
 
-          result[:energy_production] = energy_production_hash if @energy_production
+          result[:energy_production_kwh] = energy_production_kwh_hash if @energy_production_kwh
 
-          if @utility_costs.any?
-            result[:utility_costs] = @utility_costs
-            @utility_costs.each do |uc|
+          if @utility_costs_dollar.any?
+            result[:utility_costs_dollar] = @utility_costs_dollar
+            @utility_costs_dollar.each do |uc|
               uc&.delete_if { |k, v| v.nil? }
             end
           end
@@ -211,34 +217,36 @@ module URBANopt
         ##
         def self.merge_reporting_period(existing_period, new_period)
           # modify the existing_period by summing up the results
-          existing_period.total_site_energy = add_values(existing_period.total_site_energy, new_period.total_site_energy)
-          existing_period.total_source_energy = add_values(existing_period.total_source_energy, new_period.total_source_energy)
-          existing_period.net_source_energy = add_values(existing_period.net_source_energy, new_period.net_source_energy)
-          existing_period.net_utility_cost = add_values(existing_period.net_utility_cost, new_period.net_utility_cost)
-          existing_period.total_utility_cost = add_values(existing_period.total_utility_cost, new_period.total_utility_cost)
-          existing_period.electricity = add_values(existing_period.electricity, new_period.electricity)
-          existing_period.natural_gas = add_values(existing_period.natural_gas, new_period.natural_gas)
-          existing_period.additional_fuel = add_values(existing_period.additional_fuel, new_period.additional_fuel)
-          existing_period.district_cooling = add_values(existing_period.district_cooling, new_period.district_cooling)
-          existing_period.district_heating = add_values(existing_period.district_heating, new_period.district_heating)
-          existing_period.water = add_values(existing_period.water, new_period.water)
-          existing_period.electricity_produced = add_values(existing_period.electricity_produced, new_period.electricity_produced)
+          existing_period.total_site_energy_kwh = add_values(existing_period.total_site_energy_kwh, new_period.total_site_energy_kwh)
+          existing_period.total_source_energy_kwh = add_values(existing_period.total_source_energy_kwh, new_period.total_source_energy_kwh)
+          existing_period.net_source_energy_kwh = add_values(existing_period.net_source_energy_kwh, new_period.net_source_energy_kwh)
+          existing_period.net_utility_cost_dollar = add_values(existing_period.net_utility_cost_dollar, new_period.net_utility_cost_dollar)
+          existing_period.total_utility_cost_dollar = add_values(existing_period.total_utility_cost_dollar, new_period.total_utility_cost_dollar)
+          existing_period.electricity_kwh = add_values(existing_period.electricity_kwh, new_period.electricity_kwh)
+          existing_period.natural_gas_kwh = add_values(existing_period.natural_gas_kwh, new_period.natural_gas_kwh)
+          existing_period.propane_kwh = add_values(existing_period.propane_kwh, new_period.propane_kwh)
+          existing_period.fuel_oil_kwh = add_values(existing_period.fuel_oil_kwh, new_period.fuel_oil_kwh)
+          existing_period.other_fuels_kwh = add_values(existing_period.other_fuels_kwh, new_period.other_fuels_kwh)
+          existing_period.district_cooling_kwh = add_values(existing_period.district_cooling_kwh, new_period.district_cooling_kwh)
+          existing_period.district_heating_kwh = add_values(existing_period.district_heating_kwh, new_period.district_heating_kwh)
+          existing_period.water_qbft = add_values(existing_period.water_qbft, new_period.water_qbft)
+          existing_period.electricity_produced_kwh = add_values(existing_period.electricity_produced_kwh, new_period.electricity_produced_kwh)
 
           # merge end uses
           new_end_uses = new_period.end_uses
           existing_period.end_uses&.merge_end_uses!(new_end_uses)
 
-          if existing_period.energy_production
-            if existing_period.energy_production[:electricity_produced]
-              existing_period.energy_production[:electricity_produced][:photovoltaic] = add_values(existing_period.energy_production[:electricity_produced][:photovoltaic], new_period.energy_production[:electricity_produced][:photovoltaic])
+          if existing_period.energy_production_kwh
+            if existing_period.energy_production_kwh[:electricity_produced_kwh]
+              existing_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh] = add_values(existing_period.energy_production_kwh[:electricity_produced][:photovoltaic], new_period.energy_production_kwh[:electricity_produced_kwh][:photovoltaic_kwh])
             end
           end
 
-          existing_period.utility_costs&.each_with_index do |item, i|
-            existing_period.utility_costs[i][:fuel_type] = existing_period.utility_costs[i][:fuel_type]
-            existing_period.utility_costs[i][:total_cost] = add_values(existing_period.utility_costs[i][:total_cost], new_period.utility_costs[i][:total_cost])
-            existing_period.utility_costs[i][:usage_cost] = add_values(existing_period.utility_costs[i][:usage_cost], new_period.utility_costs[i][:usage_cost])
-            existing_period.utility_costs[i][:demand_cost] = add_values(existing_period.utility_costs[i][:demand_cost], new_period.utility_costs[i][:demand_cost])
+          existing_period.utility_costs_dollar&.each_with_index do |item, i|
+            existing_period.utility_costs_dollar[i][:fuel_type] = existing_period.utility_costs_dollar[i][:fuel_type]
+            existing_period.utility_costs_dollar[i][:total_cost] = add_values(existing_period.utility_costs_dollar[i][:total_cost], new_period.utility_costs_dollar[i][:total_cost])
+            existing_period.utility_costs_dollar[i][:usage_cost] = add_values(existing_period.utility_costs_dollar[i][:usage_cost], new_period.utility_costs_dollar[i][:usage_cost])
+            existing_period.utility_costs_dollar[i][:demand_cost] = add_values(existing_period.utility_costs_dollar[i][:demand_cost], new_period.utility_costs_dollar[i][:demand_cost])
           end
 
           if existing_period.comfort_result