urbanopt-scenario 0.1.0

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -0,0 +1,122 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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_base'
+require 'urbanopt/scenario/simulation_dir_osw'
+
+require 'csv'
+require 'fileutils'
+
+module URBANopt
+  module Scenario
+    class ScenarioCSV < ScenarioBase
+      ##
+      # ScenarioCSV is a ScenarioBase which assigns a Simulation Mapper to each Feature in a FeatureFile using a simple CSV format.
+      # 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.
+
+      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
+
+        @@logger ||= URBANopt::Scenario.logger
+
+        load_mapper_files
+      end
+
+      # Path to CSV file
+      attr_reader :csv_file #:nodoc:
+
+      # Number of header rows to skip in CSV file
+      attr_reader :num_header_rows #:nodoc:
+
+      # Directory containing all mapper class files
+      attr_reader :mapper_files_dir #:nodoc:
+
+      # 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
+        end
+      end
+
+      # Gets all the simulation directories
+      def simulation_dirs
+        # DLM: TODO use HeaderConverters from CSV module
+
+        rows_skipped = 0
+        result = []
+        CSV.foreach(@csv_file) do |row|
+          if rows_skipped < @num_header_rows
+            rows_skipped += 1
+            next
+          end
+
+          break if row[0].nil?
+
+          # gets +feature_id+ , +feature_name+ and +mapper_class+ from csv_file
+          feature_id = row[0].chomp
+          feature_name = row[1].chomp
+          mapper_class = row[2].chomp
+
+          # gets +features+ from the feature_file.
+          features = []
+          feature = feature_file.get_feature_by_id(feature_id)
+          features << feature
+
+          feature_names = []
+          feature_names << feature_name
+
+          simulation_dir = SimulationDirOSW.new(self, features, feature_names, mapper_class)
+
+          result << simulation_dir
+        end
+
+        return result
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -0,0 +1,162 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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.
+# *********************************************************************************
+
+module URBANopt
+  module Scenario
+    class ScenarioDatapoint
+      attr_reader :scenario, :feature_id, :feature_name, :mapper_class #:nodoc:#
+
+      ##
+      # ScenarioDatapoint is an agnostic description of the simulation of a Feature in a Scenario
+      # 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.
+      def initialize(scenario, feature_id, feature_name, mapper_class)
+        @scenario = scenario
+        @feature_id = feature_id
+        @feature_name = feature_name
+        @feature = scenario.feature_file.get_feature_by_id(feature_id)
+        @mapper_class = mapper_class
+      end
+
+      attr_reader :feature #:nodoc:
+
+      ##
+      # Gets the type of a feature
+      ##
+      def feature_type
+        @feature.feature_type
+      end
+
+      ##
+      # Return the directory that this datapoint will run in.
+      ##
+      # [return:] _String_ - Directory that this datapoint 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 + '/')
+      end
+
+      ##
+      # Return the directory that this datapoint will run in.
+      def clear
+        dir = run_dir
+        FileUtils.rm_rf(dir) if File.exist?(dir)
+        FileUtils.mkdir_p(dir) if !File.exist?(dir)
+      end
+
+      # rubocop: disable Security/Eval #:nodoc:
+      # rubocop: disable Style/EvalWithLocation #:nodoc:
+      # Disable Sceurity/Eval since there is no user input #:nodoc:
+
+      ##
+      # Create run directory and generate simulation OSW, all previous contents of directory are removed
+      # The simulation OSW is created by evaluating the mapper_class's create_osw method
+      ##
+      # [return:] _String_ - Path to the simulation OSW.
+      ##
+      def create_osw
+        osw = eval("#{@mapper_class}.new.create_osw(@scenario, @feature_id, @feature_name)")
+        dir = run_dir
+        FileUtils.rm_rf(dir) if File.exist?(dir)
+        FileUtils.mkdir_p(dir) if !File.exist?(dir)
+        osw_path = File.join(dir, 'in.osw')
+        File.open(osw_path, 'w') do |f|
+          f << JSON.pretty_generate(osw)
+          # make sure data is written to the disk one way or the other
+          begin
+            f.fsync
+          rescue StandardError
+            f.flush
+          end
+        end
+        return osw_path
+      end
+      # rubocop: enable Security/Eval #:nodoc:
+      # rubocop: enable Style/EvalWithLocation #:nodoc:
+
+      ##
+      # Return true if the datapoint is out of date, false otherwise.  Non-existant files are out of date.
+      ##
+      # [return:] _Boolean_ - True if the datapoint is out of date, false otherwise.
+      def out_of_date?
+        dir = run_dir
+        if !File.exist?(dir)
+          return true
+        end
+
+        out_osw = File.join(dir, 'out.osw')
+        if !File.exist?(out_osw)
+          return true
+        end
+        out_osw_time = File.mtime(out_osw)
+
+        # array of files that this datapoint depends on
+        dependencies = []
+
+        # depends on the feature file
+        dependencies << scenario.feature_file.path
+
+        # depends on the csv file
+        dependencies << scenario.csv_file
+
+        # depends on the mapper classes
+        Dir.glob(File.join(scenario.mapper_files_dir, '*')).each do |f|
+          dependencies << f
+        end
+
+        # depends on the root gemfile
+        dependencies << File.join(scenario.root_dir, 'Gemfile')
+        dependencies << File.join(scenario.root_dir, 'Gemfile.lock')
+
+        # todo, depends on all the measures?
+
+        # check if out of date
+        dependencies.each do |f|
+          if File.exist?(f)
+            if File.mtime(f) > out_osw_time
+              puts "File '#{f}' is newer than '#{out_osw}', datapoint out of date"
+              return true
+            end
+          else
+            puts "Dependency file '#{f}' does not exist"
+          end
+        end
+
+        return false
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_post_processor_base.rb

@@ -0,0 +1,69 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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.
+# *********************************************************************************
+
+module URBANopt
+  module Scenario
+    class ScenarioPostProcessorBase
+      ##
+      # ScenarioPostProcessorBase post-processes a Scenario to create scenario level results.
+      ##
+      # [parameters:]
+      # +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
+      def initialize(scenario_base)
+        @scenario_base = scenario_base
+      end
+
+      attr_reader :scenario_base
+
+      ##
+      # Run the post processor on this Scenario.
+      ##
+      def run
+        raise 'run not implemented for ScenarioPostProcessorBase, override in your class'
+      end
+
+      ##
+      # Add results from a simulation_dir to this result.
+      ##
+      # [parameters:]
+      # +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
+
+      ##
+      # Save scenario result.
+      ##
+      def save
+        raise 'save not implemented for ScenarioPostProcessorBase, override in your class'
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -0,0 +1,97 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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/scenario/default_reports'
+require 'urbanopt/scenario/default_reports/logger'
+
+require 'csv'
+require 'json'
+require 'fileutils'
+
+module URBANopt
+  module Scenario
+    class ScenarioDefaultPostProcessor < ScenarioPostProcessorBase
+      ##
+      # ScenarioPostProcessorBase post-processes a scenario to create scenario level results
+      ##
+      # [parameters:]
+      # +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
+      def initialize(scenario_base)
+        super(scenario_base)
+        @scenario_result = URBANopt::Scenario::DefaultReports::ScenarioReport.new
+        @scenario_result.id = scenario_base.name
+        @scenario_result.name = scenario_base.name
+        @scenario_result.directory_name = scenario_base.run_dir
+
+        @@logger ||= URBANopt::Scenario::DefaultReports.logger
+      end
+
+      ##
+      # Run the post processor on this Scenario.This will add all the simulation_dirs.
+      ##
+      def run
+        # this run method adds all the simulation_dirs, you can extend it to do more custom stuff
+        @scenario_base.simulation_dirs.each do |simulation_dir|
+          add_simulation_dir(simulation_dir)
+        end
+        return @scenario_result
+      end
+
+      ##
+      # Add results from a simulation_dir to this result.
+      ##
+      # [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.each do |feature_report|
+          if feature_report.to_hash[:simulation_status] == 'Complete'
+            @scenario_result.add_feature_report(feature_report)
+          else
+            @@logger.error("Feature #{feature_report.id} failed to run!")
+          end
+        end
+
+        return feature_reports
+      end
+
+      ##
+      # Save scenario result
+      ##
+      def save
+        @scenario_result.save
+
+        return @scenario_result
+      end
+    end
+  end
+end