openstudio-workflow 2.1.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c632f0a2834a490fbd25b21ef3f17ff07d77e08bdf76db7d1737a2843665d2b6
-  data.tar.gz: 6ac3e3165ddac8de85d5a364878e4ae18089a9b7c2171b9bf2341cd1c4c9438e
+  metadata.gz: dbb63da4231bd9af7637e0cbca0080f29a348b0bc2ea7988785775a585f946ed
+  data.tar.gz: aab20ab9eda5320da30211af54e309368bd791b500b508a7ff6783ee20a99e0c
 SHA512:
-  metadata.gz: e274ab7d2787530a70ea4b5f17859640597044b72ec0c62a5b1c35dd459b7e013fe248e8454526998ed66ec22750a4fc02831a30314cf50639717f608b11fa8f
-  data.tar.gz: 830be90f370e3f1290c3dddeeaa63c6e1b7d7f9b4bb7e64747ac04fbf44bd3e89b2f07d11683249aa19600dd331095a87694c55f1bc9fa9102d93bd65bb05071
+  metadata.gz: fe997e27a8e82a3ad66d672b4d76c02b449c27a151780c52b5e6f06d94b58097dd29932dca8927284b33dda79cf4216e616fb9a5d8fa2f98fba71e2f02196ca1
+  data.tar.gz: 248121557204007e6ad2d7f740e6457bea71af30b239be90c979a92a458d4ceb53cd2fbf5120564e44ab754aee87ef9bca63b9acc68642ee5a91100627387873

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 OpenStudio::Workflow Change Log
 ==================================
 
+Version 2.3.1
+-------------
+* Forward tranlsation when !@run_options.get.forwardTranslateOptions().empty?
+
+Version 2.3.0
+-------------
+* Feature [#135](https://github.com/NREL/OpenStudio-workflow-gem/issues/135) Add option to export/run epJSON
+
+Version 2.2.1
+-------------
+* Fixes [#4150](https://github.com/NREL/OpenStudio/issues/4150) LoadError changes current working directory in CLI
+* Add skip option to not zip up datapoint results
+* Update measure tester gem which upgrades Rubocop to 1.15
+* Update styles to v4 based on new version of Rubocop
+
+Version 2.2.0
+-------------
+* Minimum Ruby version upgraded to 2.7.0
+* Bundler bumped to ~> 2.2
+* Updated copyright
+
 Version 2.1.1
 -------------
 * Add support for URBANopt Workflow
@@ -13,18 +34,15 @@ Version 2.1.0
 
 Version 2.0.1
 -------------
-
 * Bug fix for idf.addObjects(object) to idf.addObject(object)
 
 Version 2.0.0
 -------------
-
 * Support Ruby > 2.5
 * Support OpenStudio 3.x
 
 Version 1.3.5
 -------------
-
 * Allow reporting to fail gracefully so HTML reports are returned Fixed [this](https://github.com/NREL/OpenStudio/issues/864).
 * Allow EMS:OutputVariable in reporting measure
 * Fixes [#93](https://github.com/NREL/OpenStudio-workflow-gem/issues/93) - Pass Model to the arguments method of ReportingMeasure

data/README.md

@@ -9,7 +9,7 @@ This branch is the development branch for the OpenStudio workflow gem.
 
 The OpenStudio Workflow Gem has the following dependencies:
 
-* Ruby 2.5.5
+* Ruby 2.7.2
 * OpenStudio 3.x
 
 [OpenStudio](https://www.openstudio.net/) needs to be installed and in your path.  On Mac/Linux it is easiest to add the following to your .bash_profile or /etc/profile.d/<file>.sh to ensure OpenStudio loads. Assuming OpenStudio 3.0.0 installed:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -192,6 +192,24 @@ module OpenStudio
           return default
         end
 
+        def skip_zip_results(user_options, default)
+          # user option trumps all others
+          return user_options[:skip_zip_results] if user_options[:skip_zip_results]
+
+          # try to read from OSW
+          if @run_options && !@run_options.empty?
+            if @run_options.get.respond_to?(:skipZipResults)
+              return @run_options.get.skipZipResults
+            else
+              if @workflow[:run_options]
+                return @workflow[:run_options][:skip_zip_results]
+              end
+            end
+          end
+
+          return default
+        end
+
         def preserve_run_dir(user_options, default)
           # user option trumps all others
           return user_options[:preserve_run_dir] if user_options[:preserve_run_dir]
@@ -273,6 +291,101 @@ module OpenStudio
           return default
         end
 
+        def epjson(user_options, default, logger)
+          # check version for this feature
+          os_version = OpenStudio::VersionString.new(OpenStudio.openStudioVersion)
+          min_version_feature = OpenStudio::VersionString.new('3.3.0')
+          unless os_version >= min_version_feature
+            log_message = 'epJSON is only supported for versions >= 3.3.0. Falling back to using IDF'
+            logger.info log_message
+            return default
+          end
+
+          # user option trumps all others
+          return user_options[:epjson] if user_options[:epjson]
+
+          # try to read from OSW
+
+          if @run_options.is_initialized && @run_options.get.respond_to?(:epjson)
+            return @run_options.get.epjson
+          end
+
+          return default
+        end
+
+        # Process the `run` method `ft_options` subhash
+        #
+        # This will validate that each suboption is supported in the current
+        # version as well as enhance the hash with the corresponding
+        # ForwardTranslator method name to set the value on the FT later
+        # in `translate_to_energyplus`
+        # user option trumps all others
+        def ft_options(user_options, default, logger)
+          # check version for this feature
+          os_version = OpenStudio::VersionString.new(OpenStudio.openStudioVersion)
+
+          os300 = OpenStudio::VersionString.new('3.0.0')
+          os330 = OpenStudio::VersionString.new('3.3.0')
+          known_ft_opts = {
+            # All Versions
+            runcontrolspecialdays: { method_name: :setKeepRunControlSpecialDays, min_version: nil },
+            ip_tabular_output: { method_name: :setIPTabularOutput, min_version: nil },
+            no_lifecyclecosts: { method_name: :setExcludeLCCObjects, min_version: nil },
+            # 3.0.0
+            no_sqlite_output: { method_name: :setExcludeSQliteOutputReport, min_version: os300 },
+            no_html_output: { method_name: :setExcludeHTMLOutputReport, min_version: os300 },
+            no_variable_dictionary: { method_name: :setExcludeVariableDictionary, min_version: os300 },
+            # 3.3.0
+            no_space_translation: { method_name: :setExcludeSpaceTranslation, min_version: os330 }
+          }
+
+          # user option trumps all others
+          if user_options[:ft_options]
+            ft_opts = {}
+            user_options[:ft_options].each do |opt_flag_name, opt_flag|
+              puts "#{opt_flag_name} = #{opt_flag}"
+              unless known_ft_opts.key?(opt_flag_name)
+                log_message = "'ft_options' suboption '#{opt_flag_name}' is not recognized, ignoring it."
+                logger.warn log_message
+                next
+              end
+              min_version = known_ft_opts[opt_flag_name][:min_version]
+              if !min_version.nil? && os_version < min_version
+                log_message = "'ft_options' suboption '#{opt_flag_name}' is only supported for OpenStudio Version >= #{min_version.str}, ignoring it."
+                logger.warn log_message
+                next
+              end
+              ft_opts[opt_flag_name] = { method_name: known_ft_opts[opt_flag_name][:method_name], value: opt_flag }
+            end
+
+            return ft_opts
+          end
+
+          # try to read from OSW
+
+          if @run_options.is_initialized && @run_options.get.respond_to?(:forwardTranslateOptions) && !@run_options.get.forwardTranslateOptions().empty?
+            ft_opts = {}
+            JSON.parse(@run_options.get.forwardTranslateOptions, symbolize_names: true).each do |opt_flag_name, opt_flag|
+              unless known_ft_opts.key?(opt_flag_name)
+                log_message = "'ft_options' suboption '#{opt_flag_name}' is not recognized, ignoring it."
+                logger.warn log_message
+                next
+              end
+              min_version = known_ft_opts[opt_flag_name.to_sym][:min_version]
+              if !min_version.nil? && os_version < min_version
+                log_message = "'ft_options' suboption '#{opt_flag_name}' is only supported for OpenStudio Version >= #{min_version.str}, ignoring it."
+                logger.warn log_message
+                next
+              end
+              ft_opts[opt_flag_name] = { method_name: known_ft_opts[opt_flag_name][:method_name], value: opt_flag }
+            end
+
+            return ft_opts
+          end
+
+          return default
+        end
+
         def weather_file(user_options, default)
           # user option trumps all others
           return user_options[:weather_file] if user_options[:weather_file]

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -136,8 +136,10 @@ module OpenStudio
 
         # Write the results of the workflow to the filesystem
         #
-        def communicate_results(directory, results)
-          zip_results(directory)
+        def communicate_results(directory, results, skip_zip_results)
+          if !skip_zip_results
+            zip_results(directory)
+          end
 
           if results.is_a? Hash
             # DLM: don't we want this in the results zip?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -55,10 +55,6 @@ module OpenStudio
           @socket.write("Started\n")
         end
 
-        def communicate_results(directory, results)
-          super
-        end
-
         def communicate_complete
           super
           @socket.write("Complete\n")
@@ -75,7 +71,7 @@ module OpenStudio
 
         def communicate_transition(message, type, options = {})
           super
-          @socket.write(message + "\n")
+          @socket.write("#{message}\n")
         end
 
         def communicate_energyplus_stdout(line, options = {})

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -47,22 +47,6 @@ module OpenStudio
           raise 'The required :url option was not passed to the web output adapter' unless options[:url]
         end
 
-        def communicate_started
-          super
-        end
-
-        def communicate_results(directory, results)
-          super
-        end
-
-        def communicate_complete
-          super
-        end
-
-        def communicate_failure
-          super
-        end
-
         def communicate_objective_function(objectives, options = {})
           super
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -113,19 +113,18 @@ module OpenStudio
             end
 
             # skip x-large directory
-            if File.size?(file)
-              next if File.size?(file) >= 15000000
+            if File.size?(file) && (File.size?(file) >= 15000000)
+              next
             end
+
             add_directory_to_zip(zf, file, directory)
           else
             next if File.extname(file) =~ /\.rb.*/
             next if File.extname(file) =~ /\.zip.*/
 
             # skip large non-osm/idf files
-            if File.size(file)
-              if File.size(file) >= 100000000
-                next unless File.extname(file) == '.osm' || File.extname(file) == '.idf'
-              end
+            if File.size(file) && (File.size(file) >= 100000000) && !(File.extname(file) == '.osm' || File.extname(file) == '.idf')
+              next
             end
 
             zip_file_to_add = file.gsub("#{directory}/", '')

data/lib/openstudio/workflow/job.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -181,7 +181,7 @@ class RunInitialization < OpenStudio::Workflow::Job
 
     unless weather_path.empty?
       weather_path = weather_path.get
-      @logger.debug 'Searching for weather file #{weather_path}'
+      @logger.debug "Searching for weather file #{weather_path}"
 
       weather_full_path = workflow_json.findFile(weather_path)
       if weather_full_path.empty?

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -62,19 +62,17 @@ class RunReportingMeasures < OpenStudio::Workflow::Job
 
     # Ensure output_attributes is initialized in the registry
     @registry.register(:output_attributes) { {} } unless @registry[:output_attributes]
-    
-    #get OSA[:urbanopt]  #BLB should prob be sent in as cli arg and used in options but for now just do this
+
+    # get OSA[:urbanopt]  #BLB should prob be sent in as cli arg and used in options but for now just do this
     @registry.register(:urbanopt) { false }
     if @registry[:osw_path]
       workflow = nil
       if File.exist? @registry[:osw_path]
         workflow = ::JSON.parse(File.read(@registry[:osw_path]), symbolize_names: true)
-        if !workflow.nil?
-          if !workflow[:urbanopt].nil?
-            @registry.register(:urbanopt) { workflow[:urbanopt] }
-          end
+        if !workflow.nil? && !workflow[:urbanopt].nil?
+          @registry.register(:urbanopt) { workflow[:urbanopt] }
         end
-      end    
+      end
     end
 
     # Load simulation files as required

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/openstudio/workflow/multi_delegator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/openstudio/workflow/registry.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/openstudio/workflow/run.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -48,12 +48,7 @@ module OpenStudio
     class Run
       attr_accessor :registry
 
-      attr_reader :options
-      attr_reader :input_adapter
-      attr_reader :output_adapter
-      attr_reader :final_message
-      attr_reader :job_results
-      attr_reader :current_state
+      attr_reader :options, :input_adapter, :output_adapter, :final_message, :job_results, :current_state
 
       # Define the default set of jobs. Note that the states of :queued of :finished need to exist for all job arrays.
       #
@@ -90,6 +85,7 @@ module OpenStudio
       # @option user_options [Hash] :debug Print debugging messages, overrides OSW option if set, defaults to false
       # @option user_options [Hash] :energyplus_path Specifies path to energyplus executable, defaults to empty
       # @option user_options [Hash] :fast Speeds up workflow by skipping steps not needed for running simulations, defaults to false
+      # @option user_options [Hash] :skip_zip_results Skips creating the data_point.zip file. Setting to `true` can cause issues with workflows expecting .zip files to signal completion (e.g., OpenStudio Analysis Framework), defaults to false
       # @option user_options [Hash] :jobs Simulation workflow, overrides jobs in OSW if set, defaults to default_jobs
       # @option user_options [Hash] :output_adapter Output adapter to use, overrides output adapter in OSW if set, defaults to local adapter
       # @option user_options [Hash] :preserve_run_dir Prevents run directory from being cleaned prior to run, overrides OSW option if set, defaults to false - DLM, Deprecate
@@ -99,6 +95,8 @@ module OpenStudio
       # @option user_options [Hash] :targets Log targets to write to, defaults to standard out and run.log
       # @option user_options [Hash] :verify_osw Check OSW for correctness, defaults to true
       # @option user_options [Hash] :weather_file Initial weather file to load, overrides OSW option if set, defaults to empty
+      # @option user_options [Hash] :epjson - Create, export and run using epjson format. Default is IDF
+      # @option user_options [Hash] :ft_options - A subhash of options to set on the ForwardTranslator
       def initialize(osw_path, user_options = {})
         # DLM - what is final_message?
         @final_message = ''
@@ -158,15 +156,13 @@ module OpenStudio
         end
 
         # By default blow away the entire run directory every time and recreate it
-        unless @options[:preserve_run_dir]
-          if File.exist?(@registry[:run_dir])
-            # logger is not initialized yet (it needs run dir to exist for log)
-            puts "Removing existing run directory #{@registry[:run_dir]}" if @options[:debug]
-
-            # DLM: this is dangerous, we are calling rm_rf on a user entered directory, need to check this first
-            # TODO: Echoing Dan's comment
-            FileUtils.rm_rf(@registry[:run_dir])
-          end
+        if !@options[:preserve_run_dir] && File.exist?(@registry[:run_dir])
+          # logger is not initialized yet (it needs run dir to exist for log)
+          puts "Removing existing run directory #{@registry[:run_dir]}" if @options[:debug]
+
+          # DLM: this is dangerous, we are calling rm_rf on a user entered directory, need to check this first
+          # TODO: Echoing Dan's comment
+          FileUtils.rm_rf(@registry[:run_dir])
         end
         FileUtils.mkdir_p(@registry[:run_dir])
 
@@ -176,7 +172,7 @@ module OpenStudio
         else
           # don't create these files unless we want to use them
           # DLM: TODO, make sure that run.log will be closed later
-          @options[:targets] = [STDOUT, File.open(File.join(@registry[:run_dir], 'run.log'), 'a')]
+          @options[:targets] = [$stdout, File.open(File.join(@registry[:run_dir], 'run.log'), 'a')]
         end
 
         @registry.register(:log_targets) { @options[:targets] }
@@ -204,6 +200,9 @@ module OpenStudio
         @options[:verify_osw] = @input_adapter.verify_osw(user_options, true)
         @options[:weather_file] = @input_adapter.weather_file(user_options, nil)
         @options[:fast] = @input_adapter.fast(user_options, false)
+        @options[:skip_zip_results] = @input_adapter.skip_zip_results(user_options, false)
+        @options[:epjson] = @input_adapter.epjson(user_options, false,  @logger)
+        @options[:ft_options] = @input_adapter.ft_options(user_options, {}, @logger)
 
         openstudio_dir = 'unknown'
         begin
@@ -236,7 +235,7 @@ module OpenStudio
 
           if !@options[:fast]
             @logger.info 'Finished workflow - communicating results and zipping files'
-            @output_adapter.communicate_results(@registry[:run_dir], @registry[:results])
+            @output_adapter.communicate_results(@registry[:run_dir], @registry[:results], @options[:skip_zip_results])
           end
         rescue StandardError => e
           @logger.info "Error occurred during running with #{e.message}"

data/lib/openstudio/workflow/time_logger.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -43,6 +43,8 @@ module OpenStudio
       module EnergyPlus
         require 'openstudio/workflow/util/io'
         include OpenStudio::Workflow::Util::IO
+        require 'openstudio/workflow/util/model'
+        include OpenStudio::Workflow::Util::Model
         ENERGYPLUS_REGEX = /^energyplus\D{0,4}$/i.freeze
         EXPAND_OBJECTS_REGEX = /^expandobjects\D{0,4}$/i.freeze
 
@@ -94,8 +96,8 @@ module OpenStudio
           Dir["#{energyplus_path}/*"].each do |file|
             next if File.directory? file
 
-            # copy idd and ini files
-            if File.extname(file).downcase =~ /.idd|.ini/
+            # copy idd, ini and epJSON schema files
+            if File.extname(file).downcase =~ /.idd|.ini|.epjson/
               dest_file = "#{run_directory}/#{File.basename(file)}"
               energyplus_files << dest_file
               FileUtils.copy file, dest_file
@@ -125,12 +127,14 @@ module OpenStudio
         # @return [Void]
         #
         def call_energyplus(run_directory, energyplus_path = nil, output_adapter = nil, logger = nil, workflow_json = nil)
-          logger ||= ::Logger.new(STDOUT) unless logger
+          logger ||= ::Logger.new($stdout) unless logger
 
           current_dir = Dir.pwd
           energyplus_path ||= find_energyplus
           logger.info "EnergyPlus path is #{energyplus_path}"
+
           energyplus_files, energyplus_exe, expand_objects_exe = prepare_energyplus_dir(run_directory, logger, energyplus_path)
+
           Dir.chdir(run_directory)
           logger.info "Starting simulation in run directory: #{Dir.pwd}"
 
@@ -152,18 +156,50 @@ module OpenStudio
             end
           end
 
-          # create stdout
-          command = popen_command("\"#{energyplus_exe}\" 2>&1")
-          logger.info "Running command '#{command}'"
-          File.open('stdout-energyplus', 'w') do |file|
-            ::IO.popen(command) do |io|
-              while (line = io.gets)
-                file << line
-                output_adapter&.communicate_energyplus_stdout(line)
+          # Translate the IDF to an epJSON if @options[:epjson] is true
+          # Ideally, this would be done sooner in the workflow process but many processes
+          # manipulate the model_idf, some which are ep_measures that may not work with json
+          # and ExpandObjects does not currently support epjson anyway to that still needs to run
+          # before this can be changed.
+          if @options[:epjson]
+            @logger.info 'Beginning the translation to epJSON'
+            @registry[:time_logger]&.start('Translating to EnergyPlus epJSON')
+            idf_final = load_idf("#{run_directory}/in.idf", @logger)
+            model_epjson = translate_idf_to_epjson idf_final, @logger
+            @registry[:time_logger]&.stop('Translating to EnergyPlus')
+            @logger.info 'Successfully translated to epJSON'
+            @registry[:time_logger]&.start('Saving epJSON')
+            epjson_name = save_epjson(model_epjson, run_directory)
+            @registry[:time_logger]&.stop('Saving epJSON')
+            @logger.debug "Saved epJSON as #{epjson_name}"
+          end
+
+          # Run using epJSON if @options[:epjson] true, otherwise use IDF
+          if @options[:epjson]
+            command = popen_command("\"#{energyplus_exe}\" in.epJSON 2>&1")
+            logger.info "Running command '#{command}'"
+            File.open('stdout-energyplus', 'w') do |file|
+              ::IO.popen(command) do |io|
+                while (line = io.gets)
+                  file << line
+                  output_adapter&.communicate_energyplus_stdout(line)
+                end
               end
             end
+            r = $?
+          else
+            command = popen_command("\"#{energyplus_exe}\" 2>&1")
+            logger.info "Running command '#{command}'"
+            File.open('stdout-energyplus', 'w') do |file|
+              ::IO.popen(command) do |io|
+                while (line = io.gets)
+                  file << line
+                  output_adapter&.communicate_energyplus_stdout(line)
+                end
+              end
+            end
+            r = $?
           end
-          r = $?
 
           logger.info "EnergyPlus returned '#{r}'"
           unless r.to_i.zero?
@@ -231,7 +267,7 @@ module OpenStudio
           end
 
           # merge in monthly reports
-          EnergyPlus.monthly_report_idf_text.split(/^[\s]*$/).each do |object|
+          EnergyPlus.monthly_report_idf_text.split(/^\s*$/).each do |object|
             object = object.strip
             next if object.empty?
 
@@ -278,11 +314,9 @@ module OpenStudio
           allowed_objects << 'Meter:CustomDecrement'
           allowed_objects << 'EnergyManagementSystem:OutputVariable'
 
-          if allowed_objects.include?(idd_object.name)
-            unless check_for_object(workspace, idf_object, idd_object.type)
-              workspace.addObject(idf_object)
-              num_added += 1
-            end
+          if allowed_objects.include?(idd_object.name) && !check_for_object(workspace, idf_object, idd_object.type)
+            workspace.addObject(idf_object)
+            num_added += 1
           end
 
           allowed_unique_objects = []
@@ -293,15 +327,13 @@ module OpenStudio
           # OutputControl:ReportingTolerances # not allowed
           # Output:SQLite # not allowed
 
-          if allowed_unique_objects.include?(idf_object.iddObject.name)
-            if idf_object.iddObject.name == 'Output:Table:SummaryReports'
-              summary_reports = workspace.getObjectsByType(idf_object.iddObject.type)
-              if summary_reports.empty?
-                workspace.addObject(idf_object)
-                num_added += 1
-              else
-                merge_output_table_summary_reports(summary_reports[0], idf_object)
-              end
+          if allowed_unique_objects.include?(idf_object.iddObject.name) && (idf_object.iddObject.name == 'Output:Table:SummaryReports')
+            summary_reports = workspace.getObjectsByType(idf_object.iddObject.type)
+            if summary_reports.empty?
+              workspace.addObject(idf_object)
+              num_added += 1
+            else
+              merge_output_table_summary_reports(summary_reports[0], idf_object)
             end
           end
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

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

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -342,6 +342,8 @@ module OpenStudio
             result = nil
             begin
               load measure_path.to_s
+              # load.c in ruby can result in changing dir to root / so preserve cwd here. happens in openstudio cli 
+              Dir.chdir measure_run_dir 
               measure_object = Object.const_get(class_name).new
             rescue => e
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -95,19 +95,55 @@ module OpenStudio
         # @todo (rhorsey) rescue errors here
         #
         def translate_to_energyplus(model, logger = nil)
-          logger ||= ::Logger.new(STDOUT)
+          logger ||= ::Logger.new($stdout)
           logger.info 'Translate object to EnergyPlus IDF in preparation for EnergyPlus'
           a = ::Time.now
           # ensure objects exist for reporting purposes
           model.getFacility
           model.getBuilding
-          forward_translator = OpenStudio::EnergyPlus::ForwardTranslator.new
-          model_idf = forward_translator.translateModel(model)
+          ft = OpenStudio::EnergyPlus::ForwardTranslator.new
+
+          ft_options = @options[:ft_options]
+          if !ft_options.empty?
+
+            msg = "Custom ForwardTranslator options passed:\n"
+
+            ft_options.each do |opt_flag_name, h|
+              ft_method = h[:method_name]
+              opt_flag = h[:value]
+
+              # Call the FT setter with the value passed in
+              ft.method(ft_method).call(opt_flag)
+
+              msg += "* :#{opt_flag_name}=#{opt_flag} => ft.#{ft_method}(#{opt_flag})\n"
+            end
+
+            logger.info msg
+          end
+
+          model_idf = ft.translateModel(model)
           b = ::Time.now
           logger.info "Translate object to EnergyPlus IDF took #{b.to_f - a.to_f}"
           model_idf
         end
 
+        # Translates an IDF model into an EnergyPlus epJSON object
+        #
+        # @param [Object] OpenStudio::IdfFile instance to translate into an OpenStudio epJSON object -- see
+        #   the OpenStudio SDK for details on the process
+        # @return [Object] Returns and OpenStudio::epJSONobject
+        #
+        def translate_idf_to_epjson(model_idf, logger = nil)
+          logger ||= ::Logger.new($stdout)
+          logger.info 'Translate IDF to epJSON in preparation for EnergyPlus'
+          a = ::Time.now
+          model_epjson = OpenStudio::EPJSON.toJSONString(model_idf)
+          b = ::Time.now
+          logger.info "Translate IDF to EnergyPlus epJSON took #{b.to_f - a.to_f}"
+
+          model_epjson
+        end
+
         # Saves an OpenStudio model object to file
         #
         # @param [Object] model The OpenStudio::Model instance to save to file
@@ -149,6 +185,27 @@ module OpenStudio
           end
           idf_filename
         end
+
+        # Saves an OpenStudio EpJSON model object to file
+        #
+        # @param [Object] model The OpenStudio::Workspace instance to save to file
+        # @param [String] save_directory Folder to save the model in
+        # @param [String] name ('in.epJSON') Option to define a non-standard name
+        # @return [String] epJSON file name
+        #
+        def save_epjson(model_epjson, save_directory, name = 'in.epJSON')
+          epjson_filename = File.join(save_directory.to_s, name.to_s)
+          File.open(epjson_filename, 'w') do |f|
+            f << model_epjson.to_s
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+          epjson_filename
+        end
       end
     end
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -138,10 +138,10 @@ module OpenStudio
         #
         def rename_hash_keys(hash, logger)
           # @todo should we log the name changes?
-          regex = %r{[|!@#\$%^&\*\(\)\{\}\\\[\];:'",<.>/?\+=]+}
+          regex = %r{[|!@#$%^&*()\{\}\\\[\];:'",<.>/?+=]+}
 
           rename_keys = lambda do |h|
-            if Hash === h
+            if h.is_a?(Hash)
               h.each_key do |key|
                 if key.to_s =~ regex
                   logger.warn "Renaming result key '#{key}' to remove invalid characters"

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -55,7 +55,7 @@ module OpenStudio
         #
         def get_weather_file(directory, wf, wf_search_array, model, logger = nil)
           # TODO: this logic needs some updating, weather file should come from current model, found using search paths
-          logger ||= ::Logger.new(STDOUT) unless logger
+          logger ||= ::Logger.new($stdout) unless logger
           if wf
             weather_file = get_weather_file_from_fs(directory, wf, wf_search_array, logger)
             raise 'Could not locate the weather file in the filesystem. Please see the log' if weather_file == false

data/lib/openstudio/workflow/util.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/openstudio/workflow/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -37,6 +37,6 @@
 
 module OpenStudio
   module Workflow
-    VERSION = '2.1.1' # Suffixes must have periods (not dashes)
+    VERSION = '2.3.1'  # Suffixes must have periods (not dashes)
   end
 end

data/lib/openstudio/workflow_json.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -89,9 +89,7 @@ class WorkflowStepResultValue_Shim
     @type = type
   end
 
-  attr_reader :name
-
-  attr_reader :value
+  attr_reader :name, :value
 
   def variantType
     @type
@@ -162,7 +160,7 @@ class WorkflowStepResult_Shim
 
   def setStepResult(step_result)
     @result[:step_result] = step_result
- end
+  end
 end
 
 # WorkflowStep_Shim provides a shim interface to the WorkflowStep class in OpenStudio 2.X when running in OpenStudio 1.X

data/lib/openstudio/workflow_runner.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -65,14 +65,12 @@ class WorkflowRunner < OpenStudio::Ruleset::OSRunner
     ::Time.now.utc.strftime('%Y%m%dT%H%M%SZ')
   end
 
-  attr_reader :datapoint
+  attr_reader :datapoint, :analysis
 
   def setDatapoint(datapoint)
     @datapoint = datapoint
   end
 
-  attr_reader :analysis
-
   def setAnalysis(analysis)
     @analysis = analysis
   end

data/lib/openstudio-workflow.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Nicholas Long
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -29,16 +29,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +95,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: openstudio_measure_tester
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.2.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.2.14
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -157,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -179,34 +193,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-checkstyle_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
 description: Run OpenStudio based measures and simulations using EnergyPlus
 email:
 - nicholas.long@nrel.gov
@@ -260,15 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: OpenStudio Workflow Manager