urbanopt-scenario 0.3.0 → 0.4.0

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

@@ -1,159 +0,0 @@
-# *********************************************************************************
-# URBANopt, 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,
-# 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.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
-# *********************************************************************************
-
-require 'urbanopt/scenario/default_reports/validator'
-require 'json-schema'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      ##
-      # Enduse class all enduse energy consumption results.
-      ##
-      class EndUse
-        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment,
-                      :fans, :pumps, :heat_rejection, :humidification, :heat_recovery, :water_systems, :refrigeration, :generators # :nodoc:
-
-        ##
-        # EndUse class intialize all enduse atributes: +:heating+ , +:cooling+ , +:interior_lighting+ ,
-        # +:exterior_lighting+ , +:interior_equipment+ , +:exterior_equipment+ ,
-        # +:fans+ , +:pumps+ , +:heat_rejection+ , +:humidification+ , +:heat_recovery+ , +:water_systems+ , +:refrigeration+ , +:generators+
-        ##
-        # [parameters:]
-        # +hash+ - _Hash_ - A hash which may contain a deserialized end_use.
-        ##
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-          hash = defaults.merge(hash)
-
-          @heating = hash[:heating]
-          @cooling = hash[:cooling]
-          @interior_lighting = hash[:interior_lighting]
-          @exterior_lighting = hash[:exterior_lighting]
-          @interior_equipment = hash[:interior_equipment]
-          @exterior_equipment = hash[:exterior_equipment]
-          @fans = hash[:fans]
-          @pumps = hash[:pumps]
-          @heat_rejection = hash[:heat_rejection]
-          @humidification = hash[:humidification]
-          @heat_recovery = hash[:heat_recovery]
-          @water_systems = hash[:water_systems]
-          @refrigeration = hash[:refrigeration]
-          @generators = hash[:generators]
-
-          # initialize class variables @@validator and @@schema
-          @@validator ||= Validator.new
-          @@schema ||= @@validator.schema
-        end
-
-        ##
-        # Assign default values if values does not exist
-        ##
-        def defaults
-          hash = {}
-
-          hash[:heating] = nil
-          hash[:cooling] = nil
-          hash[:interior_lighting] = nil
-          hash[:exterior_lighting] = nil
-          hash[:interior_equipment] = nil
-          hash[:exterior_equipment] = nil
-          hash[:fans] = nil
-          hash[:pumps] = nil
-          hash[:heat_rejection] = nil
-          hash[:humidification] = nil
-          hash[:heat_recovery] = nil
-          hash[:water_systems] = nil
-          hash[:refrigeration] = nil
-          hash[:generators] = nil
-
-          return hash
-        end
-
-        ##
-        # Convert to a Hash equivalent for JSON serialization.
-        ##
-        # - Exclude attributes with nil values.
-        # - Validate end_use hash properties against schema.
-        ##
-        def to_hash
-          result = {}
-
-          result[:heating] = @heating
-          result[:cooling] = @cooling
-          result[:interior_lighting] = @interior_lighting
-          result[:exterior_lighting] = @exterior_lighting
-          result[:interior_equipment] = @interior_equipment
-          result[:exterior_equipment] = @exterior_equipment
-          result[:fans] = @fans
-          result[:pumps] = @pumps
-          result[:heat_rejection] = @heat_rejection
-          result[:humidification] = @humidification
-          result[:heat_recovery] = @heat_recovery
-          result[:water_systems] = @water_systems
-          result[:refrigeration] = @refrigeration
-          result[:generators] = @generators
-
-          # validate end_use properties against schema
-          if @@validator.validate(@@schema[:definitions][:EndUse][:properties], result).any?
-            raise "end_use properties does not match schema: #{@@validator.validate(@@schema[:definitions][:EndUse][:properties], result)}"
-          end
-
-          return result
-        end
-
-        ##
-        # Aggregate values of each EndUse attribute.
-        ##
-        # [Parameters:]
-        # +new_end_use+ - _EndUse_ - An object of EndUse class.
-        ##
-        def merge_end_use!(new_end_use)
-          @heating += new_end_use.heating if new_end_use.heating
-          @cooling += new_end_use.cooling if new_end_use.cooling
-          @interior_lighting += new_end_use.interior_lighting if new_end_use.interior_lighting
-          @exterior_lighting += new_end_use.exterior_lighting if new_end_use.exterior_lighting
-          @interior_equipment += new_end_use.interior_equipment if new_end_use.interior_equipment
-          @exterior_equipment += new_end_use.exterior_equipment if new_end_use.exterior_equipment
-          @fans += new_end_use.fans if new_end_use.fans
-          @pumps += new_end_use.pumps if new_end_use.pumps
-          @heat_rejection += new_end_use.heat_rejection if new_end_use.heat_rejection
-          @humidification += new_end_use.humidification if new_end_use.humidification
-          @heat_recovery += new_end_use.heat_recovery if new_end_use.heat_recovery
-          @water_systems += new_end_use.water_systems if new_end_use.water_systems
-          @refrigeration += new_end_use.refrigeration if new_end_use.refrigeration
-          @generators += new_end_use.generators if new_end_use.generators
-
-          return self
-        end
-      end
-    end
-  end
-end

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

@@ -1,140 +0,0 @@
-# *********************************************************************************
-# URBANopt, 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,
-# 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.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
-# *********************************************************************************
-
-require 'urbanopt/scenario/default_reports/end_use'
-require 'urbanopt/scenario/default_reports/validator'
-require 'json-schema'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      ##
-      # Enduses class inlclude results for each fuel type.
-      ##
-      class EndUses
-        attr_accessor :electricity, :natural_gas, :additional_fuel, :district_cooling, :district_heating, :water # :nodoc:
-        ##
-        # EndUses class intialize end_uses(fuel type) attributes: +:electricity+ , +:natural_gas+ , +:additional_fuel+ ,
-        # +:district_cooling+ , +:district_heating+ , +:water+
-        ##
-        # [parameters:]
-        # +hash+ - _Hash_ - A hash which may contain a deserialized end_uses.
-        ##
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-          hash = defaults.merge(hash)
-
-          @electricity = EndUse.new(hash[:electricity])
-          @natural_gas = EndUse.new(hash[:natural_gas])
-          @additional_fuel = EndUse.new(hash[:additional_fuel])
-          @district_cooling = EndUse.new(hash[:district_cooling])
-          @district_heating = EndUse.new(hash[:district_heating])
-          @water = EndUse.new(hash[:water])
-
-          # initialize class variables @@validator and @@schema
-          @@validator ||= Validator.new
-          @@schema ||= @@validator.schema
-        end
-
-        ##
-        # Converts to a Hash equivalent for JSON serialization.
-        ##
-        # - Exclude attributes with nil values.
-        # - Validate end_uses hash properties against schema.
-        ##
-        def to_hash
-          result = {}
-
-          electricity_hash = @electricity.to_hash if @electricity.to_hash
-          electricity_hash.delete_if { |k, v| v.nil? }
-          result[:electricity] = electricity_hash if @electricity
-
-          natural_gas_hash = @natural_gas.to_hash if @natural_gas
-          natural_gas_hash.delete_if { |k, v| v.nil? }
-          result[:natural_gas] = natural_gas_hash if @natural_gas
-
-          additional_fuel_hash = @additional_fuel.to_hash if @additional_fuel
-          additional_fuel_hash.delete_if { |k, v| v.nil? }
-          result[:additional_fuel] = additional_fuel_hash if @additional_fuel
-
-          district_cooling_hash = @district_cooling.to_hash if @district_cooling
-          district_cooling_hash.delete_if { |k, v| v.nil? }
-          result[:district_cooling] = district_cooling_hash if @district_cooling
-
-          district_heating_hash = @district_heating.to_hash if @district_heating
-          district_heating_hash.delete_if { |k, v| v.nil? }
-          result[:district_heating] = district_heating_hash if @district_heating
-
-          water_hash = @water.to_hash if @water
-          water_hash.delete_if { |k, v| v.nil? }
-          result[:water] = water_hash if @water
-
-          # validate end_uses properties against schema
-          if @@validator.validate(@@schema[:definitions][:EndUses][:properties], result).any?
-            raise "end_uses properties does not match schema: #{@@validator.validate(@@schema[:definitions][:EndUses][:properties], result)}"
-          end
-
-          return result
-        end
-
-        ##
-        # Assigns default values if values do not exist.
-        ##
-        def defaults
-          hash = {}
-          hash[:electricity] = EndUse.new.to_hash
-          hash[:natural_gas] = EndUse.new.to_hash
-          hash[:additional_fuel] = EndUse.new.to_hash
-          hash[:district_cooling] = EndUse.new.to_hash
-          hash[:district_heating] = EndUse.new.to_hash
-          hash[:water] = EndUse.new.to_hash
-
-          return hash
-        end
-
-        ##
-        # Aggregates the values of each EndUse attribute.
-        ##
-        # [Parameters:]
-        # +new_end_uses+ - _EndUses_ - An object of EndUses class.
-        ##
-        def merge_end_uses!(new_end_uses)
-          # modify the existing_period by summing up the results ; # sum results only if they exist
-          @electricity.merge_end_use!(new_end_uses.electricity)
-          @natural_gas.merge_end_use!(new_end_uses.natural_gas)
-          @additional_fuel.merge_end_use!(new_end_uses.additional_fuel)
-          @district_cooling.merge_end_use!(new_end_uses.district_cooling)
-          @district_heating.merge_end_use!(new_end_uses.district_heating)
-          return self
-        end
-      end
-    end
-  end
-end

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

@@ -1,267 +0,0 @@
-# *********************************************************************************
-# URBANopt, 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,
-# 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.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-# OF THE POSSIBILITY OF SUCH DAMAGE.
-# *********************************************************************************
-
-require 'urbanopt/scenario/default_reports/construction_cost'
-require 'urbanopt/scenario/default_reports/program'
-require 'urbanopt/scenario/default_reports/location'
-require 'urbanopt/scenario/default_reports/reporting_period'
-require 'urbanopt/scenario/default_reports/timeseries_csv'
-require 'urbanopt/scenario/default_reports/distributed_generation'
-require 'urbanopt/scenario/default_reports/power_distribution'
-
-require 'urbanopt/scenario/default_reports/validator'
-require 'json-schema'
-
-require 'json'
-
-module URBANopt
-  module Scenario
-    module DefaultReports
-      ##
-      # FeatureReport generates two types of reports in a simulation_dir.
-      # The default_feature_reports measure writes a 'default_feature_reports.json' file containing
-      # information on all features in the simulation.  It also writes a 'default_feature_reports.csv'
-      # containing timeseries data for all features in the simulation.
-      # The DefaultPostProcessor reads these feature reports and aggregates them to create a ScenarioReport.
-      ##
-      class FeatureReport
-        attr_accessor :id, :name, :directory_name, :feature_type, :timesteps_per_hour, :simulation_status,
-                      :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation, :power_distribution # :nodoc:
-        ##
-        # Each FeatureReport object corresponds to a single Feature.
-        ##
-        # [parameters:]
-        # +hash+ - _Hash_ - A hash which may contain a deserialized feature_report.
-        ##
-        def initialize(hash = {})
-          hash.delete_if { |k, v| v.nil? }
-          hash = defaults.merge(hash)
-
-          @id = hash[:id]
-          @name = hash[:name]
-          @directory_name = hash[:directory_name]
-          @feature_type = hash[:feature_type]
-          @timesteps_per_hour = hash[:timesteps_per_hour]
-          @simulation_status = hash[:simulation_status]
-          @timeseries_csv = TimeseriesCSV.new(hash[:timeseries_csv])
-          @timeseries_csv.run_dir_name(@directory_name)
-          @location = Location.new(hash[:location])
-          @program = Program.new(hash[:program])
-          # design_parameters to add later
-          @construction_costs = []
-          hash[:construction_costs].each do |cc|
-            @constructiion_costs << ConstructionCost.new(cc)
-          end
-
-          @reporting_periods = []
-          hash[:reporting_periods].each do |rp|
-            @reporting_periods << ReportingPeriod.new(rp)
-          end
-
-          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation])
-
-          @power_distribution = PowerDistribution.new(hash[:power_distribution])
-
-          # initialize class variables @@validator and @@schema
-          @@validator ||= Validator.new
-          @@schema ||= @@validator.schema
-
-          # initialize feature report file name to be saved.
-          @file_name = 'default_feature_report'
-        end
-
-        ##
-        # Assign default values if values does not exist.
-        ##
-        def defaults
-          hash = {}
-          hash[:timeseries_csv] = {}
-          hash[:location] = {}
-          hash[:program] = {}
-          hash[:construction_costs] = []
-          hash[:reporting_periods] = []
-          hash[:distributed_generation] = {}
-          hash[:power_distribution] = {}
-          return hash
-        end
-
-        ##
-        # Return an Array of FeatureReports for the simulation_dir as multiple Features can be simulated together in a single simulation directory.
-        ##
-        # - Ensure that +simulation_dir+ include only one feature.
-        # - Read in the reports written by measure if they exist.
-        ##
-        # [parameters:]
-        # +simulation_dir+ - _SimulationDirOSW_ - A simulation directory from an OSW simulation, must include 'default_feature_reports' measure.
-        ##
-        def self.from_simulation_dir(simulation_dir)
-          result = []
-
-          # simulation dir can include only one feature
-          features = simulation_dir.features
-          if features.size != 1
-            raise 'FeatureReport cannot support multiple features per OSW'
-          end
-
-          # read in the reports written by measure
-          default_feature_reports_json = nil
-          default_feature_reports_csv = nil
-
-          simulation_status = simulation_dir.simulation_status
-          if simulation_status == 'Complete' || simulation_status == 'Failed'
-
-            # read in the scenario reports JSON and CSV
-            Dir.glob(File.join(simulation_dir.run_dir, '*_default_feature_reports/')).each do |dir|
-              scenario_reports_json_path = File.join(dir, 'default_feature_reports.json')
-              if File.exist?(scenario_reports_json_path)
-                File.open(scenario_reports_json_path, 'r') do |file|
-                  default_feature_reports_json = JSON.parse(file.read, symbolize_names: true)
-                end
-              end
-              scenario_reports_csv_path = File.join(dir, 'default_feature_reports.csv')
-              if File.exist?(scenario_reports_csv_path)
-                default_feature_reports_csv = scenario_reports_csv_path
-              end
-            end
-
-          end
-
-          # if we loaded the json
-          if default_feature_reports_json # && default_feature_reports_json[:feature_reports]
-            # default_feature_reports_json.each do |feature_report|
-            # result << FeatureReport.new(feature_report)
-            # end
-            result << FeatureReport.new(default_feature_reports_json) # should we keep it as an array !? or each each report can only include 1 feature
-
-          else
-            # we did not find a report
-            features.each do |feature|
-              hash = {}
-              hash[:id] = feature.id
-              hash[:name] = feature.name
-              hash[:directory_name] = simulation_dir.run_dir
-              hash[:simulation_status] = simulation_status
-              result << FeatureReport.new(hash)
-            end
-          end
-
-          # validate feature_report json against schema
-          if @@validator.validate(@@schema[:definitions][:FeatureReport][:properties], default_feature_reports_json).any?
-            raise "default_feature_report_json properties does not match schema: #{@@validator.validate(@@schema[:definitions][:FeatureReport][:properties], default_feature_reports_json)}"
-          end
-
-          return result
-        end
-
-        ##
-        # Convert to a Hash equivalent for JSON serialization
-        ##
-        # - Exclude attributes with nil values.
-        # - Validate feature_report hash properties against schema.
-        ##
-        def to_hash
-          result = {}
-          result[:id] = @id if @id
-          result[:name] = @name if @name
-          result[:directory_name] = @directory_name if @directory_name
-          result[:feature_type] = @feature_type if @feature_type
-          result[:timesteps_per_hour] = @timesteps_per_hour if @timesteps_per_hour
-          result[:simulation_status] = @simulation_status if @simulation_status
-          result[:timeseries_csv] = @timeseries_csv.to_hash
-
-          result[:location] = @location.to_hash if @location
-
-          result[:program] = @program.to_hash
-
-          result[:construction_costs] = []
-          @construction_costs.each { |cc| result[:construction_costs] << cc.to_hash }
-
-          result[:reporting_periods] = []
-          @reporting_periods.each { |rp| result[:reporting_periods] << rp.to_hash }
-
-          result[:distributed_generation] = @distributed_generation.to_hash if @distributed_generation
-
-          result[:power_distribution] = @power_distribution.to_hash if @power_distribution
-
-          # validate feature_report properties against schema
-          if @@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result).any?
-            raise "feature_report properties does not match schema: #{@@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result)}"
-          end
-
-          return result
-        end
-
-        ##
-        # Saves the 'default_feature_report.json' and 'default_feature_report.csv' files
-        ##
-        # [parameters]:
-        # +file_name+ - _String_ - Assign a name to the saved feature report results file without an extension
-        def save_feature_report(file_name = 'default_feature_report')
-          # reassign the initialize local variable @file_name to the file name input.
-          @file_name = file_name
-
-          # 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
-
-          # feature_hash
-          feature_hash = to_hash
-
-          json_name_path = File.join(@directory_name, 'feature_reports', file_name + '.json')
-
-          File.open(json_name_path, 'w') do |f|
-            f.puts JSON.pretty_generate(feature_hash)
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue StandardError
-              f.flush
-            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')
-          end
-          return true
-        end
-      end
-    end
-  end
-end