RubyGems - urbanopt-reporting - Versions diffs - 0.3.0 → 0.3.5 - Mend

urbanopt-reporting 0.3.0 → 0.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/lib/measures/export_time_series_modelica/resources/report.html.in ADDED Viewed

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>ReportingMeasure</title>
+<link href="http://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet">
+<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
+<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/d3/3.3.9/d3.min.js"></script>
+</head>
+<body>
+<%= output %>
+</body>
+</html>

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

@@ -38,7 +38,7 @@ module URBANopt
       # Enduse class all enduse energy consumption results.
       ##
       class EndUse
-        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment,
+        attr_accessor :heating, :cooling, :interior_lighting, :exterior_lighting, :interior_equipment, :exterior_equipment, :electric_vehicles,
                       :fans, :pumps, :heat_rejection, :humidification, :heat_recovery, :water_systems, :refrigeration, :generators # :nodoc:
         ##
@@ -59,6 +59,7 @@ module URBANopt
           @exterior_lighting = hash[:exterior_lighting]
           @interior_equipment = hash[:interior_equipment]
           @exterior_equipment = hash[:exterior_equipment]
+          @electric_vehicles = hash[:electric_vehicles]
           @fans = hash[:fans]
           @pumps = hash[:pumps]
           @heat_rejection = hash[:heat_rejection]
@@ -85,6 +86,7 @@ module URBANopt
           hash[:exterior_lighting] = nil
           hash[:interior_equipment] = nil
           hash[:exterior_equipment] = nil
+          hash[:electric_vehicles] = nil
           hash[:fans] = nil
           hash[:pumps] = nil
           hash[:heat_rejection] = nil
@@ -112,6 +114,7 @@ module URBANopt
           result[:exterior_lighting] = @exterior_lighting
           result[:interior_equipment] = @interior_equipment
           result[:exterior_equipment] = @exterior_equipment
+          result[:electric_vehicles] = @electric_vehicles
           result[:fans] = @fans
           result[:pumps] = @pumps
           result[:heat_rejection] = @heat_rejection
@@ -129,27 +132,46 @@ module URBANopt
           return result
         end
+        ##
+        # Adds up +existing_value+ and +new_values+ if not nill.
+        ##
+        # [parameter:]
+        # +existing_value+ - _Float_ - A value corresponding to a EndUse attribute.
+        ##
+        # +new_value+ - _Float_ - A value corresponding to a EndUse attribute.
+        ##
+        def add_values(existing_value, new_value)
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
         ##
         # Aggregate values of each EndUse attribute.
         ##
         # [Parameters:]
-        # +new_end_use+ - _EndUse_ - An object of EndUse class.
+        # +other+ - _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
+        def merge_end_use!(other)
+          @heating = add_values(@heating, other.heating)
+          @cooling = add_values(@cooling, other.cooling)
+          @interior_lighting = add_values(@interior_lighting, other.interior_lighting)
+          @exterior_lighting = add_values(@exterior_lighting, other.exterior_lighting)
+          @interior_equipment = add_values(@interior_equipment, other.interior_equipment)
+          @exterior_equipment = add_values(@exterior_equipment, other.exterior_equipment)
+          @electric_vehicles = add_values(@electric_vehicles, other.electric_vehicles)
+          @fans = add_values(@fans, other.fans)
+          @pumps = add_values(@pumps, other.pumps)
+          @heat_rejection = add_values(@heat_rejection, other.heat_rejection)
+          @humidification = add_values(@humidification, other.humidification)
+          @heat_recovery = add_values(@heat_recovery, other.heat_recovery)
+          @water_systems = add_values(@water_systems, other.water_systems)
+          @refrigeration = add_values(@refrigeration, other.refrigeration)
+          @generators = add_values(@generators, other.generators)
           return self
         end

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

@@ -40,6 +40,7 @@ require_relative  'thermal_storage'
 require 'json-schema'
 require 'json'
+require 'fileutils'
 module URBANopt
   module Reporting
@@ -223,6 +224,66 @@ module URBANopt
           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 results file without an extension
+        def save(file_name = 'default_feature_report')
+          # reassign the initialize local variable @file_name to the file name input.
+          @file_name = file_name
+          # save the feature reports csv and json data
+          old_timeseries_path = nil
+          if !@timeseries_csv.path.nil?
+            old_timeseries_path = @timeseries_csv.path
+          end
+          # 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'))
+          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          FileUtils.mkdir_p File.dirname(@timeseries_csv.path)
+          @timeseries_csv.save_data
+          ## save json rport
+          # feature_hash
+          feature_hash = to_hash
+          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)
+            # 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, file_name + '.csv')
+          end
+          return true
+        end
+        ##
+        # 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 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
         ##
@@ -252,7 +313,6 @@ module URBANopt
               f.flush
             end
           end
         end
         ##
@@ -275,13 +335,10 @@ module URBANopt
           # 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'))
+              FileUtils.cp(File.join(f, 'default_feature_reports.csv'), File.join(results_dir_path, @file_name + '.csv'))
             end
           end
         end
       end
     end
   end

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

@@ -43,13 +43,13 @@ 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_kwh, :total_source_energy_kwh,
+        attr_accessor :id, :name, :multiplier, :start_date, :end_date, :month, :day_of_month, :year, :total_site_energy_kwh, :total_source_energy_kwh, :site_EUI_kwh_per_m2, :site_EUI_kbtu_per_ft2, :source_EUI_kwh_per_m2, :source_EUI_kbtu_per_ft2,
                       :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_kwh+ , +:total_source_energy_kwh+ ,
+        # +:id+ , +:name+ , +:multiplier+ , +:start_date+ , +:end_date+ , +:month+ , +:day_of_month+ , +:year+ , +:total_site_energy_kwh+ , +:total_source_energy_kwh+ , +:site_EUI_kwh_per_m2+, +:site_EUI_kbtu_per_ft2+, +:source_EUI_kwh_per_m2+, +:source_EUI_kbtu_per_ft2+,
         # +: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+ ,
@@ -70,6 +70,10 @@ module URBANopt
           @total_site_energy_kwh = hash[:total_site_energy_kwh]
           @total_source_energy_kwh = hash[:total_source_energy_kwh]
+          @site_EUI_kwh_per_m2 = hash[:site_EUI_kwh_per_m2]
+          @site_EUI_kbtu_per_ft2 = hash[:site_EUI_kbtu_per_ft2]
+          @source_EUI_kwh_per_m2 = hash[:source_EUI_kwh_per_m2]
+          @source_EUI_kbtu_per_ft2 = hash[:source_EUI_kbtu_per_ft2]
           @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]
@@ -110,6 +114,10 @@ module URBANopt
           hash[:total_site_energy_kwh] = nil
           hash[:total_source_energy_kwh] = nil
+          hash[:site_EUI_kwh_per_m2] = nil
+          hash[:site_EUI_kbtu_per_ft2] = nil
+          hash[:source_EUI_kwh_per_m2] = nil
+          hash[:source_EUI_kbtu_per_ft2] = nil
           hash[:net_site_energy_kwh] = nil
           hash[:net_source_energy_kwh] = nil
           hash[:net_utility_cost_dollar] = nil
@@ -148,6 +156,10 @@ module URBANopt
           result[:end_date] = @end_date.to_hash if @end_date
           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[:site_EUI_kwh_per_m2] = @site_EUI_kwh_per_m2 if @site_EUI_kwh_per_m2
+          result[:site_EUI_kbtu_per_ft2] = @site_EUI_kbtu_per_ft2 if @site_EUI_kbtu_per_ft2
+          result[:source_EUI_kwh_per_m2] = @source_EUI_kwh_per_m2 if @source_EUI_kwh_per_m2
+          result[:source_EUI_kbtu_per_ft2] = @source_EUI_kbtu_per_ft2 if @source_EUI_kbtu_per_ft2
           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

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

@@ -147,7 +147,7 @@ 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')
+        def save(file_name = 'default_scenario_report', save_feature_reports = true)
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
@@ -185,10 +185,15 @@ module URBANopt
             @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
           end
-          # save the feature reports csv and json data
-          # @feature_reports.each do |feature_report|
-          #  feature_report.save_feature_report()
-          # end
+          if save_feature_reports
+            if file_name == 'default_scenario_report'
+              file_name = 'default_feature_report'
+            end
+            #save the feature reports csv and json data
+            @feature_reports.each do |feature_report|
+             feature_report.save file_name
+            end
+          end
           return true
         end

data/lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt CHANGED Viewed

@@ -10,6 +10,7 @@ Heating:Electricity
 InteriorLights:Electricity
 ExteriorLights:Electricity
 InteriorEquipment:Electricity
+ExteriorEquipment:Electricity
 Fans:Electricity
 Pumps:Electricity
 WaterSystems:Electricity

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

@@ -271,6 +271,18 @@
 					"description": "Total source energy used, does not include generation (kWh)",
 					"type": "number"
 				},
+				"site_EUI_kwh_per_m2": {
+					"type": "number"
+				},
+				"site_EUI_kBtu_per_ft2": {
+					"type": "number"
+				},
+				"source_EUI_kwh_per_m2": {
+					"type": "number"
+				},
+				"source_EUI_kBtu_per_ft2": {
+					"type": "number"
+				},
 				"net_site_energy_kwh": {
 					"description": "Net site energy (kWh)",
 					"type": "number"
@@ -301,14 +313,14 @@
 					"description": "Sum of all natural gas end uses consumption (kWh)",
 					"type": "number"
 				},
-        "propane_kwh": {
+				"propane_kwh": {
 					"description": "Sum of all propane end uses consumption (kWh)",
 					"type": "number"
-        },
-        "fuel_oil_kwh": {
+				},
+				"fuel_oil_kwh": {
 					"description": "Sum of all fuel oil #2 end uses consumption (kWh)",
 					"type": "number"
-        },
+				},
 				"other_fuels_kwh": {
 					"description": "Sum of all other (fuel oil #1, diesel, gasoline, coal, steam) fuel end uses consumption (kWh)",
 					"type": "number"
@@ -379,12 +391,12 @@
 				"natural_gas_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-        "propane_kwh": {
-          "$ref": "#/definitions/EndUse"
-        },
-        "fuel_oil_kwh": {
-          "$ref": "#/definitions/EndUse"
-        },
+				"propane_kwh": {
+					"$ref": "#/definitions/EndUse"
+				},
+				"fuel_oil_kwh": {
+					"$ref": "#/definitions/EndUse"
+				},
 				"other_fuels_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
@@ -421,6 +433,9 @@
 				"exterior_equipment": {
 					"type": "number"
 				},
+				"electric_vehicles": {
+					"type": "number"
+				},
 				"fans": {
 					"type": "number"
 				},
@@ -536,8 +551,8 @@
 					"enum": [
 						"Electricity",
 						"Natural Gas",
-            "Propane",
-            "Fuel Oil",
+						"Propane",
+						"Fuel Oil",
 						"District Cooling",
 						"District Heating",
 						"Other Fuels",

data/lib/urbanopt/reporting/version.rb CHANGED Viewed

@@ -30,6 +30,6 @@
 module URBANopt
   module Reporting
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.3.5'.freeze
   end
 end

data/urbanopt-reporting-gem.gemspec CHANGED Viewed

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_runtime_dependency 'json-schema', '~> 2.8'
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
-  spec.add_runtime_dependency 'openstudio-extension', '~> 0.3.1'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.3.2'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
 description: Library include scenario default reporting measure and scenario defaults
   reports schema and classes
 email:
@@ -144,6 +144,21 @@ files:
 - lib/measures/default_feature_reports/README.md.erb
 - lib/measures/default_feature_reports/measure.rb
 - lib/measures/default_feature_reports/measure.xml
+- lib/measures/export_modelica_loads/LICENSE.md
+- lib/measures/export_modelica_loads/README.md
+- lib/measures/export_modelica_loads/README.md.erb
+- lib/measures/export_modelica_loads/docs/.gitkeep
+- lib/measures/export_modelica_loads/measure.rb
+- lib/measures/export_modelica_loads/measure.xml
+- lib/measures/export_modelica_loads/resources/report.html.in
+- lib/measures/export_time_series_modelica/LICENSE.md
+- lib/measures/export_time_series_modelica/README.md
+- lib/measures/export_time_series_modelica/README.md.erb
+- lib/measures/export_time_series_modelica/docs/.gitkeep
+- lib/measures/export_time_series_modelica/measure.rb
+- lib/measures/export_time_series_modelica/measure.xml
+- lib/measures/export_time_series_modelica/resources/os_lib_helper_methods.rb
+- lib/measures/export_time_series_modelica/resources/report.html.in
 - lib/urbanopt/reporting.rb
 - lib/urbanopt/reporting/default_reports.rb
 - lib/urbanopt/reporting/default_reports/construction_cost.rb