urbanopt-reporting 0.6.2 → 0.8.0

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

@@ -0,0 +1,147 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
+# *********************************************************************************
+
+require 'json'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # QAQC flags for each feature
+      ##
+      class QAQC
+        ##
+        # _Hash_ - Hash of flags raised by QAQC measure for this feature during this reporting period
+        #
+        attr_accessor :eui_reasonableness,:end_use_by_category,:mechanical_system_part_load_efficiency,
+                      :simultaneous_heating_and_cooling , :internal_loads , :schedules, :envelope_r_value,
+                      :domestic_hot_water , :mechanical_system_efficiency , :supply_and_zone_air_temperature,
+                      :total_qaqc_flags
+
+        ##
+        # QAQC class initialize quaqc attributes: +:eui_reasonableness,+:end_use_by_category,+:mechanical_system_part_load_efficiency,
+        # +:simultaneous_heating_and_cooling , +:internal_loads , +:schedules, +:envelope_r_value,
+        # +:domestic_hot_water , +:mechanical_system_efficiency , +:supply_and_zone_air_temperature, +:total_qaqc_flags
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containing qaqc attributes listed above.
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @eui_reasonableness = hash[:eui_reasonableness]
+          @end_use_by_category = hash[:end_use_by_category]
+          @mechanical_system_part_load_efficiency = hash[:mechanical_system_part_load_efficiency]
+          @simultaneous_heating_and_cooling = hash[:simultaneous_heating_and_cooling]
+          @supply_and_zone_air_temperature = hash[:supply_and_zone_air_temperature]
+          @internal_loads = hash[:internal_loads]
+          @schedules = hash[:schedules]
+          @envelope_r_value = hash[:envelope_r_value]
+          @domestic_hot_water = hash[:domestic_hot_water]
+          @mechanical_system_efficiency = hash[:mechanical_system_efficiency]
+          @total_qaqc_flags = hash[:total_qaqc_flags]
+
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+        end
+
+
+        ##
+        # Assigns default values if values do not exist.
+        ##
+        def defaults
+          hash = {}
+
+          hash[:eui_reasonableness] = nil
+          hash[:end_use_by_category] = nil
+          hash[:mechanical_system_part_load_efficiency] = nil
+          hash[:simultaneous_heating_and_cooling] = nil
+          hash[:supply_and_zone_air_temperature] = nil
+          hash[:internal_loads] = nil
+          hash[:schedules] = nil
+          hash[:envelope_r_value] = nil
+          hash[:domestic_hot_water] = nil
+          hash[:mechanical_system_efficiency] = nil
+          hash[:total_qaqc_flags] = nil
+
+
+          return hash
+        end
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:eui_reasonableness] = @eui_reasonableness
+          result[:end_use_by_category] = @end_use_by_category
+          result[:mechanical_system_part_load_efficiency] = @mechanical_system_part_load_efficiency
+          result[:simultaneous_heating_and_cooling] = @simultaneous_heating_and_cooling
+          result[:supply_and_zone_air_temperature] = @supply_and_zone_air_temperature
+          result[:internal_loads] = @internal_loads
+          result[:schedules] = @schedules
+          result[:envelope_r_value] = @envelope_r_value
+          result[:domestic_hot_water] = @domestic_hot_water
+          result[:mechanical_system_efficiency] = @mechanical_system_efficiency
+          result[:total_qaqc_flags] = @total_qaqc_flags
+
+          # validate program properties against schema
+          if @@validator.validate(@@schema[:definitions][:qaqc_flags][:properties], result).any?
+            raise "qaqc properties does not match schema: #{@@validator.validate(@@schema[:definitions][:qaqc_flags][:properties], result)}"
+          end
+
+          return result
+
+        end
+
+        ##
+        # Adds up +existing_value+ and +new_values+ if not nill.
+        ##
+        # [parameters:]
+        # +existing_value+ - _Float_ - A value corresponding to a qaqc_flags attribute.
+        ##
+        # +new_value+ - _Float_ - A value corresponding to a qaqc_flags attribute.
+        ##
+        def add_values(existing_value, new_value) #:nodoc:
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
+
+        ##
+        # Merges qaqc_flags objects to each other by summing up values.
+        ##
+        # [parameters:]
+        # +other+ - _QAQC_ - An object of Program class.
+        ##
+        def add_qaqc_flags(other)
+
+          @eui_reasonableness = add_values(@eui_reasonableness, other.eui_reasonableness)
+          @end_use_by_category = add_values(@end_use_by_category, other.end_use_by_category)
+          @mechanical_system_part_load_efficiency = add_values(@mechanical_system_part_load_efficiency, other.mechanical_system_part_load_efficiency)
+          @simultaneous_heating_and_cooling = add_values(@simultaneous_heating_and_cooling, other.simultaneous_heating_and_cooling)
+          @supply_and_zone_air_temperature = add_values(@supply_and_zone_air_temperature, other.supply_and_zone_air_temperature)
+          @internal_loads = add_values(@internal_loads, other.internal_loads)
+          @schedules = add_values(@schedules, other.schedules)
+          @envelope_r_value = add_values(@envelope_r_value, other.envelope_r_value)
+          @domestic_hot_water = add_values(@domestic_hot_water, other.domestic_hot_water)
+          @mechanical_system_efficiency = add_values(@mechanical_system_efficiency, other.mechanical_system_efficiency)
+          @total_qaqc_flags = add_values(@total_qaqc_flags, other.total_qaqc_flags)
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,41 +1,6 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-
-# Redistribution of this software, without modification, must refer to the software
-# by the same designation. Redistribution of a modified version of this software
-# (i) may not refer to the modified version by the same designation, or by any
-# confusingly similar designation, and (ii) must refer to the underlying software
-# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
-# the term “URBANopt”, or any confusingly similar designation may not be used to
-# refer to any modified version of this software or any modified version of the
-# underlying software originally provided by Alliance without the prior written
-# consent of Alliance.
-
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
 require_relative 'end_uses'
@@ -60,7 +25,7 @@ module URBANopt
                       :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 ,
-                      :natural_gas_emissions_mt, :natural_gas_emissions_intensity_kg_per_ft2, :propane_emissions_mt, :propane_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:
 
         # ReportingPeriod class initializes the reporting period attributes:
@@ -71,7 +36,7 @@ module URBANopt
         # +: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+,
-        # +:natural_gas_emissions_mt+, +:natural_gas_emissions_intensity_kg_per_ft2+, +:propane_emissions_mt+, +:propane_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+
         ##
         # [parameters:]
@@ -157,7 +122,7 @@ module URBANopt
           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 }
-          hash[:emissions] = { future_annual_electricity_emissions_mt: nil, future_hourly_electricity_emissions_mt: nil, historical_annual_electricity_emissions_mt: 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,
@@ -307,7 +272,7 @@ module URBANopt
             existing_period.emissions[:natural_gas_emissions_mt] = add_values(existing_period.emissions[:natural_gas_emissions_mt], new_period.emissions[:natural_gas_emissions_mt])
             existing_period.emissions[:propane_emissions_mt] = add_values(existing_period.emissions[:propane_emissions_mt], new_period.emissions[:propane_emissions_mt])
             existing_period.emissions[:fueloil_no2_emissions_mt] = add_values(existing_period.emissions[:fueloil_no2_emissions_mt], new_period.emissions[:fueloil_no2_emissions_mt])
-           
+
             existing_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:future_annual_electricity_emissions_intensity_kg_per_ft2])
             existing_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:future_hourly_electricity_emissions_intensity_kg_per_ft2])
             existing_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2] = add_values(existing_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2], new_period.emissions[:historical_annual_electricity_emissions_intensity_kg_per_ft2])

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

@@ -1,41 +1,6 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-
-# Redistribution of this software, without modification, must refer to the software
-# by the same designation. Redistribution of a modified version of this software
-# (i) may not refer to the modified version by the same designation, or by any
-# confusingly similar designation, and (ii) must refer to the underlying software
-# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
-# the term “URBANopt”, or any confusingly similar designation may not be used to
-# refer to any modified version of this software or any modified version of the
-# underlying software originally provided by Alliance without the prior written
-# consent of Alliance.
-
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
 require_relative 'validator'

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

@@ -0,0 +1,177 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
+# *********************************************************************************
+
+require_relative 'validator'
+
+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

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

@@ -1,41 +1,6 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
-# contributors. All rights reserved.
-
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-
-# Redistributions of source code must retain the above copyright notice, this list
-# of conditions and the following disclaimer.
-
-# Redistributions in binary form must reproduce the above copyright notice, this
-# list of conditions and the following disclaimer in the documentation and/or other
-# materials provided with the distribution.
-
-# Neither the name of the copyright holder nor the names of its contributors may be
-# used to endorse or promote products derived from this software without specific
-# prior written permission.
-
-# Redistribution of this software, without modification, must refer to the software
-# by the same designation. Redistribution of a modified version of this software
-# (i) may not refer to the modified version by the same designation, or by any
-# confusingly similar designation, and (ii) must refer to the underlying software
-# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
-# the term “URBANopt”, or any confusingly similar designation may not be used to
-# refer to any modified version of this software or any modified version of the
-# underlying software originally provided by Alliance without the prior written
-# consent of Alliance.
-
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
 require_relative 'construction_cost'
@@ -47,6 +12,8 @@ require_relative 'timeseries_csv'
 require_relative 'distributed_generation'
 require_relative 'validator'
 require_relative 'scenario_power_distribution'
+require_relative 'scenario_power_distribution_cost'
+require_relative 'qaqc_flags'
 
 require 'json'
 require 'json-schema'
@@ -64,12 +31,13 @@ module URBANopt
         attr_accessor :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, :distributed_generation,
-                      :scenario_power_distribution # :nodoc:
+                      :scenario_power_distribution, :scenario_power_distribution_cost, :qaqc_flags # :nodoc:
 
         # ScenarioReport class intializes 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+
+        # +:timeseries_csv+ , +:location+ , +:program+ , +:construction_costs+ , +:reporting_periods+ , +:feature_reports+,
+        # +:distributed_generation+, +:scenario_power_distribution+, +:qaqc_flags+
         ##
         # Each ScenarioReport object corresponds to a single Scenario.
         ##
@@ -93,6 +61,8 @@ module URBANopt
           @program = Program.new(hash[:program])
           @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
           @scenario_power_distribution = ScenarioPowerDistribution.new(hash[:scenario_power_distribution] || {})
+          @scenario_power_distribution_cost = ScenarioPowerDistributionCost.new(hash[:scenario_power_distribution_cost] || {})
+          @qaqc_flags = QAQC.new(hash[:qaqc_flags])
 
           @construction_costs = []
           hash[:construction_costs].each do |cc|
@@ -136,6 +106,7 @@ module URBANopt
           hash[:timeseries_csv] = TimeseriesCSV.new.to_hash
           hash[:location] = Location.new.defaults
           hash[:program] = Program.new.to_hash
+          hash[:qaqc_flags] = QAQC.new.to_hash
           hash[:construction_costs] = []
           hash[:reporting_periods] = []
           hash[:feature_reports] = []
@@ -161,18 +132,20 @@ module URBANopt
         ##
         # [parameters]:
         # +file_name+ - _String_ - Assign a name to the saved scenario results file without an extension
-        def save(file_name = 'default_scenario_report', save_feature_reports = true)
+        def save(file_name = 'default_scenario_report', save_feature_reports = true, save_csv_reports = true)
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
 
-          # save the scenario reports csv and json data
-          old_timeseries_path = nil
-          if !@timeseries_csv.path.nil?
-            old_timeseries_path = @timeseries_csv.path
-          end
+          if save_csv_reports == true
+            # save the scenario reports csv and json data
+            old_timeseries_path = nil
+            if !@timeseries_csv.path.nil?
+              old_timeseries_path = @timeseries_csv.path
+            end
 
-          @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
-          @timeseries_csv.save_data
+            @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
+            @timeseries_csv.save_data
+          end
 
           hash = {}
           hash[:scenario_report] = to_hash
@@ -193,10 +166,12 @@ module URBANopt
             end
           end
 
-          if !old_timeseries_path.nil?
-            @timeseries_csv.path = old_timeseries_path
-          else
-            @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
+          if save_csv_reports == true
+            if !old_timeseries_path.nil?
+              @timeseries_csv.path = old_timeseries_path
+            else
+              @timeseries_csv.path = File.join(@directory_name, "#{file_name}.csv")
+            end
           end
 
           if save_feature_reports
@@ -233,6 +208,8 @@ module URBANopt
           result[:program] = @program.to_hash if @program
           result[:distributed_generation] = @distributed_generation.to_hash if @distributed_generation
           result[:scenario_power_distribution] = @scenario_power_distribution.to_hash if @scenario_power_distribution
+          result[:scenario_power_distribution_cost] = @scenario_power_distribution_cost.to_hash if @scenario_power_distribution_cost
+          result[:qaqc_flags] = @qaqc_flags.to_hash if @qaqc_flags
 
           result[:construction_costs] = []
           @construction_costs&.each { |cc| result[:construction_costs] << cc.to_hash }
@@ -249,7 +226,9 @@ module URBANopt
           end
 
           # have to use the module method because we have not yet initialized the class one
-          @@logger.info("Scenario name: #{@name}")
+          unless @name == '' || @name.nil?
+            @@logger.info("Scenario name: #{@name}")
+          end
 
           return result
         end
@@ -261,6 +240,7 @@ module URBANopt
         # - check feature simulation status
         # - merge timeseries_csv information
         # - merge program information
+        # - merge qaqc_flags information
         # - merge construction_cost information
         # - merge reporting_periods information
         # - add the array of feature_reports
@@ -324,8 +304,12 @@ module URBANopt
           # merge reporting_periods information
           @reporting_periods = ReportingPeriod.merge_reporting_periods(@reporting_periods, feature_report.reporting_periods)
 
+          # merge distributed_generation information
           @distributed_generation = DistributedGeneration.merge_distributed_generation(@distributed_generation, feature_report.distributed_generation)
 
+          # merge qaqc_flags information
+          @qaqc_flags.add_qaqc_flags(feature_report.qaqc_flags)
+
           # add feature_report
           @feature_reports << feature_report