openstudio-workflow 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ac6a1a269c8cf860bd9ed5e5e7b2e0f530a2e55
-  data.tar.gz: fec2ff61cf6032460af81428d03614871a987bcb
+  metadata.gz: 4d9ae4b703c92eef60ef68cb61114502b4b0e2c3
+  data.tar.gz: 1387f3ab160a42eb9403d8c62958622fe374baef
 SHA512:
-  metadata.gz: a51e1394e0447d54ec727a23eb29ff2f47b3449d2e5b12ca4139920feb0695d587edec4201b6813b919de4a20a818190c015525607e8c313d0f93d29bdc13a59
-  data.tar.gz: 160979c7c35fc78bfd390c8e8bf1a5d63ec856008356823b1691c568b70abe4bbd608f431932e6be53cd488207f58f7d61349206cf6ec9881f7a34ea38892eda
+  metadata.gz: f0a94a722672ef570e6819f89702605922fa3a585e2058ad976444571818fc1962ef14f42d0ff0949978a8965f1e305472ada3d2ec0566184794db5a20d699c6
+  data.tar.gz: 470ba2ed0e0a832256f5cc564a3bbf2fd4bbfe7449037de128230411360b9a09c58a3795188c4e24d5f19899cfe934fad58c32245ed6c87b31671d1b0de93204

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

@@ -30,13 +30,9 @@ class RunEnergyPlus < OpenStudio::Workflow::Job
     @logger.debug "Calling #{__method__} in the #{self.class} class"
     
     # skip if halted
-    begin
-      # method added in 2.1.2
-      halted = @registry[:runner].halted
-      @logger.info 'Workflow halted, skipping the EnergyPlus simulation'
-      return nil if halted
-    rescue NameError
-    end
+    halted = @registry[:runner].halted
+    @logger.info 'Workflow halted, skipping the EnergyPlus simulation' if halted
+    return nil if halted
 
     # Checks and configuration
     raise 'No run_dir specified in the registry' unless @registry[:run_dir]

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

@@ -45,6 +45,11 @@ class RunPreprocess < OpenStudio::Workflow::Job
     apply_measures('ReportingMeasure'.to_MeasureType, @registry, @options, energyplus_output_requests)
     @logger.info('Finished collect output requests from Reporting measures.')
 
+    # Skip the pre-processor if halted
+    halted = @registry[:runner].halted
+    @logger.info 'Workflow halted, skipping the EnergyPlus pre-processor' if halted
+    return nil if halted
+
     # Perform pre-processing on in.idf to capture logic in RunManager
     @registry[:time_logger].start('Running EnergyPlus Preprocess') if @registry[:time_logger]
     energyplus_preprocess(@registry[:model_idf], @logger)

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

@@ -46,37 +46,39 @@ class RunReportingMeasures < OpenStudio::Workflow::Job
     @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]
 
     # Load simulation files as required
-    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]}"
+    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
-      #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]}"
+      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
-      #raise "Unable to load #{epw_path}" unless @registry[:wf]
     end
-    
+
     # Apply reporting measures
     @options[:output_adapter] = @output_adapter
     @logger.info 'Beginning to execute Reporting measures.'

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

@@ -30,14 +30,12 @@ class RunTranslation < OpenStudio::Workflow::Job
     @logger.debug "Calling #{__method__} in the #{self.class} class"
     
     # skip if halted
-    begin
-      # method added in 2.1.2
-      halted = @registry[:runner].halted
-      @logger.info 'Workflow halted, skipping EnergyPlus translation'
-      return nil if halted
-    rescue NameError
+    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])
 

data/lib/openstudio/workflow/run.rb

@@ -223,6 +223,8 @@ module OpenStudio
             # completed status will already be set if workflow was halted
             if @registry[:workflow_json].completedStatus.empty?
               @registry[:workflow_json].setCompletedStatus('Success')
+            else
+              @current_state = :errored if @registry[:workflow_json].completedStatus.get == 'Fail'
             end
           end
 

data/lib/openstudio/workflow/util/measure.rb

@@ -58,19 +58,17 @@ module OpenStudio
               else
                 logger.info "Found measure #{class_name} of type #{measure_type.valueName}. Applying now."
                 
-                # fast forward current step index to this index, skips any previous steps
-                while workflow_json.currentStepIndex < step_index
-                  workflow_json.incrementStep
-                end
-                
                 # check if simulation has been halted
-                halted = false
-                begin
-                  # method added in 2.1.2
-                  halted = runner.halted
-                rescue NameError
+                halted = runner.halted
+                
+                # fast forward current step index to this index, skips any previous steps
+                # DLM: this is needed when running reporting measures only
+                if !halted
+                  while workflow_json.currentStepIndex < step_index
+                    workflow_json.incrementStep 
+                  end
                 end
-       
+
                 # DLM: why is output_adapter in options instead of registry?
                 options[:output_adapter].communicate_transition("Applying #{class_name}", :measure) if options[:output_adapter]
                 apply_measure(registry, step, options, energyplus_output_requests, halted)
@@ -416,19 +414,24 @@ module OpenStudio
 
             if skip_measure || halted
               if !energyplus_output_requests
-                # just increment
-                logger.debug "Skipping measure '#{measure_dir_name}'"
-                
-                # required to update current step
-                runner.prepareForUserScriptRun(measure_object)
-                
-                # don't want to log errors about arguments passed to skipped measures
-                #runner.validateUserArguments(arguments, argument_map)
+                if halted
+                  # if halted then this measure will not get run, there are no results, not even "Skip"
+                  logger.info "Skipping measure '#{measure_dir_name}' because simulation halted"
+                  
+                else
+                  logger.info "Skipping measure '#{measure_dir_name}'"
+                  
+                  # required to update current step, will do nothing if halted
+                  runner.prepareForUserScriptRun(measure_object)
+                  
+                  # don't want to log errors about arguments passed to skipped measures
+                  #runner.validateUserArguments(arguments, argument_map
                 
-                current_result = runner.result
-                runner.incrementStep
-                add_result_measure_info(current_result, measure)
-                current_result.setStepResult('Skip'.to_StepResult)
+                  current_result = runner.result
+                  runner.incrementStep
+                  add_result_measure_info(current_result, measure)
+                  current_result.setStepResult('Skip'.to_StepResult)
+                end
               end
             else
             
@@ -578,7 +581,7 @@ module OpenStudio
               
             end
             
-          rescue => e
+          rescue ScriptError, StandardError, NoMemoryError => e
             log_message = "#{__FILE__} failed with message #{e.message} in #{e.backtrace.join("\n")}"
             logger.error log_message
             raise log_message

data/lib/openstudio/workflow/version.rb

@@ -19,6 +19,6 @@
 
 module OpenStudio
   module Workflow
-    VERSION = '1.3.0'.freeze # Suffixes must have periods (not dashes)
+    VERSION = '1.3.1'.freeze # Suffixes must have periods (not dashes)
   end
 end

data/lib/openstudio/workflow_json.rb

@@ -236,6 +236,7 @@ class WorkflowJSON_Shim
   # bool incrementStep();
   def incrementStep
     @current_step_index += 1
+    @workflow[:current_step] = @current_step_index
 
     if @current_step_index < @workflow[:steps].size
       return true

data/lib/openstudio/workflow_runner.rb

@@ -28,7 +28,9 @@ class WorkflowRunner < OpenStudio::Ruleset::OSRunner
     @openstudio_2 = openstudio_2
     @datapoint = nil
     @analysis = nil
-
+    @halted = false
+    @use_os_halted = OpenStudio::Ruleset::OSRunner.method_defined?(:halted)
+    
     begin
       # OpenStudio 2.X
       super(@workflow_json)
@@ -95,6 +97,7 @@ class WorkflowRunner < OpenStudio::Ruleset::OSRunner
   # only called in OpenStudio 1.X
   # virtual void prepareForUserScriptRun(const UserScript& userScript);
   def prepareForUserScriptRun(userScript)
+    
     if @openstudio_2
       prepareForMeasureRun(userScript)
     else
@@ -230,4 +233,20 @@ class WorkflowRunner < OpenStudio::Ruleset::OSRunner
     super
     @multi_logger.info message
   end
+
+  # Overload haltSimulation
+  def haltWorkflow(completed_status)
+    if @use_os_halted
+      super
+    else
+      @halted = true
+      @workflow_json.setCompletedStatus(completed_status)
+    end
+  end
+
+  # Overload halted
+  def halted
+    return @halted unless @use_os_halted
+    super
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nicholas Long
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Run OpenStudio based measures and simulations using EnergyPlus
@@ -47,6 +47,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/openstudio-workflow.rb
 - lib/openstudio/workflow/adapters/input/local.rb
 - lib/openstudio/workflow/adapters/output/local.rb
 - lib/openstudio/workflow/adapters/output/socket.rb
@@ -66,20 +70,16 @@ files:
 - lib/openstudio/workflow/registry.rb
 - lib/openstudio/workflow/run.rb
 - lib/openstudio/workflow/time_logger.rb
+- lib/openstudio/workflow/util.rb
 - lib/openstudio/workflow/util/energyplus.rb
 - lib/openstudio/workflow/util/io.rb
 - lib/openstudio/workflow/util/measure.rb
 - lib/openstudio/workflow/util/model.rb
 - lib/openstudio/workflow/util/post_process.rb
 - lib/openstudio/workflow/util/weather_file.rb
-- lib/openstudio/workflow/util.rb
 - lib/openstudio/workflow/version.rb
 - lib/openstudio/workflow_json.rb
 - lib/openstudio/workflow_runner.rb
-- lib/openstudio-workflow.rb
-- README.md
-- CHANGELOG.md
-- Rakefile
 homepage: https://github.com/NREL/OpenStudio-workflow-gem
 licenses:
 - LGPL
@@ -90,17 +90,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: OpenStudio Workflow Manager