urbanopt-scenario 0.4.1 → 0.5.1

data/docs/package.json

@@ -10,11 +10,11 @@
   },
   "author": "NREL",
   "dependencies": {
-    "highlight.js": "^10.2.0",
+    "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^1.5.4",
-    "webpack-dev-middleware": "^3.7.2"
+    "vuepress": "^1.6.0",
+    "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
     "braces": "^3.0.2",
@@ -25,6 +25,7 @@
     "node-forge": ">=0.10.0",
     "serialize-javascript": "^5.0.1",
     "set-value": "^3.0.2",
-    "yargs-parser": ">=18.1.1"
+    "yargs-parser": "^20.2.1",
+    "ini": "^2.0.0"
   }
 }

data/lib/urbanopt/scenario/extension.rb

@@ -39,14 +39,15 @@ module URBANopt
       end
 
       ##
-      # Returns the absolute path of the measures or nil if there is none, can be used when configuring OSWs.
+      # [return:] Absolute path of the measures or nil if there is none, can be used when configuring OSWs.
       def measures_dir
         return File.absolute_path(File.join(@root_dir, 'lib', 'measures'))
       end
 
       ##
       # Relevant files such as weather data, design days, etc.
-      # Return the absolute path of the files or nil if there is none, used when configuring OSWs
+      ##
+      # [return:] Absolute path of the files or nil if there is none, used when configuring OSWs
       def files_dir
         return nil
       end
@@ -54,7 +55,8 @@ module URBANopt
       ##
       # Doc templates are common files like copyright files which are used to update measures and other code.
       # Doc templates will only be applied to measures in the current repository.
-      # Return the absolute path of the doc templates dir or nil if there is none.
+      ##
+      # [return:] Absolute path of the doc templates dir or nil if there is none.
       def doc_templates_dir
         return File.absolute_path(File.join(@root_dir, 'doc_templates'))
       end

data/lib/urbanopt/scenario/scenario_base.rb

@@ -36,10 +36,10 @@ module URBANopt
       # Initialize ScenarioBase attributes: +name+ , +root directory+ , +run directory+ and +feature_file+
       ##
       # [parameters:]
-      # +name+ - _String_ - Human readable scenario name.
-      # +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
-      # +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
-      # +feature_file+ - _FeatureFile_ - An instance of +URBANopt::Core::FeatureFile+ containing features for simulation.
+      # * +name+ - _String_ - Human readable scenario name.
+      # * +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
+      # * +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
+      # * +feature_file+ - _FeatureFile_ - An instance of +URBANopt::Core::FeatureFile+ containing features for simulation.
       def initialize(name, root_dir, run_dir, feature_file)
         @name = name
         @root_dir = root_dir

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -42,14 +42,13 @@ module URBANopt
       # The CSV file has three columns 1) feature_id, 2) feature_name, and 3) mapper_class_name.  There is one row for each Feature.
       ##
       # [parameters:]
-      # +name+ - _String_ - Human readable scenario name.
-      # +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
-      # +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
-      # +feature_file+ - _URBANopt::Core::FeatureFile_ - FeatureFile containing features to simulate.
-      # +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
-      # +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
-      # +num_header_rows+ - _Strng_ - Number of header rows to skip in CSV file.
-
+      # * +name+ - _String_ - Human readable scenario name.
+      # * +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
+      # * +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
+      # * +feature_file+ - _URBANopt::Core::FeatureFile_ - FeatureFile containing features to simulate.
+      # * +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
+      # * +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
+      # * +num_header_rows+ - _String_ - Number of header rows to skip in CSV file.
       def initialize(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows)
         super(name, root_dir, run_dir, feature_file)
         @mapper_files_dir = mapper_files_dir

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -38,10 +38,10 @@ module URBANopt
       # A Simulation Mapper will map the
       ##
       # [parameters:]
-      #  +scenario+ - _ScenarioBase_ - Scenario containing this ScenarioDatapoint.
-      #  +feature_id+ - _String_ - Unique id of the feature for this ScenarioDatapoint.
-      #  +feature_name+ - _String_ - Human readable name of the feature for this ScenarioDatapoint.
-      #  +mapper_class+ - _String_ - Name of Ruby class used to translate feature to simulation OSW.
+      # * +scenario+ - _ScenarioBase_ - Scenario containing this ScenarioDatapoint.
+      # * +feature_id+ - _String_ - Unique id of the feature for this ScenarioDatapoint.
+      # * +feature_name+ - _String_ - Human readable name of the feature for this ScenarioDatapoint.
+      # * +mapper_class+ - _String_ - Name of Ruby class used to translate feature to simulation OSW.
       def initialize(scenario, feature_id, feature_name, mapper_class)
         @scenario = scenario
         @feature_id = feature_id

data/lib/urbanopt/scenario/scenario_post_processor_base.rb

@@ -35,7 +35,7 @@ module URBANopt
       # ScenarioPostProcessorBase post-processes a Scenario to create scenario level results.
       ##
       # [parameters:]
-      # +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
+      # * +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
       def initialize(scenario_base)
         @scenario_base = scenario_base
       end
@@ -53,7 +53,7 @@ module URBANopt
       # Add results from a simulation_dir to this result.
       ##
       # [parameters:]
-      # +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
+      # * +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
       def add_simulation_dir(simulation_dir)
         raise 'add_simulation_dir not implemented for ScenarioPostProcessorBase, override in your class'
       end

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -32,8 +32,6 @@ require 'urbanopt/scenario/scenario_post_processor_base'
 require 'urbanopt/reporting/default_reports'
 
 require 'csv'
-require 'json'
-require 'fileutils'
 require 'sqlite3'
 
 module URBANopt
@@ -43,7 +41,7 @@ module URBANopt
       # ScenarioPostProcessorBase post-processes a scenario to create scenario level results
       ##
       # [parameters:]
-      # +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
+      # * +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
       def initialize(scenario_base)
         super(scenario_base)
 
@@ -69,7 +67,7 @@ module URBANopt
       # Add results from a simulation_dir to this result.
       ##
       # [parameters:]
-      # +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
+      # * +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
       def add_simulation_dir(simulation_dir)
         feature_reports = URBANopt::Reporting::DefaultReports::FeatureReport.from_simulation_dir(simulation_dir)
 
@@ -86,26 +84,36 @@ module URBANopt
 
       # Create database file with scenario-level results
       #   Sum values for each timestep across all features. Save to new table in a new database
+      ##
+      # [parameters:]
+      # * +file_name+ - _String_ - Assign a name to the saved scenario results file
       def create_scenario_db_file(file_name = @default_save_name)
         new_db_file = File.join(@initialization_hash[:directory_name], "#{file_name}.db")
         scenario_db = SQLite3::Database.open new_db_file
         scenario_db.execute "CREATE TABLE IF NOT EXISTS ReportData(
           TimeIndex INTEGER,
-          ReportDataDictionaryIndex INTEGER,
-          Value INTEGER
+          Year VARCHAR(255),
+          Month VARCHAR(255),
+          Day VARCHAR(255),
+          Hour VARCHAR(255),
+          Minute VARCHAR(255),
+          Dst INTEGER,
+          FuelType VARCHAR(255),
+          Value INTEGER,
+          FuelUnits VARCHAR(255)
           )"
 
         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
@@ -115,46 +123,54 @@ module URBANopt
         else
           raise "Couldn't find scenario CSV: #{scenario_csv}"
         end
-        feature_1_name = File.basename(feature_list[0]) # Get name of first feature, so we can read eplusout.sql from there
-        uo_output_sql_file = File.join(@initialization_hash[:directory_name], feature_1_name, 'eplusout.sql')
         feature_list.each do |feature| # Loop through each feature in the scenario
+          uo_output_sql_file = File.join(@initialization_hash[:directory_name], File.basename(feature), 'eplusout.sql')
           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"
+          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
+          INNER JOIN ReportDataDictionary AS rddi ON rddi.ReportDataDictionaryIndex=ReportData.ReportDataDictionaryIndex
+          WHERE rddi.IndexGroup == 'Facility:Electricity'
+          AND rddi.ReportingFrequency == 'Zone Timestep'
+          AND Time.Year > 1900
+          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"
+          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
+          INNER JOIN ReportDataDictionary AS rddi ON rddi.ReportDataDictionaryIndex=ReportData.ReportDataDictionaryIndex
+          WHERE rddi.IndexGroup == 'Facility:Gas'
+          AND rddi.ReportingFrequency == 'Zone Timestep'
+          AND Time.Year > 1900
+          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 +180,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]}, 'Electricity', #{i[:elec_val]}, 'J')"
+          gas_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]}, 'Gas', #{i[:gas_val]}, 'J')"
         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
 
@@ -178,7 +194,7 @@ module URBANopt
       # Save scenario result
       ##
       # [parameters:]
-      # +file_name+ - _String_ - Assign a name to the saved scenario results file
+      # * +file_name+ - _String_ - Assign a name to the saved scenario results file
       def save(file_name = @default_save_name)
         @scenario_result.save
 

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -34,7 +34,6 @@ require 'urbanopt/reporting/default_reports'
 require 'csv'
 require 'json'
 require 'fileutils'
-require 'pathname'
 
 module URBANopt
   module Scenario
@@ -43,8 +42,8 @@ module URBANopt
       # OpenDSSPostProcessor post-processes OpenDSS results to selected OpenDSS results and integrate them in scenario and feature reports.
       ##
       # [parameters:]
-      # +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
-      # +opendss_results_dir_name+ - _directory name of opendss results
+      # * +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
+      # * +opendss_results_dir_name+ - _directory name of opendss results
       def initialize(scenario_report, opendss_results_dir_name = 'opendss')
         if !scenario_report.nil?
           @scenario_report = scenario_report
@@ -202,9 +201,9 @@ module URBANopt
       # Save csv report method
       ##
       # [parameters:]
-      # +feature_report+ - _feature report object_ - An onject of the feature report
-      # +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
-      # +file_name+ - _String_ - Assigned name to save the file with no extension
+      # * +feature_report+ - _feature report object_ - An onject of the feature report
+      # * +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
+      # * +file_name+ - _String_ - Assigned name to save the file with no extension
       def save_csv(feature_report, updated_feature_report_csv, file_name = 'default_feature_report')
         File.write(File.join(feature_report.directory_name, 'feature_reports', "#{file_name}.csv"), updated_feature_report_csv)
       end
@@ -213,7 +212,7 @@ module URBANopt
       # create opendss json report results
       ##
       # [parameters:]
-      # +feature_report+ - _feature report object_ - An onject of the feature report
+      # * +feature_report+ - _feature report object_ - An onject of the feature report
       def add_summary_results(feature_report)
         under_voltage_hrs = 0
         over_voltage_hrs = 0
@@ -258,7 +257,7 @@ module URBANopt
           updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
 
           # save fetaure reports
-          feature_report.save_feature_report('default_feature_report_opendss')
+          feature_report.save_json_report('default_feature_report_opendss')
 
           # resave updated csv report
           save_csv(feature_report, updated_feature_csv, 'default_feature_report_opendss')
@@ -268,7 +267,8 @@ module URBANopt
         save_transformers_reports
 
         # save the updated scenario reports
-        @scenario_report.save(file_name = 'scenario_report_opendss')
+        # set save_feature_reports to false since only the scenario reports should be saved now
+        @scenario_report.save(file_name = 'scenario_report_opendss', save_feature_reports = false)
       end
     end
   end

data/lib/urbanopt/scenario/scenario_runner_base.rb

@@ -40,8 +40,9 @@ module URBANopt
       # Create all SimulationDirs for Scenario.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for scenario.
-      # +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files
+      # * +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for scenario.
+      # * +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files
+      ##
       # [return:] _Array_ Returns an array of all SimulationDirs, even those created previously, for Scenario.
       def create_simulation_files(scenario, force_clear = false)
         raise 'create_input_files is not implemented for ScenarioRunnerBase, override in your class'
@@ -51,9 +52,9 @@ module URBANopt
       # Create and run all SimulationFiles for Scenario.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario to create and run simulation input files for.
-      # +force_clear+ - _Bool_ - Clear Scenario before creating Simulation input files.
-      #
+      # * +scenario+ - _ScenarioBase_ - Scenario to create and run simulation input files for.
+      # * +force_clear+ - _Bool_ - Clear Scenario before creating Simulation input files.
+      ##
       # [return:] _Array_ Returns an array of all SimulationDirs, even those created previously, for Scenario.
       def run(scenario, force_clear = false, options = {})
         raise 'run is not implemented for ScenarioRunnerBase, override in your class'

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -46,8 +46,9 @@ module URBANopt
       # Create all OSWs for Scenario.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for.
-      # +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files.
+      # * +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for.
+      # * +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files.
+      ##
       # [return:] _Array_ Returns array of all SimulationDirs, even those created previously, for Scenario.
       def create_simulation_files(scenario, force_clear = false)
         if force_clear
@@ -79,8 +80,9 @@ module URBANopt
       # - Run osw file groups in order and store simulation failure in a array.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario to create and run SimulationFiles for.
-      # +force_clear+ - _Bool_ - Clear Scenario before creating SimulationFiles.
+      # * +scenario+ - _ScenarioBase_ - Scenario to create and run SimulationFiles for.
+      # * +force_clear+ - _Bool_ - Clear Scenario before creating SimulationFiles.
+      ##
       # [return:] _Array_ Returns array of all SimulationFiles, even those created previously, for Scenario.
       def run(scenario, force_clear = false, options = {})
         # instantiate openstudio runner - use the defaults for now. If need to change then create

data/lib/urbanopt/scenario/scenario_visualization.rb

@@ -31,21 +31,22 @@
 require 'csv'
 require 'date'
 require 'json'
-require 'fileutils'
 
 module URBANopt
   module Scenario
     class ResultVisualization
-      def self.create_visualization(run_dir, feature = true)
+      def self.create_visualization(run_dir, feature = true, feature_names = false)
         @all_results = []
+        
         run_dir.each do |folder|
-          name = folder.split('/')[-1]
-
           # create visualization for scenarios
           if feature == false
+            name = folder.split('/')[-1]
             csv_dir = File.join(folder, 'default_scenario_report.csv')
           # create visualization for features
           elsif feature == true
+            index = run_dir.index(folder)
+            name = folder.split('/')[-1] + '-' + feature_names[index]
             csv_dir = File.join(folder, 'feature_reports/default_feature_report.csv')
           end
 
@@ -181,14 +182,13 @@ module URBANopt
                     monthly_sum_dec += v.to_f
                     i += 1
                   end
-                  # sum up all values for annual aggregate
-                  if k <= size
-                    annual_sum += v.to_f
-                    k += 1
-                  end
+
                 end
               end
 
+              # sum up monthly values for annual aggregate
+              annual_sum = monthly_sum_jan + monthly_sum_feb + monthly_sum_mar + monthly_sum_apr + monthly_sum_may + monthly_sum_jun + monthly_sum_jul + monthly_sum_aug + monthly_sum_sep + monthly_sum_oct + monthly_sum_nov + monthly_sum_dec
+
               # store headers as key and monthly sums as values for each header
               monthly_totals[headers_unitless[j]] = [monthly_sum_jan, monthly_sum_feb, monthly_sum_mar, monthly_sum_apr, monthly_sum_may, monthly_sum_jun, monthly_sum_jul, monthly_sum_aug, monthly_sum_sep, monthly_sum_oct, monthly_sum_nov, monthly_sum_dec]
 

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -35,9 +35,9 @@ module URBANopt
       # SimulationDirBase is the agnostic representation of a directory of simulation input files.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario containing this SimulationDirBase.
-      # +features+ - _Array_ - Array of Features that this SimulationDirBase represents.
-      # +feature_names+ - _Array_ - Array of scenario specific names for these Features.
+      # * +scenario+ - _ScenarioBase_ - Scenario containing this SimulationDirBase.
+      # * +features+ - _Array_ - Array of Features that this SimulationDirBase represents.
+      # * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
       def initialize(scenario, features, feature_names)
         @scenario = scenario
         @features = features