openstudio-workflow 1.0.0.pat1 → 1.0.0

data/lib/openstudio/workflow/adapters/input/local.rb

@@ -0,0 +1,97 @@
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require 'openstudio/workflow_json'
+
+# Local file based workflow
+module OpenStudio
+  module Workflow
+    module InputAdapter
+      class Local
+        def initialize(osw_path = './workflow.osw')
+          @osw_abs_path = File.absolute_path(osw_path, Dir.pwd)
+
+          @workflow = if File.exist? @osw_abs_path
+                        ::JSON.parse(File.read(@osw_abs_path), symbolize_names: true)
+                      end
+        end
+
+        # Get the OSW file from the local filesystem
+        #
+        def workflow
+          raise "Could not read workflow from #{@osw_abs_path}" if @workflow.nil?
+          @workflow
+        end
+
+        # Get the OSW path
+        #
+        def osw_path
+          @osw_abs_path
+        end
+
+        # Get the OSW dir
+        #
+        def osw_dir
+          File.dirname(@osw_abs_path)
+        end
+
+        # Get the run dir
+        #
+        def run_dir
+          result = File.join(osw_dir, 'run')
+          if workflow
+            begin
+              workflow_json = nil
+              begin
+                # Create a temporary WorkflowJSON to compute run directory
+                workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(workflow))
+                workflow_json.setOswDir(osw_dir)
+              rescue Exception => e
+                workflow_json = WorkflowJSON_Shim.new(workflow, osw_dir)
+              end
+              result = workflow_json.absoluteRunDir.to_s
+            rescue
+            end
+          end
+          result
+        end
+
+        # Get the associated OSD (datapoint) file from the local filesystem
+        #
+        def datapoint
+          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
+          osd_abs_path = File.join(osw_dir, 'datapoint.osd')
+          if File.exist? osd_abs_path
+            ::JSON.parse(File.read(osd_abs_path), symbolize_names: true)
+          end
+        end
+
+        # Get the associated OSA (analysis) definition from the local filesystem
+        #
+        def analysis
+          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
+          osa_abs_path = File.join(osw_dir, 'analysis.osa')
+          if File.exist? osa_abs_path
+            ::JSON.parse(File.read(osa_abs_path), symbolize_names: true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/workflow/adapters/output/local.rb

@@ -0,0 +1,90 @@
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require 'openstudio/workflow/adapters/output_adapter'
+
+# Local file based workflow
+module OpenStudio
+  module Workflow
+    module OutputAdapter
+      class Local < OutputAdapters
+        def initialize(options = {})
+          raise 'The required :output_directory option was not passed to the local output adapter' unless options[:output_directory]
+          super
+        end
+
+        # Write to the filesystem that the process has started
+        #
+        def communicate_started
+          File.open("#{@options[:output_directory]}/started.job", 'w') { |f| f << "Started Workflow #{::Time.now}" }
+        end
+
+        # Write to the filesystem that the process has completed
+        #
+        def communicate_complete
+          File.open("#{@options[:output_directory]}/finished.job", 'w') { |f| f << "Finished Workflow #{::Time.now}" }
+        end
+
+        # Write to the filesystem that the process has failed
+        #
+        def communicate_failure
+          File.open("#{@options[:output_directory]}/failed.job", 'w') { |f| f << "Failed Workflow #{::Time.now}" }
+        end
+
+        # Do nothing on a state transition
+        #
+        def communicate_transition(_ = nil, _ = nil, _ = nil)
+        end
+
+        # Do nothing on EnergyPlus stdout
+        #
+        def communicate_energyplus_stdout(_ = nil, _ = nil)
+        end
+
+        # Write the measure attributes to the filesystem
+        #
+        def communicate_measure_attributes(measure_attributes, _ = nil)
+          File.open("#{@options[:output_directory]}/measure_attributes.json", 'w') do |f|
+            f << JSON.pretty_generate(measure_attributes)
+          end
+        end
+
+        # Write the objective function results to the filesystem
+        #
+        def communicate_objective_function(objectives, _ = nil)
+          obj_fun_file = "#{@options[:output_directory]}/objectives.json"
+          FileUtils.rm_f(obj_fun_file) if File.exist?(obj_fun_file)
+          File.open(obj_fun_file, 'w') { |f| f << JSON.pretty_generate(objectives) }
+        end
+
+        # Write the results of the workflow to the filesystem
+        #
+        def communicate_results(directory, results)
+          zip_results(directory)
+
+          if results.is_a? Hash
+            File.open("#{@options[:output_directory]}/data_point_out.json", 'w') { |f| f << JSON.pretty_generate(results) }
+          else
+            puts "Unknown datapoint result type. Please handle #{results.class}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/workflow/adapters/output/socket.rb

@@ -0,0 +1,70 @@
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require_relative 'local'
+require 'socket'
+
+# Local file based workflow
+module OpenStudio
+  module Workflow
+    module OutputAdapter
+      class Socket < Local
+        def initialize(options = {})
+          super
+          raise 'The required :port option was not passed to the socket output adapter' unless options[:port]
+
+          @socket = TCPSocket.open 'localhost', options[:port]
+        end
+
+        def communicate_started
+          super
+          @socket.write("Started\n")
+        end
+
+        def communicate_results(directory, results)
+          super
+        end
+
+        def communicate_complete
+          super
+          @socket.write("Complete\n")
+        end
+
+        def communicate_failure
+          super
+          @socket.write("Failure\n")
+        end
+
+        def communicate_objective_function(objectives, options = {})
+          super
+        end
+
+        def communicate_transition(message, type, options = {})
+          super
+          @socket.write(message + "\n")
+        end
+
+        def communicate_energyplus_stdout(line, options = {})
+          super
+          @socket.write(line)
+        end
+      end
+    end
+  end
+end

data/lib/openstudio/workflow/{jobs/run_preflight/run_preflight.rb → adapters/output/web.rb}

@@ -17,28 +17,46 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-# Run Prelight job to prepare the directory for simulations.
-class RunPreflight
-  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
-    defaults = {}
-    @options = defaults.merge(options)
-    @directory = directory
-    @adapter = adapter
-    @logger = logger
-    @time_logger = time_logger
-    @workflow_arguments = workflow_arguments
-    @past_results = past_results
-    @results = {}
-  end
+require_relative 'local'
+
+# Local file based workflow
+module OpenStudio
+  module Workflow
+    module OutputAdapter
+      class Web < Local
+        def initialize(options = {})
+          super
+          raise 'The required :url option was not passed to the web output adapter' unless options[:url]
+        end
+
+        def communicate_started
+          super
+        end
+
+        def communicate_results(directory, results)
+          super
+        end
+
+        def communicate_complete
+          super
+        end
 
-  def perform
-    @logger.info "Calling #{__method__} in the #{self.class} class"
+        def communicate_failure
+          super
+        end
 
-    @adapter.communicate_started @directory, @options
+        def communicate_objective_function(objectives, options = {})
+          super
+        end
 
-    # At the moment this does nothing.
+        def communicate_transition(message, type, options = {})
+          super
+        end
 
-    # return the results back to the caller -- always
-    @results
+        def communicate_energyplus_stdout(line, options = {})
+          super
+        end
+      end
+    end
   end
 end

data/lib/openstudio/workflow/{adapter.rb → adapters/output_adapter.rb}

@@ -17,51 +17,46 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-# Adapter class to decide where to obtain instructions to run the simulation workflow
 module OpenStudio
   module Workflow
-    class Adapter
+    # Base class for all output adapters. These methods define the expected return behavior of the adapter instance
+    class OutputAdapters
       attr_accessor :options
 
       def initialize(options = {})
         @options = options
-        @log = nil
-        @datapoint = nil
       end
 
-      # class << self
-      # attr_reader :problem
-
-      def load(filename, options = {})
-        instance.load(filename, options)
+      def communicate_started
+        instance.communicate_started
       end
 
-      def communicate_started(id, _options = {})
-        instance.communicate_started id
+      def communicate_transition(message, type, options = {})
+        instance.communicate_transition message, type, options
       end
 
-      def get_datapoint(id, options = {})
-        instance.get_datapoint id, options
+      def communicate_energyplus_stdout(line, options = {})
+        instance.communicate_energyplus_stdout line, options
       end
 
-      def get_problem(id, options = {})
-        instance.get_problem id, options
+      def communicate_measure_attributes(measure_attributes, options = {})
+        instance.communicate_measure_attributes measure_attributes, options
       end
 
-      def communicate_results(id, results)
-        instance.communicate_results id, results
+      def communicate_objective_function(objectives, options = {})
+        instance.communicate_objective_function objectives, options
       end
 
-      def communicate_complete(id)
-        instance.communicate_complete id
+      def communicate_results(directory, results)
+        instance.communicate_results directory, results
       end
 
-      def communicate_failure(id)
-        instance.communicate_failure id
+      def communicate_complete
+        instance.communicate_complete
       end
 
-      def get_logger(file, options = {})
-        instance.get_logger file, options
+      def communicate_failure
+        instance.communicate_failure
       end
 
       protected
@@ -70,11 +65,15 @@ module OpenStudio
       def zip_directory(directory, zip_filename, pattern = '*')
         # Submethod for adding the directory to the zip folder.
         def add_directory_to_zip(zip_file, local_directory, root_directory)
-          Dir[File.join("#{local_directory}", '**', '**')].each do |file|
+          Dir[File.join(local_directory.to_s, '**', '**')].each do |file|
             # remove the base directory from the zip file
             rel_dir = local_directory.sub("#{root_directory}/", '')
-            zip_file_to_add = file.gsub("#{local_directory}", "#{rel_dir}")
-            zip_file.add(zip_file_to_add, file)
+            zip_file_to_add = file.gsub(local_directory.to_s, rel_dir.to_s)
+            if File.directory?(file)
+              zip_file.addDirectory(file, zip_file_to_add)
+            else
+              zip_file.addFile(file, zip_file_to_add)
+            end
           end
 
           zip_file
@@ -82,36 +81,38 @@ module OpenStudio
 
         FileUtils.rm_f(zip_filename) if File.exist?(zip_filename)
 
-        Zip.default_compression = Zlib::BEST_COMPRESSION
-        Zip::File.open(zip_filename, Zip::File::CREATE) do |zf|
-          Dir[File.join(directory, pattern)].each do |file|
-            if File.directory?(file)
-              # skip a few directory that should not be zipped as they are inputs
-              if File.basename(file) =~ /seed|measures|weather/
-                next
-              end
-              # skip x-large directory
-              if File.size?(file)
-                next if File.size?(file) >= 15000000
-              end
-              add_directory_to_zip(zf, file, directory)
-            else
-              next if File.extname(file) =~ /\.rb.*/
-              next if File.extname(file) =~ /\.zip.*/
-              # skip large non-osm/idf files
-              if File.size(file)
-                if File.size(file) >= 15000000
-                  next unless File.extname(file) == '.osm' || File.extname(file) == '.idf'
-                end
-              end
+        zf = OpenStudio::ZipFile.new(zip_filename, false)
 
-              zip_file_to_add = file.gsub("#{directory}/", '')
-              zf.add(zip_file_to_add, file)
+        Dir[File.join(directory, pattern)].each do |file|
+          if File.directory?(file)
+            # skip a few directory that should not be zipped as they are inputs
+            if File.basename(file) =~ /seed|measures|weather/
+              next
             end
+            # skip x-large directory
+            if File.size?(file)
+              next if File.size?(file) >= 15000000
+            end
+            add_directory_to_zip(zf, file, directory)
+          else
+            next if File.extname(file) =~ /\.rb.*/
+            next if File.extname(file) =~ /\.zip.*/
+            # skip large non-osm/idf files
+            if File.size(file)
+              if File.size(file) >= 15000000
+                next unless File.extname(file) == '.osm' || File.extname(file) == '.idf'
+              end
+            end
+
+            zip_file_to_add = file.gsub("#{directory}/", '')
+            zf.addFile(file, zip_file_to_add)
           end
         end
 
-        File.chmod(0664, zip_filename)
+        zf = nil
+        GC.start
+        
+        File.chmod(0o664, zip_filename)
       end
 
       # Main method to zip up the results of the simulation results. This will append the UUID of the data point
@@ -120,6 +121,7 @@ module OpenStudio
       #
       # @param directory [String] The data point directory to zip up.
       # @return nil
+      #
       def zip_results(directory)
         # create zip file using a system call
         if Dir.exist?(directory) && File.directory?(directory)

data/lib/openstudio/workflow/job.rb

@@ -0,0 +1,22 @@
+module OpenStudio
+  module Workflow
+    class Job
+      def initialize(input_adapter, output_adapter, registry, options = {})
+        @options = options
+        @input_adapter = input_adapter
+        @output_adapter = output_adapter
+        @registry = registry
+        @logger = @registry[:logger]
+        @results = {}
+
+        @logger.debug "#{self.class} passed the following options #{@options}"
+        @logger.debug "#{self.class} passed the following registry #{@registry.to_hash}" if @options[:debug]
+      end
+    end
+
+    def self.new_class(current_job, input_adapter, output_adapter, registry, options = {})
+      new_job = Object.const_get(current_job).new(input_adapter, output_adapter, registry, options)
+      return new_job
+    end
+  end
+end

data/lib/openstudio/workflow/jobs/run_energyplus.rb

@@ -0,0 +1,49 @@
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+# This class runs the EnergyPlus simulation
+class RunEnergyPlus < OpenStudio::Workflow::Job
+  require 'openstudio/workflow/util/energyplus'
+  include OpenStudio::Workflow::Util::EnergyPlus
+
+  def initialize(input_adapter, output_adapter, registry, options = {})
+    super
+  end
+
+  def perform
+    @logger.debug "Calling #{__method__} in the #{self.class} class"
+
+    # Checks and configuration
+    raise 'No run_dir specified in the registry' unless @registry[:run_dir]
+    ep_path = @options[:energyplus_path] ? @options[:energyplus_path] : nil
+    @logger.warn "Using EnergyPlus path specified in options #{ep_path}" if ep_path
+
+    @logger.info 'Starting the EnergyPlus simulation'
+    @registry[:time_logger].start('Running EnergyPlus') if @registry[:time_logger]
+    call_energyplus(@registry[:run_dir], ep_path, @output_adapter, @logger, @registry[:workflow_json])
+    @registry[:time_logger].stop('Running EnergyPlus') if @registry[:time_logger]
+    @logger.info 'Completed the EnergyPlus simulation'
+
+    sql_path = File.join(@registry[:run_dir], 'eplusout.sql')
+    @registry.register(:sql) { sql_path } if File.exist? sql_path
+    @logger.warn "Unable to find sql file at #{sql_path}" unless @registry[:sql]
+
+    nil
+  end
+end

data/lib/openstudio/workflow/jobs/run_ep_measures.rb

@@ -0,0 +1,55 @@
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+# This class runs all EnergyPlus measures defined in the OSW
+class RunEnergyPlusMeasures < OpenStudio::Workflow::Job
+  require 'openstudio/workflow/util'
+  include OpenStudio::Workflow::Util::Measure
+  include OpenStudio::Workflow::Util::Model
+
+  def initialize(input_adapter, output_adapter, registry, options = {})
+    super
+  end
+
+  def perform
+    @logger.debug "Calling #{__method__} in the #{self.class} class"
+
+    # Ensure output_attributes is initialized in the registry
+    @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]
+
+    # Apply the EnergyPlus measures
+    @options[:output_adapter] = @output_adapter
+    @logger.info 'Beginning to execute EnergyPlus measures.'
+    apply_measures('EnergyPlusMeasure'.to_MeasureType, @registry, @options)
+    @logger.info('Finished applying EnergyPlus measures.')
+
+    # Send the measure output attributes to the output adapter
+    @logger.debug 'Communicating measure output attributes to the output adapter'
+    @output_adapter.communicate_measure_attributes @registry[:output_attributes]
+
+    # Save both the OSM and IDF if the :debug option is true
+    return nil unless @options[:debug]
+    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
+    idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
+    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
+    @logger.debug "Saved IDF as #{idf_name}"
+
+    nil
+  end
+end