openstudio-workflow 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8246584121ca33fc5d5b10e34ff852d0884d6de6
-  data.tar.gz: 979bcb2d5e8445a6cf69cf1e948d091ae1a0cf61
+  metadata.gz: 8fa9aff18f17a837285bcc9bc72d8beff2b82028
+  data.tar.gz: 871e9aeffdd30c228cf804c758ea9a8918fa87ea
 SHA512:
-  metadata.gz: 843a1e9af4d17e54b28d30d83fe9020502c29ac71e350f3e1625694feea3120a97826dd8ae8c383e3f4bf75ab91ada7b2c67de3d737ed339bdbd099f4ba1517f
-  data.tar.gz: a9463ff16b20e54881097c2fae31ad82f9ed9a1d3398a7fc0987640abaa824fba58923bfd4783c52572d91ca673c967081c0d735e281e7657d30bd193b373773
+  metadata.gz: eee7ff6d5a939d168d981b1685d98e6264cabe87c0f8cf1a8693402ac8b635a0b6deab233a9675790c82e51a7bc5ce2335d21934d69a9555d279b3421b10d856
+  data.tar.gz: 37c6b1264805b11be32b885950d1aa5492dd4daf2c66c2e3a53402bc8749c071b218db914122b8063779fefa683eabd5e76329277238f6bc7ff55cd6b9b52c10

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 OpenStudio::Workflow Change Log
 ==================================
 
-Unreleased
+Version 0.0.3
 --------------
+* Allow measures to set weather file in a measure and have it update what EnergyPlus uses for the weather file.
+* OpenStudio::Workflow.run_energyplus method added to just run energyplus.
+* Remove AASM (act as state machine) and replace with simple tracking of the state. Interface is the same except there is now no need to pass in the States.
+* Catch EnergyPlus errors (non-zero exits), Fatal Errors in eplusout.err, and invalid weather files.
+* Force UTF-8 version upon reading the eplusout.err file
 
 Version 0.0.2
 --------------
@@ -16,4 +21,4 @@ Version 0.0.2
 Version 0.0.1
 --------------
 
-* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows
+* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows

data/lib/openstudio-workflow.rb

@@ -17,11 +17,11 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-require 'aasm'
 require 'pp'
 require 'multi_json'
 require 'colored'
 require 'fileutils'
+require 'securerandom'
 require 'json' # needed for a single pretty generate call
 require 'pathname'
 
@@ -48,10 +48,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
 
@@ -83,6 +83,38 @@ module OpenStudio
       run_klass
     end
 
+    # predefined method that simply runs EnergyPlus in the specified directory. It does not apply any workflow steps
+    # such as preprocessing / postprocessing.
+    # The directory must have the IDF and EPW file in the folder. The simulations will run in the directory/run path
+    def run_energyplus(adapter_name, run_directory, options = {})
+      unless (Pathname.new run_directory).absolute?
+        # relative to wherever you are running the script
+        run_directory = File.expand_path run_directory
+      end
+
+      transitions = [
+        { from: :queued, to: :preflight },
+        { from: :preflight, to: :energyplus },
+        { from: :energyplus, to: :finished }
+      ]
+
+      states = [
+        { state: :queued, options: { initial: true } },
+        { state: :preflight, options: { after_enter: :run_preflight } },
+        { state: :energyplus, options: { after_enter: :run_energyplus } },
+        { state: :finished },
+        { state: :errored }
+      ]
+      options = {
+        transitions: transitions,
+        states: states
+      }
+
+      adapter = load_adapter adapter_name, options[:adapter_options]
+      run_klass = OpenStudio::Workflow::Run.new(adapter, run_directory, options)
+      run_klass
+    end
+
     private
 
     def load_adapter(name, adapter_options = {})

data/lib/openstudio/workflow/adapters/mongo.rb

@@ -29,7 +29,7 @@ module OpenStudio
         end
 
         def write(msg)
-          @dp.sdp_log_file << msg.gsub('\n', '')
+          @dp.sdp_log_file << msg.gsub("\n", '')
           @dp.save!
         end
       end

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

@@ -99,7 +99,6 @@ module OpenStudio
         start_time = ::Time.now
         current_dir = Dir.pwd
         begin
-
           measure_working_directory = "#{@run_directory}/#{workflow_item[:measure_definition_class_name]}"
 
           @logger.info "Creating run directory to #{measure_working_directory}"

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

@@ -51,19 +51,50 @@ class RunEnergyplus
     # Ensure that the directory is created (but it should already be at this point)
     FileUtils.mkdir_p(@run_directory)
 
+    # if the weather file is already in the directory, then just use that weather file
+    weather_file_name = nil
+    weather_files = Dir["#{@directory}/*.epw"]
+    if weather_files.size > 1
+      @logger.info 'Multiple weather files in the directory. Will rely on the weather file name in the openstudio model'
+    elsif weather_files.size == 1
+      weather_file_name = weather_files.first
+    end
+
     # verify that the OSM, IDF, and the Weather files are in the run directory as the 'in.*' format
-    if @options[:run_openstudio][:weather_filename] && File.exist?(@options[:run_openstudio][:weather_filename])
+    if !weather_file_name &&
+        @options[:run_openstudio] &&
+        @options[:run_openstudio][:weather_filename] &&
+        File.exist?(@options[:run_openstudio][:weather_filename])
+      weather_file_name = @options[:run_openstudio][:weather_filename]
+    end
+
+    if weather_file_name
       # verify that it is named in.epw
-      unless File.basename(@options[:run_openstudio][:weather_filename]).downcase == 'in.idf'
-        FileUtils.copy(@options[:run_openstudio][:weather_filename], "#{@run_directory}/in.epw")
-      end
+      @logger.info "Weather file for EnergyPlus simulation is #{weather_file_name}"
+      FileUtils.copy(weather_file_name, "#{@run_directory}/in.epw")
     else
       fail "EPW file not found or not sent to #{self.class}"
     end
 
+    # check if the run folder has an IDF. If not then check if the parent folder does.
+    idf_file_name = nil
+    if File.exist?("#{@run_directory}/in.idf")
+      @logger.info 'IDF (in.idf) already exists in the run directory'
+    else
+      # glob for idf at the directory level
+      idfs = Dir["#{@directory}/*.idf"]
+      if idfs.size > 1
+        @logger.info 'Multiple IDF files in the directory. Cannot continue'
+      elsif idfs.size == 1
+        idf_file_name = idfs.first
+      end
+    end
+
     # Need to check the in.idf and in.osm
     # FileUtils.copy(options[:osm], "#{@run_directory}/in.osm")
-    # FileUtils.copy(options[:idf], "#{@run_directory}/in.idf")
+    if idf_file_name
+      FileUtils.copy(idf_file_name, "#{@run_directory}/in.idf")
+    end
 
     # can't create symlinks because the /vagrant mount is actually a windows mount
     @logger.info "Copying EnergyPlus files to run directory: #{@run_directory}"
@@ -105,15 +136,41 @@ class RunEnergyplus
 
       # create stdout
       File.open('stdout-energyplus', 'w') do |file|
-        IO.popen('./EnergyPlus') do |io|
+        IO.popen('./EnergyPlus + 2>&1') do |io|
           while (line = io.gets)
             file << line
           end
         end
       end
+      r = $?
+
+      @logger.info "System call to EnergyPlus returned #{r}"
+
+      paths_to_rm = []
+      paths_to_rm << Pathname.glob("#{@run_directory}/*.ini")
+      paths_to_rm << Pathname.glob("#{@run_directory}/*.so")
+      paths_to_rm << Pathname.glob("#{@run_directory}/*.idd")
+      paths_to_rm << Pathname.glob("#{@run_directory}/ExpandObjects")
+      paths_to_rm << Pathname.glob("#{@run_directory}/EnergyPlus")
+      paths_to_rm << Pathname.glob("#{@run_directory}/packaged_measures")
+      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."
+      end
+
+      # TODO: check the end or err file
+      if File.exists? '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."
+        end
+      end
     rescue => e
       log_message = "#{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
       @logger.error log_message
+      fail log_message
     ensure
       Dir.chdir(current_dir)
       @logger.info 'EnergyPlus Completed'

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

@@ -72,8 +72,12 @@ class RunOpenstudio
       updated_weather_file = get_weather_file_from_model
       unless updated_weather_file == @initial_weather_file
         # reset the result hash so the future processes know which weather file to run
-        @logger.info "Updating the weather file result to be #{updated_weather_file }"
-        @results[:weather_filename] = "#{@weather_file_path}/#{updated_weather_file}"
+        @logger.info "Updating the weather file to be '#{updated_weather_file}'"
+        if (Pathname.new updated_weather_file).absolute? && (Pathname.new updated_weather_file).exist?
+          @results[:weather_filename] = updated_weather_file
+        else
+          @results[:weather_filename] = "#{@weather_file_path}/#{updated_weather_file}"
+        end
       end
 
       @logger.info 'Saving measure output attributes JSON'
@@ -91,15 +95,9 @@ class RunOpenstudio
 
   def save_osm_and_idf
     # save the data
-    a = Time.now
-    osm_filename = "#{@run_directory}/out_raw.osm"
-    File.open(osm_filename, 'w') { |f| f << @model.to_s }
-    b = Time.now
-    @logger.info "Ruby write took #{b.to_f - a.to_f}"
-
     a = Time.now
     osm_filename = "#{@run_directory}/in.osm"
-    @model.save(OpenStudio::Path.new(osm_filename), true)
+    File.open(osm_filename, 'w') { |f| f << @model.to_s }
     b = Time.now
     @logger.info "OpenStudio write took #{b.to_f - a.to_f}"
 
@@ -141,6 +139,7 @@ class RunOpenstudio
         fail 'No seed model path in JSON defined'
       end
     else
+      # TODO: create a blank model and return
       fail 'No seed model block'
     end
 
@@ -173,7 +172,8 @@ class RunOpenstudio
     elsif @analysis_json[:analysis][:weather_file]
       if @analysis_json[:analysis][:weather_file][:path]
         weather_filename = File.expand_path(
-            File.join(@options[:analysis_root_path], @analysis_json[:analysis][:weather_file][:path]))
+            File.join(@options[:analysis_root_path], @analysis_json[:analysis][:weather_file][:path])
+        )
         @weather_file_path = File.dirname(weather_filename)
       else
         fail 'No weather file path defined'
@@ -191,15 +191,26 @@ class RunOpenstudio
     weather_filename
   end
 
+  # return the weather file from the model. If the weather file is defined in the model, then
+  # it checks the file paths to check if the model exists. This allows for a user to upload a
+  # weather file in a measure and then have the measure's path be used for the weather file.
   def get_weather_file_from_model
     wf = nil
     # grab the weather file out of the OSM if it exists
     if @model.weatherFile.empty?
       @logger.info 'No weather file in model'
     else
-      # this is the weather file from the OSM model
-      wf = File.basename(@model.weatherFile.get.path.get.to_s)
-      @logger.info "Model weather file is #{wf}" # unless model.weatherFile.empty?
+      p = @model.weatherFile.get.path.get.to_s.gsub('file://', '')
+      if File.exist? p
+        # use this entire path
+        @logger.info "Full path to weather file exists #{p}"
+        wf = p
+      else
+        # this is the weather file from the OSM model
+        wf = File.basename(@model.weatherFile.get.path.get.to_s)
+      end
+
+      # @logger.info "Initial model weather file is #{wf}" # unless model.weatherFile.empty?
     end
 
     wf
@@ -216,7 +227,7 @@ class RunOpenstudio
       forward_translator = OpenStudio::EnergyPlus::ForwardTranslator.new
       @model_idf = forward_translator.translateModel(@model)
       b = Time.now
-      @logger.info "Translate object to energyplus IDF took #{b.to_f - a.to_f}"
+      @logger.info "Translate object to EnergyPlus IDF took #{b.to_f - a.to_f}"
     end
   end
 end

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

@@ -94,17 +94,11 @@ class RunPostprocess
     # paths_to_rm << Pathname.glob("#{@run_directory}/*.idf") # keep the idfs
     # paths_to_rm << Pathname.glob("*.audit")
     # paths_to_rm << Pathname.glob("*.bnd")
-    paths_to_rm << Pathname.glob("#{@run_directory}/*.ini")
     paths_to_rm << Pathname.glob("#{@run_directory}/*.eso")
     paths_to_rm << Pathname.glob("#{@run_directory}/*.mtr")
-    paths_to_rm << Pathname.glob("#{@run_directory}/*.so")
     paths_to_rm << Pathname.glob("#{@run_directory}/*.epw")
-    paths_to_rm << Pathname.glob("#{@run_directory}/*.idd")
     paths_to_rm << Pathname.glob("#{@run_directory}/*.mtd")
     paths_to_rm << Pathname.glob("#{@run_directory}/*.rdd")
-    paths_to_rm << Pathname.glob("#{@run_directory}/ExpandObjects")
-    paths_to_rm << Pathname.glob("#{@run_directory}/EnergyPlus")
-    paths_to_rm << Pathname.glob("#{@run_directory}/packaged_measures")
     paths_to_rm.each { |p| FileUtils.rm_rf(p) }
   end
 end

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

@@ -65,9 +65,7 @@ class RunRunmanager
   def perform
     @logger.info "Calling #{__method__} in the #{self.class} class"
     @logger.info "Current directory is #{@directory}"
-
     begin
-
       @logger.info 'Retrieving datapoint and problem'
       @datapoint_json = @adapter.get_datapoint(@directory.to_s, @options)
       @analysis_json = @adapter.get_problem(@directory.to_s, @options)
@@ -108,9 +106,9 @@ class RunRunmanager
         # load problem formulation
         loadResult = OpenStudio::Analysis.loadJSON(JSON.pretty_generate(@analysis_json))
         if loadResult.analysisObject.empty?
-          loadResult.errors.each { |error|
+          loadResult.errors.each do |error|
             @logger.warn error.logMessage # DLM: is this right?
-          }
+          end
           fail 'Unable to load analysis json.'
         end
 
@@ -130,9 +128,9 @@ class RunRunmanager
         # load data point to run
         loadResult = OpenStudio::Analysis.loadJSON(JSON.pretty_generate(@datapoint_json))
         if loadResult.analysisObject.empty?
-          loadResult.errors.each { |error|
+          loadResult.errors.each do |error|
             @logger.warn error.logMessage
-          }
+          end
           fail 'Unable to load data point json.'
         end
         data_point = loadResult.analysisObject.get.to_DataPoint.get

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

@@ -116,7 +116,7 @@ class RunXml
     model
   end
 
-  # Save the weather file to the instance variable
+  # Save the weather file to the instance variable. This can change later after measures run.
   def load_weather_file
     weather_filename = nil
     if @analysis_json[:analysis][:weather_file]

data/lib/openstudio/workflow/run.rb

@@ -21,8 +21,6 @@
 module OpenStudio
   module Workflow
     class Run
-      include AASM
-
       attr_accessor :logger
 
       attr_reader :options
@@ -30,61 +28,57 @@ module OpenStudio
       attr_reader :directory
       attr_reader :run_directory
       attr_reader :final_state
+      attr_reader :final_message
       attr_reader :job_results
 
-      # Create a nice name for the state object instead of aasm
-      alias_method :state, :aasm
-
       # load the transitions
       def self.default_transition
-        # TODO: replace these with dynamic states from a config file of some sort
         [
-          { 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
 
       # The default states for the workflow.  Note that the states of :queued of :finished need
       # to exist for all cases.
       def self.default_states
-        # TODO: replace this with some sort of dynamic store
+        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
-        # TODO: replace these with dynamic states from a config file of some sort
         [
-          { 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
 
       # states for pat job
       def self.pat_states
-        # TODO: replace this with some sort of dynamic store
+        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
 
@@ -93,8 +87,12 @@ module OpenStudio
       # @param adapter an instance of the adapter class
       # @param directory location of the datapoint directory to run. This is needed
       #        independent of the adapter that is being used. Note that the simulation will actually run in 'run'
+      # @param options that are sent to the adapters
       def initialize(adapter, directory, options = {})
         @adapter = adapter
+        @final_message = ''
+        @current_state = nil
+        @transitions = {}
         @directory = directory
         # TODO: run directory is a convention right now. Move to a configuration item
         @run_directory = "#{@directory}/run"
@@ -102,21 +100,19 @@ module OpenStudio
         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)
 
-        @error = false
-
         @job_results = {}
 
         # By default blow away the entire run directory every time and recreate it
@@ -136,8 +132,6 @@ module OpenStudio
         @logger.info "Initializing directory #{@directory} for simulation with options #{@options}"
         @logger.info "OpenStudio loaded: '#{$openstudio_gem}'"
 
-        super()
-
         # load the state machine
         machine
       end
@@ -147,7 +141,8 @@ module OpenStudio
       def run
         @logger.info "Starting workflow in #{@directory}"
         begin
-          while state.current_state != :finished && !@error
+          while @current_state != :finished && @current_state != :errored
+            sleep 2
             step
           end
 
@@ -164,7 +159,7 @@ module OpenStudio
             @adapter.communicate_results @directory, @job_results[:run_reporting_measures]
           end
         ensure
-          if @error
+          if @current_state == :errored
             @adapter.communicate_failure @directory
           else
             @adapter.communicate_complete @directory
@@ -180,18 +175,29 @@ module OpenStudio
           puts obj_function_array.join(',')
         end
 
-        state.current_state
+        @current_state
+      end
+
+      # Step through the states, if there is an error (e.g. exception) then go to error
+      def step(*args)
+        begin
+          next_state
+
+          send("run_#{@current_state}")
+        rescue => e
+          step_error("#{e.message}:#{e.backtrace.join("\n")}")
+        end
       end
 
       # call back for when there is an exception running any of the state transitions
       def step_error(*args)
         # Make sure to set the instance variable @error to true in order to stop the :step
         # event from being fired.
-        @error = true
-        @logger.error "Found error in state '#{aasm.current_state}' with message #{args}}"
+        @final_message = "Found error in state '#{@current_state}' with message #{args}}"
+        @logger.error @final_message
 
-        # Call the error_out event to transition to the :errored state
-        error_out
+        # transition to an error state
+        @current_state = :errored
       end
 
       # TODO: these methods needs to be dynamic or inherited
@@ -254,45 +260,42 @@ module OpenStudio
         @logger.info @job_results
       end
 
-      def final_state
-        state.current_state
+      # last method that is called.
+      def run_finished
+        @logger.info "Running #{__method__}"
+
+        @current_state
       end
+      alias_method :final_state, :run_finished
 
       private
 
-      # Create a state machine from the predefined transitions methods.  This loads in
-      # a single event of :step which steps through the transitions defined in the Hash in default_transitions
-      # and calls the actions defined in the states in the Hash of default_states
+      # Create a state machine from the predefined transitions methods.  This will initialize in the :queued state
+      # and then load in the transitions from the @options hash
       def machine
         @logger.info 'Initializing state machine'
-        @options[:states].each do |s|
-          s[:options] ? o = s[:options] : o = {}
-          OpenStudio::Workflow::Run.aasm.states << AASM::State.new(s[:state], self.class, o)
-        end
-        OpenStudio::Workflow::Run.aasm.initial_state(:queued)
+        @current_state = :queued
 
-        # Create a new event and add in the transitions
-        new_event = OpenStudio::Workflow::Run.aasm.event(:step)
-        event = OpenStudio::Workflow::Run.aasm.events[:step]
+        @transitions = @options[:transitions]
+      end
 
-        # TODO: make a config option to not go to the error state. Useful to not error-state when testing
-        event.options[:error] = 'step_error'
-        @options[:transitions].each do |t|
-          event.transitions(t)
-        end
+      def next_state
+        @logger.info "Current state: '#{@current_state}'"
+        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
+        @current_state = ns
 
-        # Add in special event to error_out the state machine
-        new_event = OpenStudio::Workflow::Run.aasm.event(:error_out)
-        event = OpenStudio::Workflow::Run.aasm.events[:error_out]
-        event.transitions(to: :errored)
+        # do not return anything, the step method uses the @current_state variable to call run_#{next_state}
       end
 
       # Get any options that may have been sent into the class defining the workflow step
       def get_job_options
         result = {}
-        # if @options[:jobs].has_key?(state.current_state)
+        # if @options[:jobs].has_key?(@current_state)
         # logger.info "Retrieving job options from the @options array for #{state.current_state}"
-        #  result = @options[:jobs][state.current_state]
+        #  result = @options[:jobs][@current_state]
         # end
 
         # result

data/lib/openstudio/workflow/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nicholas Long
@@ -39,47 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aasm
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: facter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: zip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 description: Run OpenStudio based simulations using EnergyPlus
 email:
 - nicholas.long@nrel.gov