urbanopt-scenario 0.3.0 → 0.4.4

data/lib/urbanopt/scenario/scenario_runner_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,
@@ -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,11 +52,11 @@ 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)
+      def run(scenario, force_clear = false, options = {})
         raise 'run is not implemented for ScenarioRunnerBase, override in your class'
       end
     end

data/lib/urbanopt/scenario/scenario_runner_osw.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,
@@ -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
@@ -55,6 +56,7 @@ module URBANopt
         end
 
         FileUtils.mkdir_p(scenario.run_dir) if !File.exist?(scenario.run_dir)
+        FileUtils.rm_rf(File.join(scenario.run_dir, 'run_status.json')) if File.exist?(File.join(scenario.run_dir, 'run_status.json'))
 
         simulation_dirs = scenario.simulation_dirs
 
@@ -78,13 +80,15 @@ 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)
+      def run(scenario, force_clear = false, options = {})
         # instantiate openstudio runner - use the defaults for now. If need to change then create
         # the runner.conf file (i.e. run `rake openstudio:runner:init`)
-        runner = OpenStudio::Extension::Runner.new(scenario.root_dir)
+        # allow passing gemfile_path and bundle_install_path in options
+        runner = OpenStudio::Extension::Runner.new(scenario.root_dir, [], options)
 
         # create simulation files
         simulation_dirs = create_simulation_files(scenario, force_clear)
@@ -156,18 +160,30 @@ module URBANopt
         #   puts "DATAPOINT FAILURES: #{failures}"
         # end
 
-        # look for other failed datapoints
+        # write results to file and to command line
+        get_results(scenario, simulation_dirs)
+
+        return simulation_dirs
+      end
+
+      def get_results(scenario, simulation_dirs)
+        # look for other failed datapoints (command line display)
+        # also compile datapoint status for latest_run.json file
+        status_arr = []
         failed_sims = []
-        simulation_dirs.each do |simulation_dir|
-          if File.exist?(File.join(simulation_dir.run_dir, 'failed.job'))
-            failed_sims << simulation_dir.run_dir.split('/')[-1]
+        simulation_dirs.each do |sim_dir|
+          if File.exist?(sim_dir.failed_job_path)
+            failed_sims << sim_dir.run_dir.split('/')[-1]
           end
+          status_arr << { "id": sim_dir.feature_id, "status": sim_dir.simulation_status, "mapper_class": sim_dir.mapper_class }
         end
+
+        # write to file
+        File.open(File.join(scenario.run_dir, 'run_status.json'), 'w') { |f| f.write JSON.pretty_generate("timestamp": Time.now.strftime('%Y-%m-%dT%k:%M:%S.%L'), "results": status_arr) }
+
         if !failed_sims.empty?
           puts "FAILED SIMULATION IDs: #{failed_sims.join(',')}"
         end
-
-        return simulation_dirs
       end
     end
   end

data/lib/urbanopt/scenario/scenario_visualization.rb

@@ -0,0 +1,235 @@
+# *********************************************************************************
+# 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 'csv'
+require 'date'
+require 'json'
+require 'fileutils'
+
+module URBANopt
+  module Scenario
+    class ResultVisualization
+      def self.create_visualization(run_dir, feature = true)
+        @all_results = []
+        run_dir.each do |folder|
+          name = folder.split('/')[-1]
+
+          # create visualization for scenarios
+          if feature == false
+            csv_dir = File.join(folder, 'default_scenario_report.csv')
+          # create visualization for features
+          elsif feature == true
+            csv_dir = File.join(folder, 'feature_reports/default_feature_report.csv')
+          end
+
+          if File.exist?(csv_dir)
+            size = CSV.open(csv_dir).readlines.size
+
+            monthly_values = {}
+            monthly_totals = {}
+            annual_values = {}
+
+            headers_unitless = []
+            i = 0
+            CSV.foreach(csv_dir).map do |row|
+              if i == 0
+                # store header values from csv
+                headers = row
+                headers.each do |header|
+                  header_unitless = header.to_s.split('(')[0]
+                  headers_unitless << header_unitless
+                  monthly_values[header_unitless] = []
+                end
+              # store values from csv for each row
+              elsif i <= size
+                headers_unitless.each_index do |j|
+                  monthly_values[headers_unitless[j]] << row[j]
+                end
+              end
+              i += 1
+            end
+
+            if monthly_values['Datetime'][0].split(/\W+/)[0].to_f > 31
+              format = '%Y/%m/%d %H:%M'
+              year = monthly_values['Datetime'][0].split(/\W+/)[0]
+            else
+              format = '%m/%d/%Y %H:%M'
+              year = monthly_values['Datetime'][0].split(/\W+/)[2]
+            end
+
+            # create dates for each month
+            jan_date = DateTime.new(year.to_i, 1, 1, 1, 0)
+            feb_date = DateTime.new(year.to_i, 2, 1, 0, 0)
+            mar_date = DateTime.new(year.to_i, 3, 1, 0, 0)
+            apr_date = DateTime.new(year.to_i, 4, 1, 0, 0)
+            may_date = DateTime.new(year.to_i, 5, 1, 0, 0)
+            jun_date = DateTime.new(year.to_i, 6, 1, 0, 0)
+            jul_date = DateTime.new(year.to_i, 7, 1, 0, 0)
+            aug_date = DateTime.new(year.to_i, 8, 1, 0, 0)
+            sep_date = DateTime.new(year.to_i, 9, 1, 0, 0)
+            oct_date = DateTime.new(year.to_i, 10, 1, 0, 0)
+            nov_date = DateTime.new(year.to_i, 11, 1, 0, 0)
+            dec_date = DateTime.new(year.to_i, 12, 1, 0, 0)
+            jan_next_year = DateTime.new(year.to_i + 1, 1, 1, 0, 0)
+
+            monthly_values['Datetime'].each do |i|
+              date_obj = DateTime.strptime(i.to_s, format)
+              index = monthly_values['Datetime'].index(i)
+
+              # store index of each date from the csv
+              if feb_date == date_obj
+                @feb_index = index
+              elsif mar_date == date_obj
+                @mar_index = index
+              elsif apr_date == date_obj
+                @apr_index = index
+              elsif may_date == date_obj
+                @may_index = index
+              elsif jun_date == date_obj
+                @jun_index = index
+              elsif jul_date == date_obj
+                @jul_index = index
+              elsif aug_date == date_obj
+                @aug_index = index
+              elsif sep_date == date_obj
+                @sep_index = index
+              elsif oct_date == date_obj
+                @oct_index = index
+              elsif nov_date == date_obj
+                @nov_index = index
+              elsif dec_date == date_obj
+                @dec_index = index
+              elsif jan_next_year == date_obj
+                @jan_next_year_index = index
+              end
+            end
+
+            headers_unitless.each_index do |j|
+              i = 0
+              k = 0
+
+              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 = annual_sum = 0
+
+              # loop through values for each header
+              all_values = monthly_values[headers_unitless[j]]
+
+              unless @jan_next_year_index.nil? || @feb_index.nil? || @mar_index.nil? || @apr_index.nil? || @may_index.nil? || @jun_index.nil? || @jul_index.nil? || @aug_index.nil? || @sep_index.nil? || @oct_index.nil? || @nov_index.nil? || @dec_index.nil?
+
+                # for each header store monthly sums of values
+                all_values.each do |v|
+                  if i < @feb_index
+                    monthly_sum_jan += v.to_f
+                    i += 1
+                  elsif @feb_index <= i && i < @mar_index
+                    monthly_sum_feb += v.to_f
+                    i += 1
+                  elsif @mar_index <= i && i < @apr_index
+                    monthly_sum_mar += v.to_f
+                    i += 1
+                  elsif @apr_index <= i && i < @may_index
+                    monthly_sum_apr += v.to_f
+                    i += 1
+                  elsif @may_index <= i && i < @jun_index
+                    monthly_sum_may += v.to_f
+                    i += 1
+                  elsif @jun_index <= i && i < @jul_index
+                    monthly_sum_jun += v.to_f
+                    i += 1
+                  elsif @jul_index <= i && i < @aug_index
+                    monthly_sum_jul += v.to_f
+                    i += 1
+                  elsif @aug_index <= i && i < @sep_index
+                    monthly_sum_aug += v.to_f
+                    i += 1
+                  elsif @sep_index <= i && i < @oct_index
+                    monthly_sum_sep += v.to_f
+                    i += 1
+                  elsif @oct_index <= i && i < @nov_index
+                    monthly_sum_oct += v.to_f
+                    i += 1
+                  elsif @nov_index <= i && i < @dec_index
+                    monthly_sum_nov += v.to_f
+                    i += 1
+                  elsif @dec_index <= i && i < @jan_next_year_index
+                    monthly_sum_dec += v.to_f
+                    i += 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]
+
+              annual_values[headers_unitless[j]] = annual_sum
+            end
+
+            @results = {}
+            @results['name'] = name
+            @results['monthly_values'] = {}
+            @results['annual_values'] = {}
+
+            if @jan_next_year_index.nil? || @feb_index.nil? || @mar_index.nil? || @apr_index.nil? || @may_index.nil? || @jun_index.nil? || @jul_index.nil? || @aug_index.nil? || @sep_index.nil? || @oct_index.nil? || @nov_index.nil? || @dec_index.nil?
+              @results['complete_simulation'] = false
+              puts "#{name} did not contain an annual simulation…visualizations will not render for it."
+            else
+              @results['complete_simulation'] = true
+            end
+
+            monthly_totals&.each do |key, value|
+              unless key == 'Datetime'
+                @results['monthly_values'][key] = value
+              end
+            end
+
+            annual_values&.each do |key, value|
+              unless key == 'Datetime'
+                @results['annual_values'][key] = value
+              end
+            end
+
+          end
+
+          unless @results.nil?
+            @all_results << @results
+          end
+        end
+        # create json with required data stored in a variable
+        results_path = File.join(run_dir[0], '../scenarioData.js')
+        File.open(results_path, 'w') do |file|
+          file << "var scenarioData = #{JSON.pretty_generate(@all_results)};"
+        end
+      end
+    end # ResultVisualization
+  end # Scenario
+end # URBANopt

data/lib/urbanopt/scenario/simulation_dir_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,
@@ -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

data/lib/urbanopt/scenario/simulation_dir_osw.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,
@@ -37,10 +37,10 @@ module URBANopt
       # SimulationDirOSW creates a OSW file to simulate features, a SimulationMapperBase is invoked to translate features to OSW.
       ##
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
-      # +features+ - _Array_ - Array of Features this SimulationFile represents.
-      # +feature_names+ - _Array_ - Array of scenario specific names for these Features.
-      # +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
+      # * +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
+      # * +features+ - _Array_ - Array of Features this SimulationFile represents.
+      # * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
+      # * +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
       def initialize(scenario, features, feature_names, mapper_class)
         super(scenario, features, feature_names)
 
@@ -60,8 +60,7 @@ module URBANopt
         @mapper_class = mapper_class
       end
 
-      attr_reader :mapper_class
-
+      attr_reader :mapper_class, :feature_id
       ##
       # Return the directory that this simulation will run in.
       ##
@@ -195,7 +194,6 @@ module URBANopt
 
         return false
       end
-      # rubocop: enable Metrics/AbcSize #:nodoc:
 
       ##
       # Return simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}
@@ -213,7 +211,6 @@ module URBANopt
 
         return 'Not Started'
       end
-      # rubocop: enable Style/GuardClause #:nodoc:
 
       ##
       # Clear the directory that this simulation runs in

data/lib/urbanopt/scenario/simulation_mapper_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,
@@ -36,9 +36,9 @@ module URBANopt
 
       # create osw file given a ScenarioBase object, features, and feature_names
       # [parameters:]
-      # +scenario+ - _ScenarioBase_ - An object of ScenarioBase class.
-      # +features+ - _Array_ - Array of Features.
-      # +feature_names+ - _Array_ - Array of scenario specific names for these Features.
+      # * +scenario+ - _ScenarioBase_ - An object of ScenarioBase class.
+      # * +features+ - _Array_ - Array of Features.
+      # * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
       def create_osw(scenario, features, feature_names)
         raise 'create_osw not implemented for SimulationMapperBase, override in your class'
       end

data/lib/urbanopt/scenario/version.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,
@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.4'.freeze
   end
 end