urbanopt-scenario 0.4.4 → 0.6.2

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -32,8 +42,6 @@ require 'urbanopt/scenario/scenario_post_processor_base'
 require 'urbanopt/reporting/default_reports'
 
 require 'csv'
-require 'json'
-require 'fileutils'
 require 'sqlite3'
 
 module URBANopt
@@ -109,7 +117,7 @@ module URBANopt
         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')
+        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)
@@ -151,7 +159,7 @@ module URBANopt
               # running sum
               arr_match[:elec_val] += Float(row[7])
             end
-          end # End elec_query
+          end
           elec_query.close
 
           gas_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour,
@@ -174,10 +182,10 @@ module URBANopt
               # running sum
               arr_match[:gas_val] += Float(row[7])
             end
-          end # End gas_query
+          end
           gas_query.close
           feature_db.close
-        end # End feature_list loop
+        end
 
         elec_sql = []
         gas_sql = []

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -34,7 +44,6 @@ require 'urbanopt/reporting/default_reports'
 require 'csv'
 require 'json'
 require 'fileutils'
-require 'pathname'
 
 module URBANopt
   module Scenario
@@ -71,7 +80,7 @@ module URBANopt
         # 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'))
+          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
@@ -93,7 +102,7 @@ module URBANopt
         # 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'))
+          transformer_csv = CSV.read(File.join(tf_results_path, "#{id}.csv"))
           # add results to data
           @opendss_data[id] = transformer_csv
         end
@@ -124,7 +133,7 @@ module URBANopt
             if row.include? 'Datetime'
               row.map { |header| header.prepend('opendss_') }
             end
-            csv << (feature_report_data[i] + row[1..-1])
+            csv << (feature_report_data[i] + row[1..])
           end
         end
 
@@ -133,7 +142,7 @@ module URBANopt
 
       # add feature reports for transformers
       def save_transformers_reports
-        @opendss_data.keys.each do |k|
+        @opendss_data.each_key do |k|
           if k.include? 'Transformer'
 
             # create transformer directory
@@ -162,7 +171,7 @@ module URBANopt
             end
 
             # save transformer CSV report
-            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.csv'), transformer_csv)
+            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',
@@ -178,7 +187,7 @@ module URBANopt
             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')
+            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|
@@ -268,7 +277,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

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -123,11 +133,12 @@ module URBANopt
           # add each osw file to its corresponding group id +simulation_dir+ is out_of_date
           if simulation_dir.out_of_date?
 
-            if feature_type == 'Building'
+            case feature_type
+            when 'Building'
               building_osws << simulation_dir.in_osw_path
-            elsif feature_type == 'District System'
+            when 'District System'
               district_system_osws << simulation_dir.in_osw_path
-            elsif feature_type == 'Transformer'
+            when 'Transformer'
               transformer_osws << simulation_dir.in_osw_path
             else
               raise "ScenarioRunnerOSW does not know how to run a #{feature_type} feature"

data/lib/urbanopt/scenario/scenario_visualization.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -31,21 +41,23 @@
 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]
 
+        run_dir.each do |folder|
           # create visualization for scenarios
-          if feature == false
+          case feature
+          when false
+            name = folder.split('/')[-1]
             csv_dir = File.join(folder, 'default_scenario_report.csv')
           # create visualization for features
-          elsif feature == true
+          when 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,13 +193,12 @@ module URBANopt
                     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]
 
@@ -230,6 +241,6 @@ module URBANopt
           file << "var scenarioData = #{JSON.pretty_generate(@all_results)};"
         end
       end
-    end # ResultVisualization
-  end # Scenario
-end # URBANopt
+    end
+  end
+end

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -44,11 +54,7 @@ module URBANopt
         @feature_names = feature_names
       end
 
-      attr_reader :scenario #:nodoc:
-
-      attr_reader :features #:nodoc:
-
-      attr_reader :feature_names #:nodoc:
+      attr_reader :scenario, :features, :feature_names #:nodoc: #:nodoc: #:nodoc:
 
       ##
       # Return the directory that this simulation will run in

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -61,13 +71,15 @@ module URBANopt
       end
 
       attr_reader :mapper_class, :feature_id
+
       ##
       # Return the directory that this simulation will run in.
       ##
       def run_dir
         raise 'Feature ID not set' if @feature_id.nil?
         raise 'Scenario run dir not set' if scenario.run_dir.nil?
-        return File.join(scenario.run_dir, @feature_id + '/')
+
+        return File.join(scenario.run_dir, "#{@feature_id}/")
       end
 
       ##