openstudio-workflow 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36393e28da7642fc75d1e780e913c86f43c46548
-  data.tar.gz: a9474bab185e5f286258129e73a58c5718a95ffd
+  metadata.gz: 0ac6a1a269c8cf860bd9ed5e5e7b2e0f530a2e55
+  data.tar.gz: fec2ff61cf6032460af81428d03614871a987bcb
 SHA512:
-  metadata.gz: a4079a380d92cfff3fa7fd60454babbb768517ec7ecb182d27b29af37508629bb668db2fce62aa3127121bc9d9e0ee02966c1eb36262ae9f95e340ce413b95d4
-  data.tar.gz: 36153a1892dd12bfb4d0dca47c32ca8a7f6a6bd0770a367d317c98ed9a8d82e3ec7edf1f15c429f69a319dca858d89db3f2a82cf9b9d8cc45f93b8a80dd5828c
+  metadata.gz: a51e1394e0447d54ec727a23eb29ff2f47b3449d2e5b12ca4139920feb0695d587edec4201b6813b919de4a20a818190c015525607e8c313d0f93d29bdc13a59
+  data.tar.gz: 160979c7c35fc78bfd390c8e8bf1a5d63ec856008356823b1691c568b70abe4bbd608f431932e6be53cd488207f58f7d61349206cf6ec9881f7a34ea38892eda

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

@@ -84,9 +84,11 @@ module OpenStudio
           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') { |f| f << JSON.pretty_generate(results) }
           else
-            puts "Unknown datapoint result type. Please handle #{results.class}"
+            #puts "Unknown datapoint result type. Please handle #{results.class}"
           end
         end
       end

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

@@ -28,6 +28,15 @@ class RunEnergyPlus < OpenStudio::Workflow::Job
 
   def perform
     @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
 
     # Checks and configuration
     raise 'No run_dir specified in the registry' unless @registry[:run_dir]

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

@@ -29,6 +29,8 @@ class RunEnergyPlusMeasures < OpenStudio::Workflow::Job
 
   def perform
     @logger.debug "Calling #{__method__} in the #{self.class} class"
+    
+    # halted workflow is handled in apply_measures
 
     # Ensure output_attributes is initialized in the registry
     @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]

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

@@ -36,6 +36,8 @@ class RunInitialization < OpenStudio::Workflow::Job
     # 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"
 
+    # do not skip initialization if halted
+    
     # Communicate that the workflow has been started
     @logger.debug 'Registering that the workflow has started with the adapter'
     @output_adapter.communicate_started

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

@@ -31,6 +31,8 @@ class RunOpenStudioMeasures < OpenStudio::Workflow::Job
   def perform
     @logger.debug "Calling #{__method__} in the #{self.class} class"
     
+    # halted workflow is handled in apply_measures
+    
     # set weather file
     if @registry[:wf] && @registry[:model]
       epwFile = OpenStudio::EpwFile.load(@registry[:wf])

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

@@ -34,6 +34,8 @@ class RunPostprocess < OpenStudio::Workflow::Job
   def perform
     @logger.debug "Calling #{__method__} in the #{self.class} class"
 
+    # do not skip post_process if halted
+    
     @logger.info 'Gathering reports'
     gather_reports(@registry[:run_dir], @registry[:root_dir], @registry[:workflow_json], @logger)
     @logger.info 'Finished gathering reports'

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

@@ -30,6 +30,8 @@ class RunPreprocess < OpenStudio::Workflow::Job
 
   def perform
     @logger.debug "Calling #{__method__} in the #{self.class} class"
+    
+    # halted workflow is handled in apply_measures
 
     # Ensure that the directory is created (but it should already be at this point)
     FileUtils.mkdir_p(@registry[:run_dir])

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

@@ -40,6 +40,8 @@ class RunReportingMeasures < OpenStudio::Workflow::Job
     @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]
 

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

@@ -29,6 +29,15 @@ class RunTranslation < OpenStudio::Workflow::Job
   def perform
     @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
+    end
+    
     # Ensure that the run directory is created
     FileUtils.mkdir_p(@registry[:run_dir])
 

data/lib/openstudio/workflow/run.rb

@@ -220,7 +220,10 @@ module OpenStudio
           if @current_state == :errored
             @registry[:workflow_json].setCompletedStatus('Fail') if @registry[:workflow_json]
           else
-            @registry[:workflow_json].setCompletedStatus('Success')
+            # completed status will already be set if workflow was halted
+            if @registry[:workflow_json].completedStatus.empty?
+              @registry[:workflow_json].setCompletedStatus('Success')
+            end
           end
 
           # save all files before calling output adapter

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

@@ -22,6 +22,7 @@ module OpenStudio
           registry[:time_logger].start "#{measure_type.valueName}:apply_measures" if registry[:time_logger]
 
           logger = registry[:logger]
+          runner = registry[:runner]
           workflow_json = registry[:workflow_json]
           
           workflow_steps = workflow_json.workflowSteps
@@ -62,9 +63,17 @@ module OpenStudio
                   workflow_json.incrementStep
                 end
                 
+                # check if simulation has been halted
+                halted = false
+                begin
+                  # method added in 2.1.2
+                  halted = runner.halted
+                rescue NameError
+                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)
+                apply_measure(registry, step, options, energyplus_output_requests, halted)
                 options[:output_adapter].communicate_transition("Applied #{class_name}", :measure) if options[:output_adapter]
               end
               
@@ -224,10 +233,11 @@ module OpenStudio
         #   step[:measure_dir_name], e.g. ['measures', '../../measures']
         # @option options [Object] :time_logger Special logger used to debug performance issues
         # @param  [Boolean] energyplus_output_requests If true then the energyPlusOutputRequests is called instead of the run method
+        # @param  [Boolean] halted True if the workflow has been halted and all measures should be skipped
         # @return [Hash, String] Returns two objects. The first is the (potentially) updated output_attributes hash, and
         #   the second is the (potentially) updated current_weather_filepath
         #
-        def apply_measure(registry, step, options = {}, energyplus_output_requests = false)
+        def apply_measure(registry, step, options = {}, energyplus_output_requests = false, halted = false)
 
           logger = registry[:logger]
           runner = registry[:runner]
@@ -404,7 +414,7 @@ module OpenStudio
               raise log_message
             end
 
-            if skip_measure
+            if skip_measure || halted
               if !energyplus_output_requests
                 # just increment
                 logger.debug "Skipping measure '#{measure_dir_name}'"
@@ -527,11 +537,8 @@ module OpenStudio
 
               # DLM: this section creates the measure_attributes.json file which should be deprecated
               begin
-                # DLM: which name do we want?
-                measure_name = class_name
-                #measure_name = measure_dir_name
-                
-                # DLM: do measure results from sequential measures with the same name clobber each other?
+                measure_name = step.name.is_initialized ? step.name.get : class_name
+
                 output_attributes[measure_name.to_sym] = {} if output_attributes[measure_name.to_sym].nil?
                 
                 result.stepValues.each do |step_value|

data/lib/openstudio/workflow/version.rb

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

data/lib/openstudio/workflow_json.rb

@@ -153,11 +153,19 @@ class WorkflowStep_Shim
 
   attr_reader :step
 
+  def name
+    if @step[:name]
+      Optional_Shim.new(@step[:name])
+    else
+      Optional_Shim.new(nil)
+    end
+  end
+
   def result
     if @step[:result]
       Optional_Shim.new(WorkflowStepResult_Shim.new(@step[:result]))
     else
-      Optional_Shim.new
+      Optional_Shim.new(nil)
     end
   end
 
@@ -410,6 +418,14 @@ class WorkflowJSON_Shim
     result
   end
 
+  def completedStatus
+    if @workflow[:completed_status]
+      Optional_Shim.new(@workflow[:completed_status])
+    else
+      Optional_Shim.new(nil)
+    end
+  end
+
   def setCompletedStatus(status)
     @workflow[:completed_status] = status
     @workflow[:completed_at] = timeString

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Nicholas Long
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-06-15 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,10 +47,6 @@ 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
@@ -70,16 +66,20 @@ 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.6.10
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: OpenStudio Workflow Manager