openstudio-workflow 1.3.4 → 1.3.5

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

@@ -1,161 +1,158 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# 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, THE UNITED STATES
-# GOVERNMENT, OR ANY 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 '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') do |f| 
-            f << "Started Workflow #{::Time.now}" 
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue
-              f.flush
-            end
-          end
-        end
-
-        # Write to the filesystem that the process has completed
-        #
-        def communicate_complete
-          File.open("#{@options[:output_directory]}/finished.job", 'w') do |f| 
-            f << "Finished Workflow #{::Time.now}" 
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue
-              f.flush
-            end
-          end
-        end
-
-        # Write to the filesystem that the process has failed
-        #
-        def communicate_failure
-          File.open("#{@options[:output_directory]}/failed.job", 'w') do |f| 
-            f << "Failed Workflow #{::Time.now}" 
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue
-              f.flush
-            end
-          end
-        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
-        
-        # Do nothing on Measure result
-        #
-        def communicate_measure_result(_ = nil, _ = nil)
-        end
-
-        # Write the measure attributes to the filesystem
-        #
-        def communicate_measure_attributes(measure_attributes, _ = nil)
-          attributes_file = "#{@options[:output_directory]}/measure_attributes.json"
-          FileUtils.rm_f(attributes_file) if File.exist?(attributes_file)
-          File.open(attributes_file, 'w') do |f|
-            f << JSON.pretty_generate(measure_attributes)
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue
-              f.flush
-            end
-          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') do |f| 
-            f << JSON.pretty_generate(objectives) 
-            # make sure data is written to the disk one way or the other
-            begin
-              f.fsync
-            rescue
-              f.flush
-            end
-          end
-        end
-
-        # Write the results of the workflow to the filesystem
-        #
-        def communicate_results(directory, results)
-          zip_results(directory)
-
-          if results.is_a? Hash
-            # DLM: don't we want this in the results zip?
-            # DLM: deprecate in favor of out.osw
-            File.open("#{@options[:output_directory]}/data_point_out.json", 'w') do |f| 
-              f << JSON.pretty_generate(results) 
-              # make sure data is written to the disk one way or the other
-              begin
-                f.fsync
-              rescue
-                f.flush
-              end
-            end
-          else
-            #puts "Unknown datapoint result type. Please handle #{results.class}"
-          end
-        end
-      end
-    end
-  end
-end
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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, THE UNITED STATES
+# GOVERNMENT, OR ANY 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 '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') do |f|
+            f << "Started Workflow #{::Time.now}"
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+        end
+
+        # Write to the filesystem that the process has completed
+        #
+        def communicate_complete
+          File.open("#{@options[:output_directory]}/finished.job", 'w') do |f|
+            f << "Finished Workflow #{::Time.now}"
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+        end
+
+        # Write to the filesystem that the process has failed
+        #
+        def communicate_failure
+          File.open("#{@options[:output_directory]}/failed.job", 'w') do |f|
+            f << "Failed Workflow #{::Time.now}"
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+        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
+
+        # Do nothing on Measure result
+        #
+        def communicate_measure_result(_ = nil, _ = nil); end
+
+        # Write the measure attributes to the filesystem
+        #
+        def communicate_measure_attributes(measure_attributes, _ = nil)
+          attributes_file = "#{@options[:output_directory]}/measure_attributes.json"
+          FileUtils.rm_f(attributes_file) if File.exist?(attributes_file)
+          File.open(attributes_file, 'w') do |f|
+            f << JSON.pretty_generate(measure_attributes)
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          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') do |f|
+            f << JSON.pretty_generate(objectives)
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+        end
+
+        # Write the results of the workflow to the filesystem
+        #
+        def communicate_results(directory, results)
+          zip_results(directory)
+
+          if results.is_a? Hash
+            # DLM: don't we want this in the results zip?
+            # DLM: deprecate in favor of out.osw
+            File.open("#{@options[:output_directory]}/data_point_out.json", 'w') do |f|
+              f << JSON.pretty_generate(results)
+              # make sure data is written to the disk one way or the other
+              begin
+                f.fsync
+              rescue StandardError
+                f.flush
+              end
+            end
+          else
+            # puts "Unknown datapoint result type. Please handle #{results.class}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,107 +1,106 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# 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, THE UNITED STATES
-# GOVERNMENT, OR ANY 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_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
-        
-        def communicate_measure_result(result, options = {})
-          super
-          
-          step_result = result.stepResult
-          initial_condition = result.stepInitialCondition
-          final_condition = result.stepFinalCondition
-          errors = result.stepErrors
-          warnings = result.stepWarnings
-          infos = result.stepInfo
-
-          # Mirrors WorkflowStepResult::string
-          tab = '  '
-          @socket.write("#{tab}Result: #{step_result.get.valueName}\n") if !step_result.empty?
-          @socket.write("#{tab}Initial Condition: #{initial_condition.get}\n") if !initial_condition.empty?
-          @socket.write("#{tab}Final Condition: #{final_condition.get}\n") if !final_condition.empty?
-          errors.each {|error| @socket.write("#{tab}Error: #{error}\n") }
-          warnings.each {|warning| @socket.write("#{tab}Warn: #{warning}\n") }
-          infos.each {|info| @socket.write("#{tab}Info: #{info}\n") }
-        end
-        
-      end
-    end
-  end
-end
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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, THE UNITED STATES
+# GOVERNMENT, OR ANY 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_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
+
+        def communicate_measure_result(result, options = {})
+          super
+
+          step_result = result.stepResult
+          initial_condition = result.stepInitialCondition
+          final_condition = result.stepFinalCondition
+          errors = result.stepErrors
+          warnings = result.stepWarnings
+          infos = result.stepInfo
+
+          # Mirrors WorkflowStepResult::string
+          tab = '  '
+          @socket.write("#{tab}Result: #{step_result.get.valueName}\n") if !step_result.empty?
+          @socket.write("#{tab}Initial Condition: #{initial_condition.get}\n") if !initial_condition.empty?
+          @socket.write("#{tab}Final Condition: #{final_condition.get}\n") if !final_condition.empty?
+          errors.each { |error| @socket.write("#{tab}Error: #{error}\n") }
+          warnings.each { |warning| @socket.write("#{tab}Warn: #{warning}\n") }
+          infos.each { |info| @socket.write("#{tab}Info: #{info}\n") }
+        end
+      end
+    end
+  end
+end