openstudio-workflow 1.2.0 → 1.2.1

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

@@ -1,49 +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
+######################################################################
+#  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

@@ -1,55 +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
+######################################################################
+#  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

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

@@ -1,167 +1,167 @@
-######################################################################
-#  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 run validations and initializations
-class RunInitialization < OpenStudio::Workflow::Job
-  require 'openstudio/workflow/util'
-  include OpenStudio::Workflow::Util::WeatherFile
-  include OpenStudio::Workflow::Util::Model
-  include OpenStudio::Workflow::Util::Measure
-
-  def initialize(input_adapter, output_adapter, registry, options = {})
-    defaults = {
-      verify_osw: true
-    }
-    options = defaults.merge(options)
-    super
-  end
-
-  def perform
-    # DLM: why are there multiple loggers running around?  there is one in the registry can we just use that?
-    @logger.info "Calling #{__method__} in the #{self.class} class"
-
-    # Communicate that the workflow has been started
-    @logger.debug 'Registering that the workflow has started with the adapter'
-    @output_adapter.communicate_started
-
-    # Load various files and set basic directories for the registry
-    # DLM: this key is the raw JSON object, it is deprecated and should not be used, use :workflow_json instead
-    @registry.register(:workflow) { @input_adapter.workflow }
-    raise 'Specified workflow was nil' unless @registry[:workflow]
-    @logger.debug 'Retrieved the workflow from the adapter'
-
-    @registry.register(:osw_dir) { @input_adapter.osw_dir }
-    @logger.debug "osw_dir is #{@registry[:osw_dir]}"
-
-    @registry.register(:datapoint) { @input_adapter.datapoint }
-    @logger.debug 'Found associated OSD file' if @registry[:datapoint]
-
-    @registry.register(:analysis) { @input_adapter.analysis }
-    @logger.debug 'Found associated OSA file' if @registry[:analysis]
-
-    # create the real WorkflowJSON here, we will be able to edit this during the run
-    if @registry[:openstudio_2]
-      workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(@registry[:workflow]))
-      workflow_json.setOswDir(@registry[:osw_dir])
-    else
-      workflow_json = WorkflowJSON_Shim.new(@registry[:workflow], @registry[:osw_dir])
-    end
-    @registry.register(:workflow_json) { workflow_json }
-
-    @registry.register(:root_dir) { workflow_json.absoluteRootDir }
-    @logger.debug "The root_dir for the datapoint is #{@registry[:root_dir]}"
-    
-    reports_dir = "#{@registry[:root_dir]}/reports"
-    if File.exist?(reports_dir)
-      @logger.debug "Removing existing reports directory: #{reports_dir}"
-      FileUtils.rm_rf(reports_dir)
-    end
-
-    # create the runner with our WorkflowJSON
-    @registry.register(:runner) { WorkflowRunner.new(@registry[:logger], @registry[:workflow_json], @registry[:openstudio_2]) }
-    @logger.debug 'Initialized runner'
-
-    # Validate the OSW measures if the flag is set to true, (the default state)
-    if @options[:verify_osw]
-      @logger.info 'Attempting to validate the measure workflow'
-      validate_measures(@registry, @logger)
-      @logger.info 'Validated the measure workflow'
-    end
-
-    # Load or create the seed OSM object
-    @logger.debug 'Finding and loading the seed file'
-    model_path = workflow_json.seedFile
-    if !model_path.empty?
-
-      model_full_path = workflow_json.findFile(model_path.get)
-      if model_full_path.empty?
-        raise "Seed model #{model_path.get} specified in OSW cannot be found"
-      end
-      model_full_path = model_full_path.get
-
-      if File.extname(model_full_path.to_s) == '.idf'
-        @registry.register(:model_idf) { load_idf(model_full_path, @logger) }
-        @registry.register(:model) { nil }
-      else
-        @registry.register(:model) { load_osm(model_full_path, @logger) }
-      end
-    else
-      @registry.register(:model) { OpenStudio::Model::Model.new }
-      
-      # add default objects to the model
-      begin
-        OpenStudio::Model::initializeModelObjects(@registry[:model])
-      rescue NameError
-        @registry[:model].getBuilding
-        @registry[:model].getFacility
-        @registry[:model].getSimulationControl
-        @registry[:model].getSizingParameters
-        @registry[:model].getTimestep
-        @registry[:model].getShadowCalculation
-        @registry[:model].getHeatBalanceAlgorithm
-        @registry[:model].getRunPeriod
-        @registry[:model].getLifeCycleCostParameters
-      end
-    end
-
-    if @registry[:openstudio_2]
-      if @registry[:model]
-        @registry[:model].setWorkflowJSON(workflow_json.clone)
-      end
-    end
-    
-    # DLM: TODO, load weather_file from options so it can be overriden by user_options
-    
-    # Find the weather file, should it exist and be findable
-    @logger.debug 'Getting the initial weather file'
-    weather_path = workflow_json.weatherFile
-    if weather_path.empty?
-      @logger.debug 'No weather file specified in OSW, looking in model'
-      if @registry[:model]
-        model = @registry[:model]
-        unless model.weatherFile.empty?
-          weather_path = model.weatherFile.get.path
-        end
-      end
-    end
-
-    unless weather_path.empty?
-      weather_path = weather_path.get
-      @logger.debug 'Searching for weather file #{weather_path}'
-
-      weather_full_path = workflow_json.findFile(weather_path)
-      if weather_full_path.empty?
-        weather_full_path = workflow_json.findFile(File.basename(weather_path.to_s))
-      end
-
-      if weather_full_path.empty?
-        raise "Weather file '#{weather_path}' specified but cannot be found"
-      end
-      weather_full_path = weather_full_path.get
-
-      @registry.register(:wf) { weather_full_path.to_s }
-
-    end
-    @logger.warn 'No valid weather file defined in either the osm or osw.' unless @registry[:wf]
-
-    workflow_json.start
-    
-    nil
-  end
-end
+######################################################################
+#  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 run validations and initializations
+class RunInitialization < OpenStudio::Workflow::Job
+  require 'openstudio/workflow/util'
+  include OpenStudio::Workflow::Util::WeatherFile
+  include OpenStudio::Workflow::Util::Model
+  include OpenStudio::Workflow::Util::Measure
+
+  def initialize(input_adapter, output_adapter, registry, options = {})
+    defaults = {
+      verify_osw: true
+    }
+    options = defaults.merge(options)
+    super
+  end
+
+  def perform
+    # DLM: why are there multiple loggers running around?  there is one in the registry can we just use that?
+    @logger.info "Calling #{__method__} in the #{self.class} class"
+
+    # Communicate that the workflow has been started
+    @logger.debug 'Registering that the workflow has started with the adapter'
+    @output_adapter.communicate_started
+
+    # Load various files and set basic directories for the registry
+    # DLM: this key is the raw JSON object, it is deprecated and should not be used, use :workflow_json instead
+    @registry.register(:workflow) { @input_adapter.workflow }
+    raise 'Specified workflow was nil' unless @registry[:workflow]
+    @logger.debug 'Retrieved the workflow from the adapter'
+
+    @registry.register(:osw_dir) { @input_adapter.osw_dir }
+    @logger.debug "osw_dir is #{@registry[:osw_dir]}"
+
+    @registry.register(:datapoint) { @input_adapter.datapoint }
+    @logger.debug 'Found associated OSD file' if @registry[:datapoint]
+
+    @registry.register(:analysis) { @input_adapter.analysis }
+    @logger.debug 'Found associated OSA file' if @registry[:analysis]
+
+    # create the real WorkflowJSON here, we will be able to edit this during the run
+    if @registry[:openstudio_2]
+      workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(@registry[:workflow]))
+      workflow_json.setOswDir(@registry[:osw_dir])
+    else
+      workflow_json = WorkflowJSON_Shim.new(@registry[:workflow], @registry[:osw_dir])
+    end
+    @registry.register(:workflow_json) { workflow_json }
+
+    @registry.register(:root_dir) { workflow_json.absoluteRootDir }
+    @logger.debug "The root_dir for the datapoint is #{@registry[:root_dir]}"
+    
+    reports_dir = "#{@registry[:root_dir]}/reports"
+    if File.exist?(reports_dir)
+      @logger.debug "Removing existing reports directory: #{reports_dir}"
+      FileUtils.rm_rf(reports_dir)
+    end
+
+    # create the runner with our WorkflowJSON
+    @registry.register(:runner) { WorkflowRunner.new(@registry[:logger], @registry[:workflow_json], @registry[:openstudio_2]) }
+    @logger.debug 'Initialized runner'
+
+    # Validate the OSW measures if the flag is set to true, (the default state)
+    if @options[:verify_osw]
+      @logger.info 'Attempting to validate the measure workflow'
+      validate_measures(@registry, @logger)
+      @logger.info 'Validated the measure workflow'
+    end
+
+    # Load or create the seed OSM object
+    @logger.debug 'Finding and loading the seed file'
+    model_path = workflow_json.seedFile
+    if !model_path.empty?
+
+      model_full_path = workflow_json.findFile(model_path.get)
+      if model_full_path.empty?
+        raise "Seed model #{model_path.get} specified in OSW cannot be found"
+      end
+      model_full_path = model_full_path.get
+
+      if File.extname(model_full_path.to_s) == '.idf'
+        @registry.register(:model_idf) { load_idf(model_full_path, @logger) }
+        @registry.register(:model) { nil }
+      else
+        @registry.register(:model) { load_osm(model_full_path, @logger) }
+      end
+    else
+      @registry.register(:model) { OpenStudio::Model::Model.new }
+      
+      # add default objects to the model
+      begin
+        OpenStudio::Model::initializeModelObjects(@registry[:model])
+      rescue NameError
+        @registry[:model].getBuilding
+        @registry[:model].getFacility
+        @registry[:model].getSimulationControl
+        @registry[:model].getSizingParameters
+        @registry[:model].getTimestep
+        @registry[:model].getShadowCalculation
+        @registry[:model].getHeatBalanceAlgorithm
+        @registry[:model].getRunPeriod
+        @registry[:model].getLifeCycleCostParameters
+      end
+    end
+
+    if @registry[:openstudio_2]
+      if @registry[:model]
+        @registry[:model].setWorkflowJSON(workflow_json.clone)
+      end
+    end
+    
+    # DLM: TODO, load weather_file from options so it can be overriden by user_options
+    
+    # Find the weather file, should it exist and be findable
+    @logger.debug 'Getting the initial weather file'
+    weather_path = workflow_json.weatherFile
+    if weather_path.empty?
+      @logger.debug 'No weather file specified in OSW, looking in model'
+      if @registry[:model]
+        model = @registry[:model]
+        unless model.weatherFile.empty?
+          weather_path = model.weatherFile.get.path
+        end
+      end
+    end
+
+    unless weather_path.empty?
+      weather_path = weather_path.get
+      @logger.debug 'Searching for weather file #{weather_path}'
+
+      weather_full_path = workflow_json.findFile(weather_path)
+      if weather_full_path.empty?
+        weather_full_path = workflow_json.findFile(File.basename(weather_path.to_s))
+      end
+
+      if weather_full_path.empty?
+        raise "Weather file '#{weather_path}' specified but cannot be found"
+      end
+      weather_full_path = weather_full_path.get
+
+      @registry.register(:wf) { weather_full_path.to_s }
+
+    end
+    @logger.warn 'No valid weather file defined in either the osm or osw.' unless @registry[:wf]
+
+    workflow_json.start
+    
+    nil
+  end
+end