openstudio-workflow 1.3.3 → 1.3.4

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

@@ -1,102 +1,118 @@
-######################################################################
-#  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
-######################################################################
-
-# Run reporting measures and execute scripts to post-process objective functions and results on the filesystem
-class RunReportingMeasures < OpenStudio::Workflow::Job
-  require 'csv'
-  require 'ostruct'
-  require 'openstudio/workflow/util'
-  include OpenStudio::Workflow::Util::Model
-  include OpenStudio::Workflow::Util::Measure
-  include OpenStudio::Workflow::Util::PostProcess
-
-  def initialize(input_adapter, output_adapter, registry, options = {})
-    defaults = {
-      load_simulation_osm: false,
-      load_simulation_idf: false,
-      load_simulation_sql: false
-    }
-    options = defaults.merge(options)
-    super
-  end
-
-  def perform
-    @logger.debug "Calling #{__method__} in the #{self.class} class"
-    @logger.debug 'RunPostProcess Retrieving datapoint and problem'
-
-    # halted workflow is handled in apply_measures
-    
-    # Ensure output_attributes is initialized in the registry
-    @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]
-
-    # Load simulation files as required
-    unless @registry[:runner].halted
-      if @registry[:model].nil?
-        osm_path = File.absolute_path(File.join(@registry[:run_dir], 'in.osm'))
-        @logger.debug "Attempting to load #{osm_path}"
-        @registry.register(:model) { load_osm('.', osm_path) }
-        raise "Unable to load #{osm_path}" unless @registry[:model]
-        @logger.debug "Successfully loaded #{osm_path}"
-      end
-      if @registry[:model_idf].nil?
-        idf_path = File.absolute_path(File.join(@registry[:run_dir], 'in.idf'))
-        @logger.debug "Attempting to load #{idf_path}"
-        @registry.register(:model_idf) { load_idf(idf_path, @logger) }
-        raise "Unable to load #{idf_path}" unless @registry[:model_idf]
-        @logger.debug "Successfully loaded #{idf_path}"
-      end
-      if @registry[:sql].nil?
-        sql_path = File.absolute_path(File.join(@registry[:run_dir], 'eplusout.sql'))
-        if File.exists?(sql_path)
-          @registry.register(:sql) { sql_path }
-          @logger.debug "Registered the sql filepath as #{@registry[:sql]}"
-        end
-        #raise "Unable to load #{sql_path}" unless @registry[:sql]
-      end
-      if @registry[:wf].nil?
-        epw_path = File.absolute_path(File.join(@registry[:run_dir], 'in.epw'))
-        if File.exists?(epw_path)
-          @registry.register(:wf) { epw_path }
-          @logger.debug "Registered the wf filepath as #{@registry[:wf]}"
-        end
-        #raise "Unable to load #{epw_path}" unless @registry[:wf]
-      end
-    end
-
-    # Apply reporting measures
-    @options[:output_adapter] = @output_adapter
-    @logger.info 'Beginning to execute Reporting measures.'
-    apply_measures('ReportingMeasure'.to_MeasureType, @registry, @options)
-    @logger.info('Finished applying Reporting measures.')
-
-    # Send the updated measure_attributes to the output adapter
-    @logger.debug 'Communicating measures output attributes to the output adapter'
-    @output_adapter.communicate_measure_attributes @registry[:output_attributes]
-
-    # Parse the files generated by the local output adapter
-    results, objective_functions = run_extract_inputs_and_outputs @registry[:run_dir], @logger
-    @registry.register(:results) { results }
-
-    # Send the objective function results to the output adapter
-    @logger.debug "Objective Function JSON is #{objective_functions}"
-    @output_adapter.communicate_objective_function objective_functions
-
-    nil
-  end
-end
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# Run reporting measures and execute scripts to post-process objective functions and results on the filesystem
+class RunReportingMeasures < OpenStudio::Workflow::Job
+  require 'csv'
+  require 'ostruct'
+  require 'openstudio/workflow/util'
+  include OpenStudio::Workflow::Util::Model
+  include OpenStudio::Workflow::Util::Measure
+  include OpenStudio::Workflow::Util::PostProcess
+
+  def initialize(input_adapter, output_adapter, registry, options = {})
+    defaults = {
+      load_simulation_osm: false,
+      load_simulation_idf: false,
+      load_simulation_sql: false
+    }
+    options = defaults.merge(options)
+    super
+  end
+
+  def perform
+    @logger.debug "Calling #{__method__} in the #{self.class} class"
+    @logger.debug 'RunPostProcess Retrieving datapoint and problem'
+
+    # halted workflow is handled in apply_measures
+    
+    # Ensure output_attributes is initialized in the registry
+    @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]
+
+    # Load simulation files as required
+    unless @registry[:runner].halted
+      if @registry[:model].nil?
+        osm_path = File.absolute_path(File.join(@registry[:run_dir], 'in.osm'))
+        @logger.debug "Attempting to load #{osm_path}"
+        @registry.register(:model) { load_osm('.', osm_path) }
+        raise "Unable to load #{osm_path}" unless @registry[:model]
+        @logger.debug "Successfully loaded #{osm_path}"
+      end
+      if @registry[:model_idf].nil?
+        idf_path = File.absolute_path(File.join(@registry[:run_dir], 'in.idf'))
+        @logger.debug "Attempting to load #{idf_path}"
+        @registry.register(:model_idf) { load_idf(idf_path, @logger) }
+        raise "Unable to load #{idf_path}" unless @registry[:model_idf]
+        @logger.debug "Successfully loaded #{idf_path}"
+      end
+      if @registry[:sql].nil?
+        sql_path = File.absolute_path(File.join(@registry[:run_dir], 'eplusout.sql'))
+        if File.exists?(sql_path)
+          @registry.register(:sql) { sql_path }
+          @logger.debug "Registered the sql filepath as #{@registry[:sql]}"
+        end
+        #raise "Unable to load #{sql_path}" unless @registry[:sql]
+      end
+      if @registry[:wf].nil?
+        epw_path = File.absolute_path(File.join(@registry[:run_dir], 'in.epw'))
+        if File.exists?(epw_path)
+          @registry.register(:wf) { epw_path }
+          @logger.debug "Registered the wf filepath as #{@registry[:wf]}"
+        end
+        #raise "Unable to load #{epw_path}" unless @registry[:wf]
+      end
+    end
+
+    # Apply reporting measures
+    @options[:output_adapter] = @output_adapter
+    @logger.info 'Beginning to execute Reporting measures.'
+    apply_measures('ReportingMeasure'.to_MeasureType, @registry, @options)
+    @logger.info('Finished applying Reporting measures.')
+
+    # Send the updated measure_attributes to the output adapter
+    @logger.debug 'Communicating measures output attributes to the output adapter'
+    @output_adapter.communicate_measure_attributes @registry[:output_attributes]
+
+    # Parse the files generated by the local output adapter
+    results, objective_functions = run_extract_inputs_and_outputs @registry[:run_dir], @logger
+    @registry.register(:results) { results }
+
+    # Send the objective function results to the output adapter
+    @logger.debug "Objective Function JSON is #{objective_functions}"
+    @output_adapter.communicate_objective_function objective_functions
+
+    nil
+  end
+end

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

@@ -1,68 +1,84 @@
-######################################################################
-#  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
-######################################################################
-
-# Run the initialization job to validate the directory and initialize the adapters.
-class RunTranslation < OpenStudio::Workflow::Job
-  require 'openstudio/workflow/util/model'
-  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"
-    
-    # skip if halted
-    if @registry[:runner].halted
-      @logger.info 'Workflow halted, skipping OSM to IDF translation'
-      @registry.register(:model_idf) { OpenStudio::Workspace.new } # This allows model arguments to still be calculated
-      return nil
-    end
-
-    # Ensure that the run directory is created
-    FileUtils.mkdir_p(@registry[:run_dir])
-
-    # Copy in the weather file defined in the registry, or alternately in the options
-    if @registry[:wf]
-      @logger.info "Weather file for EnergyPlus simulation is #{@registry[:wf]}"
-      FileUtils.copy(@registry[:wf], "#{@registry[:run_dir]}/in.epw")
-      @registry.register(:wf) { "#{@registry[:run_dir]}/in.epw" }
-    else
-      @logger.warn "EPW file not found or not sent to #{self.class}"
-    end
-    
-    # Translate the OSM to an IDF
-    @logger.info 'Beginning the translation to IDF'
-    @registry[:time_logger].start('Translating to EnergyPlus') if @registry[:time_logger]
-    model_idf = translate_to_energyplus @registry[:model], @logger
-    @registry[:time_logger].stop('Translating to EnergyPlus') if @registry[:time_logger]
-    @registry.register(:model_idf) { model_idf }
-    @logger.info 'Successfully translated to IDF'
-
-    # Save the generated IDF file 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
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+# Run the initialization job to validate the directory and initialize the adapters.
+class RunTranslation < OpenStudio::Workflow::Job
+  require 'openstudio/workflow/util/model'
+  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"
+    
+    # skip if halted
+    if @registry[:runner].halted
+      @logger.info 'Workflow halted, skipping OSM to IDF translation'
+      @registry.register(:model_idf) { OpenStudio::Workspace.new } # This allows model arguments to still be calculated
+      return nil
+    end
+
+    # Ensure that the run directory is created
+    FileUtils.mkdir_p(@registry[:run_dir])
+
+    # Copy in the weather file defined in the registry, or alternately in the options
+    if @registry[:wf]
+      @logger.info "Weather file for EnergyPlus simulation is #{@registry[:wf]}"
+      FileUtils.copy(@registry[:wf], "#{@registry[:run_dir]}/in.epw")
+      @registry.register(:wf) { "#{@registry[:run_dir]}/in.epw" }
+    else
+      @logger.warn "EPW file not found or not sent to #{self.class}"
+    end
+    
+    # Translate the OSM to an IDF
+    @logger.info 'Beginning the translation to IDF'
+    @registry[:time_logger].start('Translating to EnergyPlus') if @registry[:time_logger]
+    model_idf = translate_to_energyplus @registry[:model], @logger
+    @registry[:time_logger].stop('Translating to EnergyPlus') if @registry[:time_logger]
+    @registry.register(:model_idf) { model_idf }
+    @logger.info 'Successfully translated to IDF'
+
+    # Save the generated IDF file 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

data/lib/openstudio/workflow/multi_delegator.rb

@@ -1,46 +1,62 @@
-######################################################################
-#  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 'logger'
-
-class Logger
-  def format_message(severity, datetime, _progname, msg)
-    "[%s %s] %s\n" % [datetime.strftime('%H:%M:%S.%6N'), severity, msg]
-  end
-end
-
-# Class to allow multiple logging paths
-class MultiDelegator
-  def initialize(*targets)
-    @targets = targets
-  end
-
-  def self.delegate(*methods)
-    methods.each do |m|
-      define_method(m) do |*args|
-        @targets.map { |t| t.send(m, *args) }
-      end
-    end
-    self
-  end
-
-  class <<self
-    alias to new
-  end
-end
+# *******************************************************************************
+# 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 'logger'
+
+class Logger
+  def format_message(severity, datetime, _progname, msg)
+    "[%s %s] %s\n" % [datetime.strftime('%H:%M:%S.%6N'), severity, msg]
+  end
+end
+
+# Class to allow multiple logging paths
+class MultiDelegator
+  def initialize(*targets)
+    @targets = targets
+  end
+
+  def self.delegate(*methods)
+    methods.each do |m|
+      define_method(m) do |*args|
+        @targets.map { |t| t.send(m, *args) }
+      end
+    end
+    self
+  end
+
+  class <<self
+    alias to new
+  end
+end