urbanopt-scenario 0.2.0.pre1 → 0.4.0

data/docs/package.json

@@ -10,17 +10,21 @@
   },
   "author": "NREL",
   "dependencies": {
-    "highlight.js": "^9.15.6",
-    "json-schema-ref-parser": "^6.1.0",
+    "highlight.js": "^10.2.0",
+    "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^1.2.0",
-    "webpack-dev-middleware": "^3.6.0"
+    "vuepress": "^1.5.4",
+    "webpack-dev-middleware": "^3.7.2"
   },
   "devDependencies": {
-    "braces": ">=2.3.1",
-    "gh-pages": "^2.0.1",
-    "js-yaml": ">=3.13.1",
-    "serialize-javascript": ">=2.1.1",
-    "set-value": ">=2.0.1"
+    "braces": "^3.0.2",
+    "dot-prop": "^5.3.0",
+    "gh-pages": "^3.1.0",
+    "js-yaml": "^3.14.0",
+    "minimist": ">=1.2.3",
+    "node-forge": ">=0.10.0",
+    "serialize-javascript": "^5.0.1",
+    "set-value": "^3.0.2",
+    "yargs-parser": ">=18.1.1"
   }
 }

data/lib/urbanopt-scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -36,10 +36,12 @@ require 'urbanopt/scenario/scenario_base'
 require 'urbanopt/scenario/scenario_csv'
 require 'urbanopt/scenario/scenario_post_processor_base'
 require 'urbanopt/scenario/scenario_post_processor_default'
+require 'urbanopt/scenario/scenario_post_processor_opendss'
 require 'urbanopt/scenario/scenario_runner_base'
 require 'urbanopt/scenario/scenario_runner_osw'
 require 'urbanopt/scenario/simulation_dir_base'
 require 'urbanopt/scenario/simulation_dir_osw'
 require 'urbanopt/scenario/simulation_mapper_base'
+require 'urbanopt/scenario/scenario_visualization'
 
 require 'urbanopt/scenario/default_reports'

data/lib/urbanopt/scenario/default_reports.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -31,10 +31,5 @@
 ##
 # Retrieve all default_reports classes.
 ##
-require 'urbanopt/scenario/default_reports/construction_cost'
-require 'urbanopt/scenario/default_reports/feature_report'
-require 'urbanopt/scenario/default_reports/logger'
-require 'urbanopt/scenario/default_reports/program'
-require 'urbanopt/scenario/default_reports/reporting_period'
-require 'urbanopt/scenario/default_reports/scenario_report'
-require 'urbanopt/scenario/default_reports/timeseries_csv'
+
+require 'urbanopt/reporting/default_reports'

data/lib/urbanopt/scenario/extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/logger.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/scenario_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -52,7 +52,6 @@ module URBANopt
 
       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
         @csv_file = csv_file
         @num_header_rows = num_header_rows
@@ -73,13 +72,27 @@ module URBANopt
 
       # Require all simulation mappers in mapper_files_dir
       def load_mapper_files
-        Dir.glob(File.join(@mapper_files_dir, '/*.rb')).each do |f|
-          begin
-            require(f)
-          rescue LoadError => e
-            @@logger.error(e.message)
-            raise
-          end
+        dirs = Dir.glob(File.join(@mapper_files_dir, '/*.rb'))
+        # order is not guaranteed...attempt to add Baseline first, then High Efficiency
+        ordered_dirs = []
+        bindex = dirs.find_index { |i| i.include? 'Baseline.rb' }
+        if bindex
+          ordered_dirs << dirs[bindex]
+          dirs.delete_at(bindex)
+        end
+        hindex = dirs.find_index { |i| i.include? 'HighEfficiency.rb' }
+        if hindex
+          ordered_dirs << dirs[hindex] if hindex
+          dirs.delete_at(hindex)
+        end
+        # then the rest
+        ordered_dirs += dirs
+
+        ordered_dirs.each do |f|
+          require(f)
+        rescue LoadError => e
+          @@logger.error(e.message)
+          raise
         end
       end
 

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -59,6 +59,13 @@ module URBANopt
         @feature.feature_type
       end
 
+      ##
+      # Gets the type of a feature
+      ##
+      def feature_location
+        @feature.feature_location
+      end
+
       ##
       # Return the directory that this datapoint will run in.
       ##

data/lib/urbanopt/scenario/scenario_post_processor_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -29,12 +29,12 @@
 # *********************************************************************************
 
 require 'urbanopt/scenario/scenario_post_processor_base'
-require 'urbanopt/scenario/default_reports'
-require 'urbanopt/scenario/default_reports/logger'
+require 'urbanopt/reporting/default_reports'
 
 require 'csv'
 require 'json'
 require 'fileutils'
+require 'sqlite3'
 
 module URBANopt
   module Scenario
@@ -47,10 +47,11 @@ module URBANopt
       def initialize(scenario_base)
         super(scenario_base)
 
-        initialization_hash = { directory_name: scenario_base.run_dir, name: scenario_base.name, id: scenario_base.name }
-        @scenario_result = URBANopt::Scenario::DefaultReports::ScenarioReport.new(initialization_hash)
+        @initialization_hash = { directory_name: scenario_base.run_dir, name: scenario_base.name, id: scenario_base.name }
+        @scenario_result = URBANopt::Reporting::DefaultReports::ScenarioReport.new(@initialization_hash)
+        @default_save_name = 'default_scenario_report'
 
-        @@logger ||= URBANopt::Scenario::DefaultReports.logger
+        @@logger ||= URBANopt::Reporting::DefaultReports.logger
       end
 
       ##
@@ -70,7 +71,7 @@ module URBANopt
       # [parameters:]
       # +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
       def add_simulation_dir(simulation_dir)
-        feature_reports = URBANopt::Scenario::DefaultReports::FeatureReport.from_simulation_dir(simulation_dir)
+        feature_reports = URBANopt::Reporting::DefaultReports::FeatureReport.from_simulation_dir(simulation_dir)
 
         feature_reports.each do |feature_report|
           if feature_report.to_hash[:simulation_status] == 'Complete'
@@ -83,12 +84,84 @@ module URBANopt
         return feature_reports
       end
 
+      # Create database file with scenario-level results
+      #   Sum values for each timestep across all features. Save to new table in a new database
+      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
+          )"
+
+        values_arr = []
+        feature_list = Pathname.new(@initialization_hash[:directory_name]).children.select(&:directory?) # Folders in the run/scenario directory
+        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
+          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.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 }
+            else
+              # running sum
+              arr_match[:elec_val] += Float(row[1])
+            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.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 }
+            else
+              # running sum
+              arr_match[:gas_val] += Float(row[1])
+            end
+          end # End gas_query
+          gas_query.close
+          feature_db.close
+        end # End feature_list loop
+
+        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]})"
+        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.close
+      end
+
       ##
       # Save scenario result
       ##
       # [parameters:]
       # +file_name+ - _String_ - Assign a name to the saved scenario results file
-      def save(file_name = 'default_scenario_report')
+      def save(file_name = @default_save_name)
         @scenario_result.save
 
         return @scenario_result

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -0,0 +1,275 @@
+# *********************************************************************************
+# URBANopt (tm), 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/scenario_post_processor_base'
+require 'urbanopt/reporting/default_reports'
+
+require 'csv'
+require 'json'
+require 'fileutils'
+require 'pathname'
+
+module URBANopt
+  module Scenario
+    class OpenDSSPostProcessor
+      ##
+      # 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
+      def initialize(scenario_report, opendss_results_dir_name = 'opendss')
+        if !scenario_report.nil?
+          @scenario_report = scenario_report
+          @opendss_results_dir = File.join(@scenario_report.directory_name, opendss_results_dir_name)
+        else
+          raise 'scenario_report is not valid'
+        end
+
+        # hash of column_name to array of values, does not get serialized to hash
+        @mutex = Mutex.new
+
+        # initialize opendss data
+        @opendss_data = {}
+
+        # initialize feature_reports data
+        @feature_reports_data = {}
+
+        # initialize logger
+        @@logger ||= URBANopt::Reporting::DefaultReports.logger
+      end
+
+      # load opendss data
+      def load_opendss_data
+        # load building features data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read results from opendss
+          opendss_csv = CSV.read(File.join(@opendss_results_dir, 'results', 'Features', feature_report.id + '.csv'))
+          # add results to data
+          @opendss_data[feature_report.id] = opendss_csv
+        end
+
+        ## load transformers data
+
+        # transformers results directory path
+        tf_results_path = File.join(@opendss_results_dir, 'results', 'Transformers')
+
+        # get transformer ids
+        transformer_ids = []
+        Dir.entries(tf_results_path.to_s).select do |f|
+          if !File.directory? f
+            fn = File.basename(f, '.csv')
+            transformer_ids << fn
+          end
+        end
+
+        # add transformer results to @opendss_data
+        transformer_ids.each do |id|
+          # read results from transformers
+          transformer_csv = CSV.read(File.join(tf_results_path, id + '.csv'))
+          # add results to data
+          @opendss_data[id] = transformer_csv
+        end
+      end
+
+      # load feature report data
+      def load_feature_report_data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read feature results
+          feature_csv = CSV.read(File.join(feature_report.timeseries_csv.path))
+          # add results to data
+          @feature_reports_data[feature_report.id] = feature_csv
+        end
+      end
+
+      # load feature report data and opendss data
+      def load_data
+        # load selected opendss data
+        load_opendss_data
+        # load selected feature reports data
+        load_feature_report_data
+      end
+
+      # merge data
+      def merge_data(feature_report_data, opendss_data)
+        output = CSV.generate do |csv|
+          opendss_data.each_with_index do |row, i|
+            if row.include? 'Datetime'
+              row.map { |header| header.prepend('opendss_') }
+            end
+            csv << (feature_report_data[i] + row[1..-1])
+          end
+        end
+
+        return output
+      end
+
+      # add feature reports for transformers
+      def save_transformers_reports
+        @opendss_data.keys.each do |k|
+          if k.include? 'Transformer'
+
+            # create transformer directory
+            transformer_dir = File.join(@scenario_report.directory_name, k)
+            FileUtils.mkdir_p(File.join(transformer_dir, 'feature_reports'))
+
+            # write data to csv
+            # store under voltages and over voltages
+            under_voltage_hrs = 0
+            over_voltage_hrs = 0
+
+            transformer_csv = CSV.generate do |csv|
+              @opendss_data[k].each_with_index do |row, i|
+                csv << row
+
+                if !row[1].include? 'loading'
+                  if row[1].to_f > 1.05
+                    over_voltage_hrs += 1
+                  end
+
+                  if row[1].to_f < 0.95
+                    under_voltage_hrs += 1
+                  end
+                end
+              end
+            end
+
+            # save transformer CSV report
+            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.csv'), transformer_csv)
+
+            # create transformer report
+            transformer_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(id: k, name: k, directory_name: transformer_dir, feature_type: 'Transformer',
+                                                                                        timesteps_per_hour: @scenario_report.timesteps_per_hour,
+                                                                                        simulation_status: 'complete')
+
+            # assign results to transfomrer report
+            transformer_report.power_distribution.over_voltage_hours = over_voltage_hrs
+            transformer_report.power_distribution.under_voltage_hours = under_voltage_hrs
+
+            ## save transformer JSON file
+            # transformer_hash
+            transformer_hash = transformer_report.to_hash
+            # transformer_hash.delete_if { |k, v| v.nil? }
+
+            json_name_path = File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.json')
+
+            # save the json file
+            File.open(json_name_path, 'w') do |f|
+              f.puts JSON.pretty_generate(transformer_hash)
+              # make sure data is written to the disk one way or the other
+              begin
+                f.fsync
+              rescue StandardError
+                f.flush
+              end
+            end
+
+            # add transformers reports to scenario_report
+            @scenario_report.feature_reports << transformer_report
+
+          end
+        end
+      end
+
+      ##
+      # 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
+      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
+
+      ##
+      # create opendss json report results
+      ##
+      # [parameters:]
+      # +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
+
+        id = feature_report.id
+        @opendss_data[id].each_with_index do |row, i|
+          if !row[1].include? 'voltage'
+
+            if row[1].to_f > 1.05
+              over_voltage_hrs += 1
+            end
+
+            if row[1].to_f < 0.95
+              under_voltage_hrs += 1
+            end
+
+          end
+        end
+
+        # assign results to feature report
+        feature_report.power_distribution.over_voltage_hours = over_voltage_hrs
+        feature_report.power_distribution.under_voltage_hours = under_voltage_hrs
+
+        return feature_report
+      end
+
+      ##
+      # run opendss post_processor
+      ##
+      def run
+        @scenario_report.feature_reports.each do |feature_report|
+          # load data
+          load_data
+
+          # puts " @opendss data = #{@opendss_data}"
+
+          # get summary results
+          add_summary_results(feature_report)
+
+          # merge csv data
+          id = feature_report.id
+          updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
+
+          # save fetaure reports
+          feature_report.save_feature_report('default_feature_report_opendss')
+
+          # resave updated csv report
+          save_csv(feature_report, updated_feature_csv, 'default_feature_report_opendss')
+        end
+
+        # add transformer reports
+        save_transformers_reports
+
+        # save the updated scenario reports
+        @scenario_report.save(file_name = 'scenario_report_opendss')
+      end
+    end
+  end
+end