openstudio-workflow 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9b4f0394bca6c06758fcaa8151bc70d06166656
-  data.tar.gz: 9052de122a97f74fd6d4aa573f31d14ee921709d
+  metadata.gz: 5ceb6100a442d5a16d724f51f956162ca46b38d6
+  data.tar.gz: aab8fbae2a4edab82eaea83f6ebd00d330339c0e
 SHA512:
-  metadata.gz: 6d946e5188f54cedf4e8d1dd8bf9f1bfc93a3443fd34623dd51abedf432162e036e9bcf86fc2f79a9cddd0a2d94d88c91e6f6ce8f5edc5afad31345dc8fac0e1
-  data.tar.gz: d42e9fafcbf20d01b4d74281861678593993263fe72f626681993e0a03ff2bca9106d26dca24ffc34cb8b5d7940c52e60c0b06ac75b5a6c68f24b50310c299a5
+  metadata.gz: a7d08630608ae324fe3b816b8af27571ee243062976c6c97780cd089670305a806ad3c81295f9ddeba84d636138c88a264557bb0f031dfd80090209b641927d2
+  data.tar.gz: 8bbab1896284b8bf7957b382932d83677576ae74208196622b56ce61b9d262ed225eec39078dff18217e5414f43da64f82ae41280eed0a49ff578acaa8130336

data/CHANGELOG.md

@@ -1,72 +1,72 @@
-OpenStudio::Workflow Change Log
-==================================
-
-Version '1.0.0-rc1' (Not released)
--------------------
-* Use specific version of OpenStudio Analysis Gem
-* Fix tests
-* Remove to_underscore method (use OpenStudio.toUnderscoreCase(...) if needed)
-
-Version '1.0.0-alpha.0'
------------------------
-* Support new workflow for PAT 2.0. Many of these changes are breaking changes
-* Remove rake from gemspec
-* Update rubyzip to version 1.2
-
-Version 0.2.0
-------------------
-* Use EnergyPlus that is packaged with OpenStudio. The branch of this repo is no longer tied to the version of EnergyPlus
-* Update find_energyplus to use new OpenStudio method instead of RUBYLIB env var
-* Update dependencies
-* Support tests running on Docker
-* Skip the PAT tests for now since they are broken
-* Remove snake_case method as it conflicts with another libraries method, now called to_underscore
-* Add test for persisting JSONs as reports. Rename reports in the form of <measure_name_underscored>_<report_name>.<ext>
-* Always add in Monthly Reports (Deprecate the :run_monthly_reports option)
-* Remove the old Standard Reports and use the version in the OpenStudio Release (along with the calibration report)
-
-Version 0.1.1
-------------------
-* Catch exception when loading a measure file.
-* Enable running simulations on windows and mac
-  * Use rubyzip gem instead of system call
-  * Fix the double directory which caused the zip files to behave strangely on windows
-  * New find_energyplus method which tries to use OpenStudio's version of EnergyPlus
-* Copy all EnergyPlus files into run directory
-* Better cleanup after EnergyPlus simulation
-* Read machine information from /etc/openstudio-server directory, if available
-
-Version 0.1.0
--------------
-* Tests for programmatically creating the analysis.json files from the OpenStudio-analysis-gem
-* Upgrade to EnergyPlus 8.2. Right now the run energyplus and run runmanager job hard code these paths.
-* Upgrade and fix Facter facts to grab the correct ip address when running on EC2
-
-Version 0.0.4
--------------
-* 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.
-* 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
---------------
-
-* Support reporting measures
-* Reduce logging messages
-* Keep IDF files
-* Remove mtr and eso files after simulation completes
-* If measure changes weather file, then use the new weather file with the analysis.json weather path
-
-Version 0.0.1
---------------
-
-* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows
+OpenStudio::Workflow Change Log
+==================================
+
+Version '1.0.0-rc1' (Not released)
+-------------------
+* Use specific version of OpenStudio Analysis Gem
+* Fix tests
+* Remove to_underscore method (use OpenStudio.toUnderscoreCase(...) if needed)
+
+Version '1.0.0-alpha.0'
+-----------------------
+* Support new workflow for PAT 2.0. Many of these changes are breaking changes
+* Remove rake from gemspec
+* Update rubyzip to version 1.2
+
+Version 0.2.0
+------------------
+* Use EnergyPlus that is packaged with OpenStudio. The branch of this repo is no longer tied to the version of EnergyPlus
+* Update find_energyplus to use new OpenStudio method instead of RUBYLIB env var
+* Update dependencies
+* Support tests running on Docker
+* Skip the PAT tests for now since they are broken
+* Remove snake_case method as it conflicts with another libraries method, now called to_underscore
+* Add test for persisting JSONs as reports. Rename reports in the form of <measure_name_underscored>_<report_name>.<ext>
+* Always add in Monthly Reports (Deprecate the :run_monthly_reports option)
+* Remove the old Standard Reports and use the version in the OpenStudio Release (along with the calibration report)
+
+Version 0.1.1
+------------------
+* Catch exception when loading a measure file.
+* Enable running simulations on windows and mac
+  * Use rubyzip gem instead of system call
+  * Fix the double directory which caused the zip files to behave strangely on windows
+  * New find_energyplus method which tries to use OpenStudio's version of EnergyPlus
+* Copy all EnergyPlus files into run directory
+* Better cleanup after EnergyPlus simulation
+* Read machine information from /etc/openstudio-server directory, if available
+
+Version 0.1.0
+-------------
+* Tests for programmatically creating the analysis.json files from the OpenStudio-analysis-gem
+* Upgrade to EnergyPlus 8.2. Right now the run energyplus and run runmanager job hard code these paths.
+* Upgrade and fix Facter facts to grab the correct ip address when running on EC2
+
+Version 0.0.4
+-------------
+* 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.
+* 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
+--------------
+
+* Support reporting measures
+* Reduce logging messages
+* Keep IDF files
+* Remove mtr and eso files after simulation completes
+* If measure changes weather file, then use the new weather file with the analysis.json weather path
+
+Version 0.0.1
+--------------
+
+* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows

data/README.md

@@ -1,48 +1,48 @@
-# OpenStudio::Workflow
-[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw)
-[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=osw&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=osw)
-
-## OpenStudio Workflow branch
-
-This branch is the development branch for the OpenStudio 2.0 workflow gem. This will become the primary branch when OpenStudio 2.0 is released.
-
-## Caveats and Todos
-
-### Todos
-
-* Find a better home for monthly_reports.idf
-* Fix issues around where standard reports and calibration reports run (and make them optional enabled)
-* Move registry into the WorkflowRunner class; this includes logging
-* Add a test to ensure that the models being returned contain alterations after apply_measure
-* Add unit tests for each util method
-* Clean up log messages (and code flow) for @current_state in run.rb
-* Define and document the complete set of options for the adapter and run classes
-* Implement better error handling with custom exception classes
-* Add a results adapter to return a string as the last call based on the source of the call. (e.g. R, command line, C++, etc).
-
-## Testing
-
-The preferred way for testing is to run rspec either natively or via docker. The issue with natively running the tests locally is the requirement to have mongo installed and running.
-
-### Locally
-
-```
-rspec spec/
-```
-
-### Docker
-
-```
-export OPENSTUDIO_VERSION=1.13.0
-docker run -v $(pwd):/var/simdata/openstudio \
-      nrel/openstudio:$OPENSTUDIO_VERSION \
-      /var/simdata/openstudio/test/bin/docker-run.sh
-```
-
-## Contributing
-
-1. Fork it ( https://github.com/NREL/OpenStudio-workflow/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+# OpenStudio::Workflow
+[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw)
+[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=osw&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=osw)
+
+## OpenStudio Workflow branch
+
+This branch is the development branch for the OpenStudio 2.0 workflow gem. This will become the primary branch when OpenStudio 2.0 is released.
+
+## Caveats and Todos
+
+### Todos
+
+* Find a better home for monthly_reports.idf
+* Fix issues around where standard reports and calibration reports run (and make them optional enabled)
+* Move registry into the WorkflowRunner class; this includes logging
+* Add a test to ensure that the models being returned contain alterations after apply_measure
+* Add unit tests for each util method
+* Clean up log messages (and code flow) for @current_state in run.rb
+* Define and document the complete set of options for the adapter and run classes
+* Implement better error handling with custom exception classes
+* Add a results adapter to return a string as the last call based on the source of the call. (e.g. R, command line, C++, etc).
+
+## Testing
+
+The preferred way for testing is to run rspec either natively or via docker. The issue with natively running the tests locally is the requirement to have mongo installed and running.
+
+### Locally
+
+```
+rspec spec/
+```
+
+### Docker
+
+```
+export OPENSTUDIO_VERSION=1.13.0
+docker run -v $(pwd):/var/simdata/openstudio \
+      nrel/openstudio:$OPENSTUDIO_VERSION \
+      /var/simdata/openstudio/test/bin/docker-run.sh
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/NREL/OpenStudio-workflow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,36 +1,36 @@
-require 'bundler'
-Bundler.setup
-
-require 'rspec/core/rake_task'
-
-# Always create spec reports
-require 'ci/reporter/rake/rspec'
-
-# Gem tasks
-require 'bundler/gem_tasks'
-
-RSpec::Core::RakeTask.new('spec:unit') do |spec|
-  spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task 'spec:unit' => 'ci:setup:rspec'
-task default: 'spec:unit'
-
-require 'rubocop/rake_task'
-desc 'Run RuboCop on the lib directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.options = ['--no-color', '--out=rubocop-results.xml']
-  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
-  task.requires = ['rubocop/formatter/checkstyle_formatter']
-  # don't abort rake on failure
-  task.fail_on_error = false
-end
-
-require 'openstudio-workflow'
-desc 'test extracting zip'
-task :test_zip do
-  f = File.join(File.dirname(__FILE__), 'spec/files/example_models/the_project.zip')
-  puts "Trying to extract #{f}"
-  OpenStudio::Workflow.extract_archive(f, 'junk_out', true)
-end
+require 'bundler'
+Bundler.setup
+
+require 'rspec/core/rake_task'
+
+# Always create spec reports
+require 'ci/reporter/rake/rspec'
+
+# Gem tasks
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new('spec:unit') do |spec|
+  spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task 'spec:unit' => 'ci:setup:rspec'
+task default: 'spec:unit'
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--no-color', '--out=rubocop-results.xml']
+  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+  task.requires = ['rubocop/formatter/checkstyle_formatter']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+require 'openstudio-workflow'
+desc 'test extracting zip'
+task :test_zip do
+  f = File.join(File.dirname(__FILE__), 'spec/files/example_models/the_project.zip')
+  puts "Trying to extract #{f}"
+  OpenStudio::Workflow.extract_archive(f, 'junk_out', true)
+end

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

@@ -1,240 +1,240 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-require 'openstudio/workflow_json'
-
-# Local file based workflow
-module OpenStudio
-  module Workflow
-    module InputAdapter
-      class Local
-        def initialize(osw_path = './workflow.osw')
-          @osw_abs_path = File.absolute_path(osw_path, Dir.pwd)
-
-          @workflow = nil
-          if File.exist? @osw_abs_path
-            @workflow = ::JSON.parse(File.read(@osw_abs_path), symbolize_names: true)
-          end
-                   
-          @workflow_json = nil
-          @run_options = nil
-          if @workflow
-            begin
-              # Create a temporary WorkflowJSON, will not be same one used in registry during simulation
-              @workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(workflow))
-              @workflow_json.setOswDir(osw_dir)
-            rescue NameError => e
-              @workflow_json = WorkflowJSON_Shim.new(workflow, osw_dir)
-            end
-            
-            begin 
-              @run_options = @workflow_json.runOptions
-            rescue
-            end
-          end
-        end
-
-        # Get the OSW file from the local filesystem
-        #
-        def workflow
-          raise "Could not read workflow from #{@osw_abs_path}" if @workflow.nil?
-          @workflow
-        end
-
-        # Get the OSW path
-        #
-        def osw_path
-          @osw_abs_path
-        end
-
-        # Get the OSW dir
-        #
-        def osw_dir
-          File.dirname(@osw_abs_path)
-        end
-
-        # Get the run dir
-        #
-        def run_dir
-          result = File.join(osw_dir, 'run')
-          if @workflow_json
-            begin
-              result = @workflow_json.absoluteRunDir.to_s
-            rescue
-            end
-          end
-          result
-        end
-        
-        def output_adapter(user_options, default, logger)
-          
-          # user option trumps all others
-          return user_options[:output_adapter] if user_options[:output_adapter]
-          
-          # try to read from OSW
-          if @run_options && !@run_options.empty?
-            custom_adapter = @run_options.get.customOutputAdapter
-            if !custom_adapter.empty?
-              begin
-                custom_file_name = custom_adapter.get.customFileName
-                class_name = custom_adapter.get.className
-                options = ::JSON.parse(custom_adapter.get.options, :symbolize_names => true)
-                
-                # merge with user options, user options will replace options loaded from OSW
-                options.merge!(user_options)
-                  
-                # stick output_directory in options
-                options[:output_directory] = run_dir
-                
-                p = @workflow_json.findFile(custom_file_name)
-                if !p.empty?
-                  load(p.get.to_s)
-                  output_adapter = eval("#{class_name}.new(options)")
-                  return output_adapter
-                else
-                  log_message = "Failed to load custom adapter file '#{custom_file_name}'"
-                  logger.error log_message
-                  raise log_message
-                end
-              rescue
-                log_message = "Failed to load custom adapter '#{class_name}' from file '#{custom_file_name}'"
-                logger.error log_message
-                raise log_message
-              end
-            end
-          end
-        
-          return default
-        end
-        
-        def jobs(user_options, default, logger)
-          
-          # user option trumps all others
-          return user_options[:jobs] if user_options[:jobs]
-
-          # try to read from OSW
-          begin
-            #log_message = "Reading custom job states from OSW is not currently supported'"
-            #logger.info log_message
-          rescue
-          end
-        
-          return default
-        end
-        
-        def debug(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:debug] if user_options[:debug]
-          
-          # try to read from OSW
-          if @run_options && !@run_options.empty?
-            return @run_options.get.debug
-          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]
-          
-          # try to read from OSW
-          if @run_options && !@run_options.empty?
-            return @run_options.get.preserveRunDir
-          end
-        
-          return default
-        end
-        
-        def cleanup(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:cleanup] if user_options[:cleanup]
-          
-          # try to read from OSW
-          if @run_options && !@run_options.empty?
-            return @run_options.get.cleanup
-          end
-        
-          return default
-        end
-        
-        def energyplus_path(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:energyplus_path] if user_options[:energyplus_path]
-        
-          return default
-        end
-        
-        def profile(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:profile] if user_options[:profile]
-        
-          return default
-        end   
-        
-        def verify_osw(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:verify_osw] if user_options[:verify_osw]
-        
-          return default
-        end   
-        
-        def weather_file(user_options, default)
-          
-          # user option trumps all others
-          return user_options[:weather_file] if user_options[:weather_file]
-          
-          # try to read from OSW
-          if !@workflow_json.weatherFile.empty?
-            return @workflow_json.weatherFile.get.to_s
-          end
-        
-          return default
-        end
-        
-        # Get the associated OSD (datapoint) file from the local filesystem
-        #
-        def datapoint
-          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
-          osd_abs_path = File.join(osw_dir, 'datapoint.osd')
-          if File.exist? osd_abs_path
-            ::JSON.parse(File.read(osd_abs_path), symbolize_names: true)
-          end
-        end
-
-        # Get the associated OSA (analysis) definition from the local filesystem
-        #
-        def analysis
-          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
-          osa_abs_path = File.join(osw_dir, '../analysis.json')
-          if File.exist? osa_abs_path
-            ::JSON.parse(File.read(osa_abs_path), symbolize_names: true)
-          end
-        end
-        
-      end
-    end
-  end
-end
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require 'openstudio/workflow_json'
+
+# Local file based workflow
+module OpenStudio
+  module Workflow
+    module InputAdapter
+      class Local
+        def initialize(osw_path = './workflow.osw')
+          @osw_abs_path = File.absolute_path(osw_path, Dir.pwd)
+
+          @workflow = nil
+          if File.exist? @osw_abs_path
+            @workflow = ::JSON.parse(File.read(@osw_abs_path), symbolize_names: true)
+          end
+                   
+          @workflow_json = nil
+          @run_options = nil
+          if @workflow
+            begin
+              # Create a temporary WorkflowJSON, will not be same one used in registry during simulation
+              @workflow_json = OpenStudio::WorkflowJSON.new(JSON.fast_generate(workflow))
+              @workflow_json.setOswDir(osw_dir)
+            rescue NameError => e
+              @workflow_json = WorkflowJSON_Shim.new(workflow, osw_dir)
+            end
+            
+            begin 
+              @run_options = @workflow_json.runOptions
+            rescue
+            end
+          end
+        end
+
+        # Get the OSW file from the local filesystem
+        #
+        def workflow
+          raise "Could not read workflow from #{@osw_abs_path}" if @workflow.nil?
+          @workflow
+        end
+
+        # Get the OSW path
+        #
+        def osw_path
+          @osw_abs_path
+        end
+
+        # Get the OSW dir
+        #
+        def osw_dir
+          File.dirname(@osw_abs_path)
+        end
+
+        # Get the run dir
+        #
+        def run_dir
+          result = File.join(osw_dir, 'run')
+          if @workflow_json
+            begin
+              result = @workflow_json.absoluteRunDir.to_s
+            rescue
+            end
+          end
+          result
+        end
+        
+        def output_adapter(user_options, default, logger)
+          
+          # user option trumps all others
+          return user_options[:output_adapter] if user_options[:output_adapter]
+          
+          # try to read from OSW
+          if @run_options && !@run_options.empty?
+            custom_adapter = @run_options.get.customOutputAdapter
+            if !custom_adapter.empty?
+              begin
+                custom_file_name = custom_adapter.get.customFileName
+                class_name = custom_adapter.get.className
+                options = ::JSON.parse(custom_adapter.get.options, :symbolize_names => true)
+                
+                # merge with user options, user options will replace options loaded from OSW
+                options.merge!(user_options)
+                  
+                # stick output_directory in options
+                options[:output_directory] = run_dir
+                
+                p = @workflow_json.findFile(custom_file_name)
+                if !p.empty?
+                  load(p.get.to_s)
+                  output_adapter = eval("#{class_name}.new(options)")
+                  return output_adapter
+                else
+                  log_message = "Failed to load custom adapter file '#{custom_file_name}'"
+                  logger.error log_message
+                  raise log_message
+                end
+              rescue
+                log_message = "Failed to load custom adapter '#{class_name}' from file '#{custom_file_name}'"
+                logger.error log_message
+                raise log_message
+              end
+            end
+          end
+        
+          return default
+        end
+        
+        def jobs(user_options, default, logger)
+          
+          # user option trumps all others
+          return user_options[:jobs] if user_options[:jobs]
+
+          # try to read from OSW
+          begin
+            #log_message = "Reading custom job states from OSW is not currently supported'"
+            #logger.info log_message
+          rescue
+          end
+        
+          return default
+        end
+        
+        def debug(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:debug] if user_options[:debug]
+          
+          # try to read from OSW
+          if @run_options && !@run_options.empty?
+            return @run_options.get.debug
+          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]
+          
+          # try to read from OSW
+          if @run_options && !@run_options.empty?
+            return @run_options.get.preserveRunDir
+          end
+        
+          return default
+        end
+        
+        def cleanup(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:cleanup] if user_options[:cleanup]
+          
+          # try to read from OSW
+          if @run_options && !@run_options.empty?
+            return @run_options.get.cleanup
+          end
+        
+          return default
+        end
+        
+        def energyplus_path(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:energyplus_path] if user_options[:energyplus_path]
+        
+          return default
+        end
+        
+        def profile(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:profile] if user_options[:profile]
+        
+          return default
+        end   
+        
+        def verify_osw(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:verify_osw] if user_options[:verify_osw]
+        
+          return default
+        end   
+        
+        def weather_file(user_options, default)
+          
+          # user option trumps all others
+          return user_options[:weather_file] if user_options[:weather_file]
+          
+          # try to read from OSW
+          if !@workflow_json.weatherFile.empty?
+            return @workflow_json.weatherFile.get.to_s
+          end
+        
+          return default
+        end
+        
+        # Get the associated OSD (datapoint) file from the local filesystem
+        #
+        def datapoint
+          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
+          osd_abs_path = File.join(osw_dir, 'datapoint.osd')
+          if File.exist? osd_abs_path
+            ::JSON.parse(File.read(osd_abs_path), symbolize_names: true)
+          end
+        end
+
+        # Get the associated OSA (analysis) definition from the local filesystem
+        #
+        def analysis
+          # DLM: should this come from the OSW?  the osd id and checksum are specified there.
+          osa_abs_path = File.join(osw_dir, '../analysis.json')
+          if File.exist? osa_abs_path
+            ::JSON.parse(File.read(osa_abs_path), symbolize_names: true)
+          end
+        end
+        
+      end
+    end
+  end
+end