urbanopt-scenario 0.1.0

data/lib/urbanopt/scenario/scenario_runner_base.rb

@@ -0,0 +1,63 @@
+# *********************************************************************************
+# 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 ScenarioRunnerBase
+      ##
+      # ScenarioRunnerBase is the agnostic interface for a class which can create and run SimulationFiles.
+      ##
+      def initialize; end
+
+      ##
+      # 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
+      # [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'
+      end
+
+      ##
+      # 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.
+      #
+      # [return:] _Array_ Returns an array of all SimulationDirs, even those created previously, for Scenario.
+      def run(scenario, force_clear = false)
+        raise 'run is not implemented for ScenarioRunnerBase, override in your class'
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -0,0 +1,158 @@
+# *********************************************************************************
+# 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_runner_base'
+require 'json'
+
+require 'fileutils'
+# require 'hash_parser'
+
+module URBANopt
+  module Scenario
+    class ScenarioRunnerOSW < ScenarioRunnerBase
+      ##
+      # ScenarioRunnerOSW is a class to create and run SimulationFileOSWs
+      ##
+      def initialize; end
+
+      ##
+      # 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.
+      # [return:] _Array_ Returns array of all SimulationDirs, even those created previously, for Scenario.
+      def create_simulation_files(scenario, force_clear = false)
+        if force_clear
+          scenario.clear
+        end
+
+        FileUtils.mkdir_p(scenario.run_dir) if !File.exist?(scenario.run_dir)
+
+        simulation_dirs = scenario.simulation_dirs
+
+        simulation_dirs.each do |simulation_dir|
+          if simulation_dir.out_of_date?
+            puts "simulation_dir #{simulation_dir.run_dir} is out of date, regenerating input files"
+            simulation_dir.create_input_files
+          end
+        end
+        return simulation_dirs
+      end
+
+      ##
+      # Create and run all SimulationFileOSW for Scenario.
+      # A staged runner is implented to run buildings, then transformers then district systems.
+      # - instantiate openstudio runner to run .osw files.
+      # - create simulation files for this scenario.
+      # - get feature_type value from in.osw files
+      # - cretae 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
+      # - add each osw file to its corresponding group id +simulation_dir+ is out_of_date
+      # - 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.
+      # [return:] _Array_ Returns array of all SimulationFiles, even those created previously, for Scenario.
+      def run(scenario, force_clear = false)
+        # 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)
+
+        # create simulation files
+        simulation_dirs = create_simulation_files(scenario, force_clear)
+
+        # osws = []
+        # simulation_dirs.each do |simulation_dir|
+        #   if !simulation_dir.is_a?(SimulationDirOSW)
+        #     raise "ScenarioRunnerOSW does not know how to run #{simulation_dir.class}"
+        #   end
+        #   if simulation_dir.out_of_date?
+        #     osws << simulation_dir.in_osw_path
+        #   end
+        # end
+
+        # cretae 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
+        building_osws = []
+        transformer_osws = []
+        district_system_osws = []
+
+        simulation_dirs.each do |simulation_dir|
+          in_osw = File.read(simulation_dir.in_osw_path)
+          in_osw_hash = JSON.parse(in_osw, symbolize_names: true)
+
+          if !simulation_dir.is_a?(SimulationDirOSW)
+            raise "ScenarioRunnerOSW does not know how to run #{simulation_dir.class}"
+          end
+
+          # get feature_type value from in.osw files
+          feature_type = nil
+          in_osw_hash[:steps].each { |x| feature_type = x[:arguments][:feature_type] if x[:arguments][:feature_type] }
+
+          # 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'
+              building_osws << simulation_dir.in_osw_path
+            elsif feature_type == 'District System'
+              district_system_osws << simulation_dir.in_osw_path
+            elsif feature_type == 'Transformer'
+              transformer_osws << simulation_dir.in_osw_path
+            else
+              raise "ScenarioRunnerOSW does not know how to run a #{feature_type} feature"
+            end
+
+          end
+        end
+
+        # Run osw groups in order and store simulation failure in a array.
+        # Return simulation_dirs after running all simulations.
+
+        # failures
+        failures = []
+        # run building_osws
+        # building_failures = runner.run_osws(building_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
+        building_failures = runner.run_osws(building_osws)
+        failures << building_failures
+        # run district_system_osws
+        # district_system_failures = runner.run_osws(district_system_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
+        district_system_failures = runner.run_osws(district_system_osws)
+        failures << district_system_failures
+        # run transformer_osws
+        # transformer_failures = runner.run_osws(transformer_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
+        transformer_failures = runner.run_osws(transformer_osws)
+        failures << transformer_failures
+
+        # puts "failures = #{failures}"
+        return simulation_dirs
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -0,0 +1,90 @@
+# *********************************************************************************
+# 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 SimulationDirBase
+      ##
+      # 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.
+      def initialize(scenario, features, feature_names)
+        @scenario = scenario
+        @features = features
+        @feature_names = feature_names
+      end
+
+      attr_reader :scenario #:nodoc:
+
+      attr_reader :features #:nodoc:
+
+      attr_reader :feature_names #:nodoc:
+
+      ##
+      # Return the directory that this simulation will run in
+      ##
+      def run_dir
+        raise 'run_dir is not implemented for SimulationFileBase, override in your class'
+      end
+
+      ##
+      # Return true if the simulation is out of date (input files newer than results), false otherwise.
+      # Non-existant simulation input files are out of date.
+      ##
+      def out_of_date?
+        raise 'out_of_date? is not implemented for SimulationFileBase, override in your class'
+      end
+
+      ##
+      #  Returns simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}
+      ##
+      def simulation_status
+        raise 'simulation_status is not implemented for SimulationFileBase, override in your class'
+      end
+
+      ##
+      # Clear the directory that this simulation runs in
+      ##
+      def clear
+        raise 'clear is not implemented for SimulationFileBase, override in your class'
+      end
+
+      ##
+      # Create run directory and generate simulation inputs, all previous contents of directory are removed
+      ##
+      def create_input_files
+        raise 'create_input_files is not implemented for SimulationFileBase, override in your class'
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -0,0 +1,261 @@
+# *********************************************************************************
+# 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/simulation_dir_base'
+
+module URBANopt
+  module Scenario
+    class SimulationDirOSW < SimulationDirBase
+      ##
+      # 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.
+      def initialize(scenario, features, feature_names, mapper_class)
+        super(scenario, features, feature_names)
+
+        if features.size != 1
+          raise 'SimulationDirOSW currently cannot simulate more than one feature'
+        end
+
+        @feature = features[0]
+        @feature_id = @feature.id
+
+        if feature_names.size == 1
+          @feature_name = feature_names[0]
+        else
+          @feature_name = @feature.name
+        end
+
+        @mapper_class = mapper_class
+      end
+
+      attr_reader :mapper_class
+
+      ##
+      # 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 + '/')
+      end
+
+      ##
+      # Return the input OSW path
+      ##
+      def in_osw_path
+        return File.join(run_dir, 'in.osw')
+      end
+
+      ##
+      # Return the input OSW
+      ##
+      def in_osw
+        result = nil
+        if File.exist?(in_osw_path)
+          File.open(in_osw_path, 'r') do |f|
+            result = JSON.parse(f.read, symbolize_names: true)
+          end
+        end
+        return result
+      end
+
+      ##
+      # Return the started.job path
+      ##
+      def started_job_path
+        return File.join(run_dir, 'started.job')
+      end
+
+      ##
+      # Return the failed.job path
+      ##
+      def failed_job_path
+        return File.join(run_dir, 'failed.job')
+      end
+
+      ##
+      # Return the finished.job path
+      ##
+      def finished_job_path
+        return File.join(run_dir, 'finished.job')
+      end
+
+      ##
+      # Return the output OSW path
+      ##
+      def out_osw_path
+        return File.join(run_dir, 'out.osw')
+      end
+
+      ##
+      # Return the output OSW
+      ##
+      def out_osw
+        result = nil
+        if File.exist?(out_osw_path)
+          File.open(out_osw_path, 'r') do |f|
+            result = JSON.parse(f.read, symbolize_names: true)
+          end
+        end
+        return result
+      end
+
+      # rubocop: disable Metrics/AbcSize #:nodoc:
+
+      ##
+      # Return true if the simulation is out of date (input files newer than results), false otherwise.
+      # Non-existant simulation input files are out of date.
+      ##
+      def out_of_date?
+        if !File.exist?(run_dir)
+          puts "run_dir '#{run_dir}' does not exist, simulation dir '#{run_dir}' out of date"
+          return true
+        end
+
+        if !File.exist?(finished_job_path)
+          puts "finished_job_path '#{finished_job_path}' does not exist, simulation dir '#{run_dir}' out of date"
+          return true
+        end
+
+        if !File.exist?(out_osw_path)
+          puts "out_osw_path '#{out_osw_path}' does not exist, simulation dir '#{run_dir}' out of date"
+          return true
+        end
+        out_osw_time = File.mtime(out_osw_path)
+
+        # array of files that this simulation dir depends on
+        dependencies = []
+        out_of_date_files = []
+
+        # depends on the in.osw
+        dependencies << in_osw_path
+
+        # 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, read in the in.osw and depend on all the measures
+
+        # check if out of date
+        dependencies.each do |f|
+          if File.exist?(f)
+            if File.mtime(f) > out_osw_time
+              out_of_date_files << f
+            end
+          else
+            puts "Dependency file '#{f}' does not exist"
+          end
+        end
+
+        if !out_of_date_files.empty?
+          puts "Files [#{out_of_date_files.join(',')}] are newer than '#{out_osw_path}', simulation dir '#{run_dir}' out of date"
+          return true
+        end
+
+        return false
+      end
+      # rubocop: enable Metrics/AbcSize #:nodoc:
+
+      # rubocop: disable Style/GuardClause #:nodoc:
+
+      ##
+      # Return simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}
+      ##
+      def simulation_status
+        if File.exist?(failed_job_path)
+          return 'Failed'
+        elsif File.exist?(started_job_path)
+          if File.exist?(finished_job_path)
+            return 'Complete'
+          else
+            return 'Failed'
+          end
+        end
+
+        return 'Not Started'
+      end
+      # rubocop: enable Style/GuardClause #:nodoc:
+
+      ##
+      # Clear the directory that this simulation runs in
+      ##
+      def clear
+        dir = run_dir
+        FileUtils.mkdir_p(dir) if !File.exist?(dir)
+        Dir.glob(File.join(dir, '/*')).each do |f|
+          FileUtils.rm_rf(f)
+        end
+      end
+
+      # rubocop: disable Security/Eval #:nodoc:
+      # rubocop: disable Style/EvalWithLocation #: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
+      ##
+      def create_input_files
+        clear
+
+        dir = run_dir
+        osw = eval("#{@mapper_class}.new.create_osw(scenario, features, feature_names)")
+        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:
+    end
+  end
+end