openstudio-workflow 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fa9aff18f17a837285bcc9bc72d8beff2b82028
-  data.tar.gz: 871e9aeffdd30c228cf804c758ea9a8918fa87ea
+  metadata.gz: 0530685f749da9f5112920053f26b8934ab4861e
+  data.tar.gz: 312ebc0a8b2844f94796214054605e414fc5606f
 SHA512:
-  metadata.gz: eee7ff6d5a939d168d981b1685d98e6264cabe87c0f8cf1a8693402ac8b635a0b6deab233a9675790c82e51a7bc5ce2335d21934d69a9555d279b3421b10d856
-  data.tar.gz: 37c6b1264805b11be32b885950d1aa5492dd4daf2c66c2e3a53402bc8749c071b218db914122b8063779fefa683eabd5e76329277238f6bc7ff55cd6b9b52c10
+  metadata.gz: eebca1c2eac830150a5c8cace44e77724d12090109bd34b224a228645930f85ca7f3bb068bbc254e0437719e9e8a5a23aaf5850aad18fdf45fe439cfe5b29f23
+  data.tar.gz: 6eb722576d2142d9de21aa193703783ee4115ffa203a4d5f99c38438524cfa974e9972dc7485289790fc83736bf1fc97be1aba0bf4c099ac9eb4bf41a036bab8

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 OpenStudio::Workflow Change Log
 ==================================
 
+Version 0.0.4 (Unreleased)
+-------------
+* Include rubyXL gem for reading/writing MS Excel files
+* Remove invalid characters from OpenStudio Measure Attributes. /[|!@#\$%^&\*\(\)\{\}\\\[\]|;:'",<.>\/?\+=]+/
+* Fix objective functions to read from any of the results hash, not just the standard report legacy
+* Add time logger and reporting measure
+
 Version 0.0.3
 --------------
 * Allow measures to set weather file in a measure and have it update what EnergyPlus uses for the weather file.

data/lib/openstudio-workflow.rb

@@ -18,6 +18,7 @@
 ######################################################################
 
 require 'pp'
+require 'rubyXL'
 require 'multi_json'
 require 'colored'
 require 'fileutils'
@@ -35,6 +36,7 @@ require 'openstudio/workflow/version'
 require 'openstudio/workflow/multi_delegator'
 require 'openstudio/workflow/run'
 require 'openstudio/workflow/jobs/lib/apply_measures'
+require 'openstudio/workflow/time_logger'
 
 begin
   require 'openstudio'
@@ -48,10 +50,10 @@ end
 class String
   def snake_case
     gsub(/::/, '/')
-    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-    .tr(' -', '__')
-    .downcase
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr(' -', '__')
+      .downcase
   end
 end
 
@@ -66,11 +68,11 @@ module OpenStudio
 
       # Convert various paths to absolute paths
       if options[:adapter_options] && options[:adapter_options][:mongoid_path] &&
-          (Pathname.new options[:adapter_options][:mongoid_path]).absolute? == false
+         (Pathname.new options[:adapter_options][:mongoid_path]).absolute? == false
         options[:adapter_options][:mongoid_path] = File.expand_path options[:adapter_options][:mongoid_path]
       end
       if options[:analysis_root_path] &&
-          (Pathname.new options[:analysis_root_path]).absolute? == false
+         (Pathname.new options[:analysis_root_path]).absolute? == false
         options[:analysis_root_path] = File.expand_path options[:analysis_root_path]
       end
       unless (Pathname.new run_directory).absolute?

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

@@ -96,7 +96,8 @@ module OpenStudio
 
       def apply_measure(workflow_item)
         @logger.info "Starting #{__method__} for #{workflow_item[:name]}"
-        start_time = ::Time.now
+        @time_logger.start("Measure:#{workflow_item[:name]}")
+        #start_time = ::Time.now
         current_dir = Dir.pwd
         begin
           measure_working_directory = "#{@run_directory}/#{workflow_item[:measure_definition_class_name]}"
@@ -204,7 +205,9 @@ module OpenStudio
           end
         ensure
           Dir.chdir current_dir
-          @logger.info "Finished #{__method__} for #{workflow_item[:name]} in #{::Time.now - start_time} s"
+          @time_logger.stop("Measure:#{workflow_item[:name]}")
+
+          @logger.info "Finished #{__method__} for #{workflow_item[:name]} in #{@time_logger.delta("Measure:#{workflow_item[:name]}")} s"
         end
       end
 

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

@@ -21,7 +21,7 @@ class RunEnergyplus
   # Initialize
   # param directory: base directory where the simulation files are prepared
   # param logger: logger object in which to write log messages
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     energyplus_path = nil
     if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
       energyplus_path = 'C:/EnergyPlus-8-1-0'
@@ -39,6 +39,7 @@ class RunEnergyplus
     @run_directory = "#{@directory}/run"
     @adapter = adapter
     @logger = logger
+    @time_logger = time_logger
     @results = {}
 
     @logger.info "#{self.class} passed the following options #{@options}"
@@ -62,9 +63,9 @@ class RunEnergyplus
 
     # verify that the OSM, IDF, and the Weather files are in the run directory as the 'in.*' format
     if !weather_file_name &&
-        @options[:run_openstudio] &&
-        @options[:run_openstudio][:weather_filename] &&
-        File.exist?(@options[:run_openstudio][:weather_filename])
+       @options[:run_openstudio] &&
+       @options[:run_openstudio][:weather_filename] &&
+       File.exist?(@options[:run_openstudio][:weather_filename])
       weather_file_name = @options[:run_openstudio][:weather_filename]
     end
 
@@ -98,6 +99,7 @@ class RunEnergyplus
 
     # can't create symlinks because the /vagrant mount is actually a windows mount
     @logger.info "Copying EnergyPlus files to run directory: #{@run_directory}"
+    @time_logger.start("Copying EnergyPlus files")
     FileUtils.copy("#{@options[:energyplus_path]}/libbcvtb.so", "#{@run_directory}/libbcvtb.so")
     FileUtils.copy("#{@options[:energyplus_path]}/libepexpat.so", "#{@run_directory}/libepexpat.so")
     FileUtils.copy("#{@options[:energyplus_path]}/libepfmiimport.so", "#{@run_directory}/libepfmiimport.so")
@@ -106,8 +108,11 @@ class RunEnergyplus
     FileUtils.copy("#{@options[:energyplus_path]}/ExpandObjects", "#{@run_directory}/ExpandObjects")
     FileUtils.copy("#{@options[:energyplus_path]}/EnergyPlus", "#{@run_directory}/EnergyPlus")
     FileUtils.copy("#{@options[:energyplus_path]}/Energy+.idd", "#{@run_directory}/Energy+.idd")
+    @time_logger.stop("Copying EnergyPlus files")
 
+    @time_logger.start("Running EnergyPlus")
     @results = call_energyplus
+    @time_logger.stop("Running EnergyPlus")
 
     @results
   end
@@ -156,21 +161,21 @@ class RunEnergyplus
       paths_to_rm.each { |p| FileUtils.rm_rf(p) }
 
       unless r == 0
-        fail "EnergyPlus returned a non-zero exit code. Check the stdout-energyplus log."
+        fail 'EnergyPlus returned a non-zero exit code. Check the stdout-energyplus log.'
       end
 
       # TODO: check the end or err file
-      if File.exists? 'eplusout.err'
+      if File.exist? 'eplusout.err'
         eplus_err = File.read('eplusout.err')
         eplus_err = eplus_err.force_encoding('ISO-8859-1').encode('utf-8', replace: nil)
         if eplus_err =~ /EnergyPlus Terminated--Fatal Error Detected/
-          fail "EnergyPlus Terminated with a Fatal Error. Check eplusout.err log."
+          fail 'EnergyPlus Terminated with a Fatal Error. Check eplusout.err log.'
         end
       end
     rescue => e
       log_message = "#{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
       @logger.error log_message
-      fail log_message
+      raise log_message
     ensure
       Dir.chdir(current_dir)
       @logger.info 'EnergyPlus Completed'

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

@@ -25,7 +25,7 @@ class RunOpenstudio
   # Initialize
   # param directory: base directory where the simulation files are prepared
   # param logger: logger object in which to write log messages
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     defaults = { format: 'hash', use_monthly_reports: false, analysis_root_path: '.' }
     @options = defaults.merge(options)
     @directory = directory
@@ -34,6 +34,7 @@ class RunOpenstudio
     @adapter = adapter
     @results = {}
     @logger = logger
+    @time_logger = time_logger
     @logger.info "#{self.class} passed the following options #{@options}"
 
     # initialize instance variables that are needed in the perform section
@@ -63,7 +64,9 @@ class RunOpenstudio
 
       apply_measures(:openstudio_measure)
 
+      @time_logger.start("Translating to EnergyPlus")
       translate_to_energyplus
+      @time_logger.stop("Translating to EnergyPlus")
 
       apply_measures(:energyplus_measure)
 
@@ -86,7 +89,9 @@ class RunOpenstudio
       end
     end
 
+    @time_logger.start("Saving OSM and IDF")
     save_osm_and_idf
+    @time_logger.stop("Saving OSM and IDF")
 
     @results
   end
@@ -95,13 +100,9 @@ class RunOpenstudio
 
   def save_osm_and_idf
     # save the data
-    a = Time.now
     osm_filename = "#{@run_directory}/in.osm"
     File.open(osm_filename, 'w') { |f| f << @model.to_s }
-    b = Time.now
-    @logger.info "OpenStudio write took #{b.to_f - a.to_f}"
 
-    # Run EnergyPlus using run energyplus script
     idf_filename = "#{@run_directory}/in.idf"
     File.open(idf_filename, 'w') { |f| f << @model_idf.to_s }
 

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

@@ -27,13 +27,14 @@ class RunPostprocess
   # Mixin the MeasureApplication module to apply measures
   include OpenStudio::Workflow::ApplyMeasures
 
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
     @run_directory = "#{@directory}/run"
     @adapter = adapter
     @logger = logger
+    @time_logger = time_logger
     @results = {}
     @output_attributes = {}
 

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

@@ -19,13 +19,14 @@
 
 # Run Prelight job to prepare the directory for simulations.
 class RunPreflight
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
     @adapter = adapter
-    @results = {}
     @logger = logger
+    @time_logger = time_logger
+    @results = {}
   end
 
   def perform
@@ -33,9 +34,9 @@ class RunPreflight
 
     @adapter.communicate_started @directory, @options
 
-    # Add the moment this does nothing.
+    # At the moment this does nothing.
 
-    # return the results back to the caller--always
+    # return the results back to the caller -- always
     @results
   end
 end

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

@@ -18,8 +18,6 @@
 ######################################################################
 
 # Run precanned post processing to extract object functions
-# TODO: I hear that measures can step on each other if not run in their own directory
-
 require 'csv'
 require 'ostruct'
 
@@ -27,13 +25,14 @@ class RunReportingMeasures
   # Mixin the MeasureApplication module to apply measures
   include OpenStudio::Workflow::ApplyMeasures
 
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
     @run_directory = "#{@directory}/run"
     @adapter = adapter
     @logger = logger
+    @time_logger = time_logger
     @results = {}
     @output_attributes = {}
 
@@ -61,11 +60,13 @@ class RunReportingMeasures
       @datapoint_json = @adapter.get_datapoint(@directory, @options)
       @analysis_json = @adapter.get_problem(@directory, @options)
 
+      @time_logger.start("Running standard post process")
       if @options[:use_monthly_reports]
         run_monthly_postprocess
       else
         run_standard_postprocess
       end
+      @time_logger.stop("Running standard post process")
 
       translate_csv_to_json
 
@@ -77,7 +78,8 @@ class RunReportingMeasures
 
       @logger.info 'Saving reporting measures output attributes JSON'
       File.open("#{@run_directory}/reporting_measure_attributes.json", 'w') do
-          |f| f << JSON.pretty_generate(@output_attributes)
+      |f|
+        f << JSON.pretty_generate(@output_attributes)
       end
 
       run_extract_inputs_and_outputs
@@ -99,30 +101,40 @@ class RunReportingMeasures
     # For xml, the measure attributes are in the measure_attributes_xml.json file
     # TODO: somehow pass the metadata around on which JSONs to suck into the database
     if File.exist? "#{@run_directory}/measure_attributes_xml.json"
-      temp_json = JSON.parse(File.read("#{@run_directory}/measure_attributes_xml.json"), symbolize_names: true)
-      @results.merge! temp_json
+      h = JSON.parse(File.read("#{@run_directory}/measure_attributes_xml.json"), symbolize_names: true)
+      h = rename_hash_keys(h)
+      @results.merge! h
     end
 
     # Inputs are in the measure_attributes.json file
     if File.exist? "#{@run_directory}/measure_attributes.json"
-      temp_json = JSON.parse(File.read("#{@run_directory}/measure_attributes.json"), symbolize_names: true)
-      @results.merge! temp_json
+      h = JSON.parse(File.read("#{@run_directory}/measure_attributes.json"), symbolize_names: true)
+      h = rename_hash_keys(h)
+      @results.merge! h
     end
 
     # Inputs are in the reporting_measure_attributes.jsonfile
     if File.exist? "#{@run_directory}/reporting_measure_attributes.json"
-      temp_json = JSON.parse(File.read("#{@run_directory}/reporting_measure_attributes.json"), symbolize_names: true)
-      @results.merge! temp_json
+      h = JSON.parse(File.read("#{@run_directory}/reporting_measure_attributes.json"), symbolize_names: true)
+      h = rename_hash_keys(h)
+      @results.merge! h
     end
 
-    # Initialize the objective function variable
+    # Initialize the objective function variable.
     @objective_functions = {}
     if File.exist? "#{@run_directory}/standard_report_legacy.json"
-      @results[:standard_report_legacy] = JSON.parse(File.read("#{@run_directory}/standard_report_legacy.json"), symbolize_names: true)
+      h = JSON.parse(File.read("#{@run_directory}/standard_report_legacy.json"), symbolize_names: true)
+      h = rename_hash_keys(h)
+      @results[:standard_report_legacy] = h
+    end
+
+    @logger.info 'Saving the result hash to file'
+    File.open("#{@run_directory}/results.json", 'w') { |f| f << JSON.pretty_generate(@results) }
 
-      @logger.info 'Iterating over Analysis JSON Output Variables'
-      # Save the objective functions to the object for sending back to the simulation executive
+    @logger.info 'Iterating over Analysis JSON Output Variables'
+    # Save the objective functions to the object for sending back to the simulation executive
 
+    if @analysis_json[:analysis] && @analysis_json[:analysis][:output_variables]
       @analysis_json[:analysis][:output_variables].each do |variable|
         # determine which ones are the objective functions (code smell: todo: use enumerator)
         if variable[:objective_function]
@@ -240,7 +252,31 @@ class RunReportingMeasures
     end
   end
 
-  # TODO: THis is uglier than the one below! sorry.
+  # Remove any invalid characters in the measure attribute keys.
+  # Periods and Pipes are the most problematic because mongo does not allow hash keys with periods, and the pipes
+  # are used in the map/reduce method that was written to speed up the data write in openstudio-server.
+  # Also remove any trailing underscores and spaces
+  def rename_hash_keys(hash)
+    # TODO: log the name changes?
+    regex = /[|!@#\$%^&\*\(\)\{\}\\\[\]|;:'",<.>\/?\+=]+/
+
+    rename_keys = lambda do |h|
+      if Hash === h
+        h.each_key do |key|
+          if key.to_s =~ regex
+            @logger.warn "Renaming result key '#{key}' to remove invalid characters"
+          end
+        end
+        Hash[h.map { |k, v| [k.to_s.gsub(regex, '_').squeeze('_').gsub(/[_\s]+$/, '').chomp.to_sym, rename_keys[v]] }]
+      else
+        h
+      end
+    end
+
+    rename_keys[hash]
+  end
+
+  # TODO: This needs to be cleaned up and tested. This is just ugly. Sorry.
   def run_monthly_postprocess
     def sql_query(sql, report_name, query)
       val = nil

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

@@ -27,7 +27,7 @@ class RunRunmanager
   # Initialize
   # param directory: base directory where the simulation files are prepared
   # param logger: logger object in which to write log messages
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     energyplus_path = nil
     if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
       energyplus_path = 'C:/EnergyPlus-8-1-0'
@@ -49,6 +49,7 @@ class RunRunmanager
     @results = {}
     @logger = logger
     @logger.info "#{self.class} passed the following options #{@options}"
+    @time_logger = time_logger
 
     # initialize instance variables that are needed in the perform section
     @model = nil

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

@@ -22,7 +22,7 @@ require 'libxml'
 # This actually belongs as another class that gets added as a state dynamically
 class RunXml
   # RunXml
-  def initialize(directory, logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, options = {})
     defaults = { use_monthly_reports: false, analysis_root_path: '.', xml_library_file: 'xml_runner.rb' }
     @options = defaults.merge(options)
     @directory = directory
@@ -31,6 +31,7 @@ class RunXml
     @adapter = adapter
     @results = {}
     @logger = logger
+    @time_logger = time_logger
     @logger.info "#{self.class} passed the following options #{@options}"
 
     # initialize instance variables that are needed in the perform section

data/lib/openstudio/workflow/run.rb

@@ -34,12 +34,12 @@ module OpenStudio
       # load the transitions
       def self.default_transition
         [
-            {from: :queued, to: :preflight},
-            {from: :preflight, to: :openstudio},
-            {from: :openstudio, to: :energyplus},
-            {from: :energyplus, to: :reporting_measures},
-            {from: :reporting_measures, to: :postprocess},
-            {from: :postprocess, to: :finished}
+          { from: :queued, to: :preflight },
+          { from: :preflight, to: :openstudio },
+          { from: :openstudio, to: :energyplus },
+          { from: :energyplus, to: :reporting_measures },
+          { from: :reporting_measures, to: :postprocess },
+          { from: :postprocess, to: :finished }
         ]
       end
 
@@ -48,24 +48,24 @@ module OpenStudio
       def self.default_states
         warn "[Deprecation Warning] explicitly specifying states will no longer be required in 0.3.0. Method #{__method__}"
         [
-            {state: :queued, options: {initial: true}},
-            {state: :preflight, options: {after_enter: :run_preflight}},
-            {state: :openstudio, options: {after_enter: :run_openstudio}}, # TODO: this should be run_openstudio_measures and run_energyplus_measures
-            {state: :energyplus, options: {after_enter: :run_energyplus}},
-            {state: :reporting_measures, options: {after_enter: :run_reporting_measures}},
-            {state: :postprocess, options: {after_enter: :run_postprocess}},
-            {state: :finished},
-            {state: :errored}
+          { state: :queued, options: { initial: true } },
+          { state: :preflight, options: { after_enter: :run_preflight } },
+          { state: :openstudio, options: { after_enter: :run_openstudio } }, # TODO: this should be run_openstudio_measures and run_energyplus_measures
+          { state: :energyplus, options: { after_enter: :run_energyplus } },
+          { state: :reporting_measures, options: { after_enter: :run_reporting_measures } },
+          { state: :postprocess, options: { after_enter: :run_postprocess } },
+          { state: :finished },
+          { state: :errored }
         ]
       end
 
       # transitions for pat job
       def self.pat_transition
         [
-            {from: :queued, to: :preflight},
-            {from: :preflight, to: :runmanager},
-            {from: :runmanager, to: :postprocess},
-            {from: :postprocess, to: :finished}
+          { from: :queued, to: :preflight },
+          { from: :preflight, to: :runmanager },
+          { from: :runmanager, to: :postprocess },
+          { from: :postprocess, to: :finished }
         ]
       end
 
@@ -73,12 +73,12 @@ module OpenStudio
       def self.pat_states
         warn "[Deprecation Warning] explicitly specifying states will no longer be required in 0.3.0. Method #{__method__}"
         [
-            {state: :queued, options: {initial: true}},
-            {state: :preflight, options: {after_enter: :run_preflight}},
-            {state: :runmanager, options: {after_enter: :run_runmanager}},
-            {state: :postprocess, options: {after_enter: :run_postprocess}},
-            {state: :finished},
-            {state: :errored}
+          { state: :queued, options: { initial: true } },
+          { state: :preflight, options: { after_enter: :run_preflight } },
+          { state: :runmanager, options: { after_enter: :run_runmanager } },
+          { state: :postprocess, options: { after_enter: :run_postprocess } },
+          { state: :finished },
+          { state: :errored }
         ]
       end
 
@@ -94,21 +94,22 @@ module OpenStudio
         @current_state = nil
         @transitions = {}
         @directory = directory
+        @time_logger = TimeLogger.new
         # TODO: run directory is a convention right now. Move to a configuration item
         @run_directory = "#{@directory}/run"
 
         defaults = nil
         if options[:is_pat]
           defaults = {
-              transitions: OpenStudio::Workflow::Run.pat_transition,
-              states: OpenStudio::Workflow::Run.pat_states,
-              jobs: {}
+            transitions: OpenStudio::Workflow::Run.pat_transition,
+            states: OpenStudio::Workflow::Run.pat_states,
+            jobs: {}
           }
         else
           defaults = {
-              transitions: OpenStudio::Workflow::Run.default_transition,
-              states: OpenStudio::Workflow::Run.default_states,
-              jobs: {}
+            transitions: OpenStudio::Workflow::Run.default_transition,
+            states: OpenStudio::Workflow::Run.default_states,
+            jobs: {}
           }
         end
         @options = defaults.merge(options)
@@ -156,6 +157,7 @@ module OpenStudio
             @adapter.communicate_results @directory, @job_results[:run_runmanager]
           elsif @job_results[:run_reporting_measures]
             @logger.info 'Sending the reporting measuers results back to the adapter'
+            @time_logger.save(File.join(@directory,'profile.json'))
             @adapter.communicate_results @directory, @job_results[:run_reporting_measures]
           end
         ensure
@@ -166,8 +168,12 @@ module OpenStudio
           end
 
           @logger.info 'Workflow complete'
+          # Write out the TimeLogger once again in case the run_reporting_measures didn't exist
+          @time_logger.save(File.join(@directory,'profile.json'))
 
-          # TODO: define the outputs and figure out how to show it correctory
+
+
+          # TODO: define the outputs and figure out how to show it correctly
           obj_function_array ||= ['NA']
 
           # Print the objective functions to the screen even though the file is being used right now
@@ -180,13 +186,11 @@ module OpenStudio
 
       # Step through the states, if there is an error (e.g. exception) then go to error
       def step(*args)
-        begin
-          next_state
+        next_state
 
-          send("run_#{@current_state}")
-        rescue => e
-          step_error("#{e.message}:#{e.backtrace.join("\n")}")
-        end
+        send("run_#{@current_state}")
+      rescue => e
+        step_error("#{e.message}:#{e.backtrace.join("\n")}")
       end
 
       # call back for when there is an exception running any of the state transitions
@@ -281,7 +285,7 @@ module OpenStudio
 
       def next_state
         @logger.info "Current state: '#{@current_state}'"
-        ns = @transitions.select{ |h| h[:from] == @current_state}.first[:to]
+        ns = @transitions.select { |h| h[:from] == @current_state }.first[:to]
         @logger.info "Next state will be: '#{ns}'"
 
         # Set the next state before calling the method
@@ -309,7 +313,7 @@ module OpenStudio
         require_relative "jobs/#{from_method}/#{from_method}"
         klass_name = from_method.to_s.split('_').map(&:capitalize) * ''
         @logger.info "Getting method for state transition '#{from_method}'"
-        klass = Object.const_get(klass_name).new(@directory, @logger, @adapter, get_job_options)
+        klass = Object.const_get(klass_name).new(@directory, @logger, @time_logger, @adapter, get_job_options)
         klass
       end
     end

data/lib/openstudio/workflow/time_logger.rb

@@ -0,0 +1,53 @@
+# Class to store run times in a useful structure. Data are stored in a hash based on a the channel name
+# There is no concept of multi-levels. The onus is on the user to make sure that they don't add a value to the
+# logger that may be a level.
+class TimeLogger
+  attr_reader :channels
+
+  def initialize
+    @logger = []
+    @channels = {}
+  end
+
+  # name of the moniker that you are tracking. If the name is already in use, then it restarts the timer.
+  def start(channel)
+    # warning -- "will reset timer for #{moniker}" if @monikers.key? moniker
+    s = ::Time.now
+    @channels[channel] = {start_time_str: "#{s}", start_time: s.to_f}
+  end
+
+  def stop(channel)
+    end_time = ::Time.now.to_f
+    @logger << {
+        channel: channel,
+        start_time: @channels[channel][:start_time],
+        start_time_str: @channels[channel][:start_time_str],
+        end_time: end_time,
+        delta: end_time - @channels[channel][:start_time]
+    }
+
+    # remove the channel
+    @channels.delete(channel) if @channels.key? channel
+  end
+
+  def stop_all
+    @channels.each_key do |channel|
+      stop(channel)
+    end
+  end
+
+  # return the entire report
+  def report
+    @logger
+  end
+
+  # this will report all the values for all the channels with this name.
+  def delta(channel)
+    @logger.map { |k| {channel.to_s => k[:delta]} if k[:channel] == channel }
+  end
+
+  # save the data to a file. This will overwrite the file if it already exists
+  def save(filename)
+    File.open(filename, 'w') { |f| f << JSON.pretty_generate(@logger) }
+  end
+end

data/lib/openstudio/workflow/version.rb

@@ -19,6 +19,6 @@
 
 module OpenStudio
   module Workflow
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nicholas Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: zip
+  name: rubyXL
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.6
 description: Run OpenStudio based simulations using EnergyPlus
 email:
 - nicholas.long@nrel.gov
@@ -119,6 +133,7 @@ files:
 - lib/openstudio/workflow/jobs/run_xml/run_xml.rb
 - lib/openstudio/workflow/multi_delegator.rb
 - lib/openstudio/workflow/run.rb
+- lib/openstudio/workflow/time_logger.rb
 - lib/openstudio/workflow/version.rb
 - lib/openstudio-workflow.rb
 - README.md