urbanopt-scenario 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8cb63dabcc5a248580c0f5941030e985d95aa03f5cf6e9ecaeead96b5879d3a
-  data.tar.gz: ba1fba337a0c9daf1ef6f699bb44864fc663a604bc2d6806919b44947326d7c6
+  metadata.gz: 07bc344e1b00e7a82bae3418bccb9883d3545961b49c3f9b887993bb0f76e3fe
+  data.tar.gz: '09911a325c45c5b38ea4eed13758e5306cf674b62485b7dd9fc271f12734e62d'
 SHA512:
-  metadata.gz: 81d7ecde2901d1f8cef37c69ab4052cad2a70e9e87654724d09374cb6646eb9ef61393451e0215ac784534dde74647ca2719d1cb943306a7bf0d45fb1d0d16bf
-  data.tar.gz: d9c810fb5d2bda25f6b9910b4e49e6ab7c9a1c065e3570319e85a4d58cd4f047f7d30e1a651bf7c4a6ed867b3f418255d5c7dd1aa4cf342c11a3c369680ed8fb
+  metadata.gz: 5e7e5cfd5eb849e97d3691d9001e26422cf90bda0cd0f471367189f11afdecd4bcdfc3baa4171e9e86574e0bb9ba7d125aed9da61982f24c564b2b0ae6b18cec
+  data.tar.gz: 7b11327eb4ea23787255a49c00a7db44f4172bb62f0583273ce7c8ddee2925b5e09057cc0dd68101f24d1adf82f386d6cffc3b089adb808573cef48ea6ae1fd4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # URBANopt Scenario Gem
 
+## Version 0.4.2
+Date Range: 09/29/20 - 09/30/20
+
+- Fixed [#158]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/158 ), SQLite Query fix for gas consumption reporting
+
 ## Version 0.4.1
 Date Range: 09/22/20 - 09/28/20
 

data/Gemfile

@@ -32,21 +32,21 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
 # end
 
-#if allow_local && File.exist?('../urbanopt-core-gem')
-#	gem 'urbanopt-core', path: '../urbanopt-core-gem'
-#elsif allow_local
-#	gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
-#else
-#	gem 'urbanopt-core', '~>0.4.0'
-#end
-
-#if allow_local && File.exist?('../urbanopt-reporting-gem')
+# if allow_local && File.exist?('../urbanopt-core-gem')
+#  gem 'urbanopt-core', path: '../urbanopt-core-gem'
+# elsif allow_local
+#  gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
+# else
+#  gem 'urbanopt-core', '~>0.4.0'
+# end
+
+# if allow_local && File.exist?('../urbanopt-reporting-gem')
 #  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
-#elsif allow_local
+# elsif allow_local
 #  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
-#else
-#	gem 'urbanopt-reporting', '~> 0.2.0'
-#end
+# else
+#  gem 'urbanopt-reporting', '~> 0.2.0'
+# end
 
 # if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
 #   gem 'openstudio-load-flexibility-measures', path: '../openstudio-load-flexibility-measures-gem'

data/README.md

@@ -1,6 +1,6 @@
 # URBANopt Scenario Gem 
 
-The URBANopt<sup>&trade;</sup> Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+The URBANopt<sup>&trade;</sup> Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. The ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
 

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -91,21 +91,27 @@ module URBANopt
         scenario_db = SQLite3::Database.open new_db_file
         scenario_db.execute "CREATE TABLE IF NOT EXISTS ReportData(
           TimeIndex INTEGER,
+          Year VARCHAR(255),
+          Month VARCHAR(255),
+          Day VARCHAR(255),
+          Hour VARCHAR(255),
+          Minute VARCHAR(255),
+          Dst INTEGER,
           ReportDataDictionaryIndex INTEGER,
           Value INTEGER
           )"
 
         values_arr = []
         feature_list = Pathname.new(@initialization_hash[:directory_name]).children.select(&:directory?) # Folders in the run/scenario directory
-        
+
         # get scenario CSV
         scenario_csv = File.join(@initialization_hash[:root_dir], @initialization_hash[:name] + '.csv')
         if File.exist?(scenario_csv)
           # csv found
-          feature_ids = CSV.read(scenario_csv, :headers => true)
+          feature_ids = CSV.read(scenario_csv, headers: true)
           feature_list = []
           # loop through building feature ids from scenario csv
-          feature_ids["Feature Id"].each do |feature|
+          feature_ids['Feature Id'].each do |feature|
             if Dir.exist?(File.join(@initialization_hash[:directory_name], feature))
               feature_list << File.join(@initialization_hash[:directory_name], feature)
             else
@@ -121,40 +127,45 @@ module URBANopt
           feature_db = SQLite3::Database.open uo_output_sql_file
           # Doing "db.results_as_hash = true" is prettier, but in this case significantly slower.
 
-          # RDDI == 10 is the timestep value for facility electricity
-          elec_query = feature_db.query "SELECT TimeIndex, Value
-            FROM ReportData
-            WHERE (TimeIndex % 2) != 0
-            AND ReportDataDictionaryIndex=10 order by TimeIndex"
+          # RDDI == 10 is the timestep value for facility electricity in OS 3.0.1
+          # TODO: Dynamically read RDDI from table RDDI, insted of hardcoding it
+          elec_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour, Time.Minute, Time.Dst, ReportData.Value
+          FROM ReportData
+          INNER JOIN Time ON Time.TimeIndex=ReportData.TimeIndex
+          WHERE ReportDataDictionaryIndex == 10
+          ORDER BY ReportData.TimeIndex"
 
           elec_query.each do |row| # Add up all the values for electricity usage across all Features at this timestep
             # row[0] == TimeIndex, row[1] == Value
+
             arr_match = values_arr.find { |v| v[:time_index] == row[0] }
             if arr_match.nil?
               # add new row to value_arr
-              values_arr << { time_index: row[0], elec_val: Float(row[1]), gas_val: 0 }
+              values_arr << { time_index: row[0], year: row[1], month: row[2], day: row[3], hour: row[4], minute: row[5], dst: row[6], elec_val: Float(row[7]), gas_val: 0 }
             else
               # running sum
-              arr_match[:elec_val] += Float(row[1])
+              arr_match[:elec_val] += Float(row[7])
             end
           end # End elec_query
           elec_query.close
 
-          # RDDI == 255 is the timestep value for facility gas
-          gas_query = feature_db.query "SELECT TimeIndex, Value
-            FROM ReportData
-            WHERE (TimeIndex % 2) != 0
-            AND ReportDataDictionaryIndex=255 order by TimeIndex"
+          # RDDI == 1382 is the timestep value for facility gas in OS 3.0.1
+          # TODO: Dynamically read RDDI from table RDDI, insted of hardcoding it
+          gas_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour, Time.Minute, Time.Dst, ReportData.Value
+          FROM ReportData
+          INNER JOIN Time ON Time.TimeIndex=ReportData.TimeIndex
+          WHERE ReportDataDictionaryIndex == 1382
+          ORDER BY ReportData.TimeIndex"
 
           gas_query.each do |row|
             # row[0] == TimeIndex, row[1] == Value
             arr_match = values_arr.find { |v| v[:time_index] == row[0] }
             if arr_match.nil?
               # add new row to value_arr
-              values_arr << { time_index: row[0], gas_val: Float(row[1]), elec_val: 0 }
+              values_arr << { time_index: row[0], year: row[1], month: row[2], day: row[3], hour: row[4], minute: row[5], dst: row[6], gas_val: Float(row[7]), elec_val: 0 }
             else
               # running sum
-              arr_match[:gas_val] += Float(row[1])
+              arr_match[:gas_val] += Float(row[7])
             end
           end # End gas_query
           gas_query.close
@@ -164,13 +175,13 @@ module URBANopt
         elec_sql = []
         gas_sql = []
         values_arr.each do |i|
-          elec_sql << "(#{i[:time_index]}, 10, #{i[:elec_val]})"
-          gas_sql << "(#{i[:time_index]}, 255, #{i[:gas_val]})"
+          elec_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]}, 10, #{i[:elec_val]})"
+          gas_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]}, 1382, #{i[:gas_val]})"
         end
 
         # Put summed Values into the database
-        scenario_db.execute("INSERT INTO ReportData (TimeIndex, ReportDataDictionaryIndex, Value) VALUES #{elec_sql.join(', ')}")
-        scenario_db.execute("INSERT INTO ReportData (TimeIndex, ReportDataDictionaryIndex, Value) VALUES #{gas_sql.join(', ')}")
+        scenario_db.execute("INSERT INTO ReportData VALUES #{elec_sql.join(', ')}")
+        scenario_db.execute("INSERT INTO ReportData VALUES #{gas_sql.join(', ')}")
         scenario_db.close
       end
 

data/lib/urbanopt/scenario/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler