Method execute

ruby/engine/openstudio_cli.rb:894–1186

Executes the standard, or one of two custom, workflows using the workflow-gem @param [Array] sub_argv Options passed to the run command from the user input @return [Fixnum] Return status

(sub_argv)

  # @return [Fixnum] Return status
  #
  def execute(sub_argv)

    $logger.info "Run, sub_argv = #{sub_argv}"

    # options are local to this method, run_methods are what get passed to workflow gem
    run_options = {}

    # Hidden option shhhhh
    run_options[:fast] = false
    if sub_argv.delete '--fast'
      run_options[:fast] = true
    end

    options = {}
    options[:debug] = false
    options[:no_simulation] = false
    options[:osw_path] = './workflow.osw'
    options[:post_process] = false
    options[:ep_json] = false
    options[:ft_options] = {}
    options[:show_stdout] = false
    options[:add_timings] = false
    options[:style_stdout] = false
    # TODO: I don't know if there's any value harcoding a default here really
    # options[:ft_options] = {
    #   :runcontrolspecialdays => true,
    #   :ip_tabular_output => false,
    #   :no_lifecyclecosts => false,
    #   :no_sqlite_output => false,
    #   :no_html_output => false,
    #   :no_variable_dictionary => false,
    #   :no_space_translation => false,
    # }

    opts = OptionParser.new do |o|
      o.banner = 'Usage: openstudio run [options]'
      o.separator ''
      o.separator 'Options:'
      o.separator ''

      o.on('-w', '--workflow [FILE]', 'Specify the FILE path to the workflow to run') do |osw_path|
        options[:osw_path] = osw_path
      end
      o.on('-m', '--measures_only', 'Only run the OpenStudio and EnergyPlus measures') do
        options[:no_simulation] = true
      end
      o.on('-p', '--postprocess_only', 'Only run the reporting measures') do
        options[:post_process] = true
      end
      o.on('--export-epJSON', 'export epJSON file format. The default is IDF') do
        options[:ep_json] = true
      end
      o.on('-s', '--socket PORT', 'Pipe status messages to a socket on localhost PORT') do |port|
        options[:socket] = port
      end
      o.on('--show-stdout', 'Prints the output of the workflow run in real time to the console, including E+ output') do
        options[:show_stdout] = true
      end