openstudio-workflow 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e81fcf5450aa2cf5f13bc03f0a253f14b95d74e9
-  data.tar.gz: 90a64f53393b213e23b9961a3096895de4fe4f4b
+  metadata.gz: 859f53e5f54c14eee213cff7b0bdd7a6bc9d4c98
+  data.tar.gz: b58de6c2993630809e26a27bf735fcac371280cc
 SHA512:
-  metadata.gz: 6d95bdac9f31a85775003125291db53cabf63be1bf2a054fe79def4a1281f05f422b68cd23d4cc2f37132d286288ed0cdcf610b790ea7c92103f42ae20499dd2
-  data.tar.gz: 22491f3a0392364381028ef6287cf0dc2a4a837388da2a62013caa981799cb797f98a2150176b05b6055f87fb350230609e99c95c7ca7ccfc301435111758636
+  metadata.gz: dcb4afd15fa0d9eecb08ee60835a87310c4dc4f8e7c3cc97d87919f6127c6c706df7074315200c054280c2cf6c84a0ce4baacebeefcc6fcdeded08a28dafdeff
+  data.tar.gz: 9fd2d0449335fb0998b936851e042f1f1957817a55e0654bf37d3168420bf5def9bdab975b180ccc381cb66f80e963f9e54b38347d93db7804ea7036f6eddce4

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 OpenStudio::Workflow Change Log
 ==================================
 
+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.
@@ -12,7 +24,6 @@ Version 0.1.1
 * 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

data/README.md

@@ -1,4 +1,6 @@
 # OpenStudio::Workflow
+[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/EnergyPlus-8.3.0.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/EnergyPlus-8.3.0)
+[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=EnergyPlus-8.3.0&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=EnergyPlus-8.3.0)
 [![Dependency Status](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e)
 
 Run an EnergyPlus simulation using a file-based workflow that is read from a Local or MongoDB adapter.
@@ -9,7 +11,7 @@ The OpenStudio Workflow Gem has the following dependencies:
 
 * Ruby 2.0
 * OpenStudio with Ruby 2.0 bindings
-* EnergyPlus 8.2 (assuming OpenStudio >= 1.5.4)
+* EnergyPlus 8.3 (assuming OpenStudio >= 1.7.2)
 * MongoDB if using MongoDB Adapter (or when running rspec)
 
 [OpenStudio](http://developer.nrel.gov/downloads/buildings/openstudio/builds/) needs to be installed
@@ -58,40 +60,40 @@ The workflow manager can also use MongoDB to receive instructions on the workflo
 
 ## Caveats and Todos
 
-### Caveats
-
-* There are currently several hard coded workflow options
-* Must use OpenStudio with Ruby 2.0 support
-* Using MongoDB as the Adapter requires a command line zip (gnuzip) utility
-
 ### Todos
 
 * Read the analysis.json file to determine the states that are going to run instead of (or in addition to) passing them into the constructor
 * Implement better error handling with custom exception classes
-* ~Implement a different measure directory, seed model directory, and weather file directory option~
-* ~Dynamically add other "states" to the workflow~
-* ~~Create and change into a unique directory when running measures~~
-* ~~Implement Error State~~
-* ~~Implement MongoDB Adapter~~
-* ~~Implement remaining Adapter states (i.e. communicate success, communicate failure etc~~
 * 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).
 * Implement a logger in the Adapters, right now they are unable to log
-* Hook up the measure groups based workflows
-* ~~Add xml workflow item~~
+* Hook up the measure group based workflows
 
-## Testing and Development
+## Testing
 
-Depending on what adapter is being tested it may be preferable to skip installing various gems.  This can be done by calling
+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.
 
-    bundle install --without mongo
+### Locally
 
-On Windows it is recommended to bundle without mongo nor ci as they may require native extensions.
+```
+rake
+```
 
-    bundle install --without mongo ci
+### Docker
 
-### Testing
+To run all the tests automatically run:
+```
+docker run --rm -v $(pwd):/var/simdata/openstudio nrel/docker-test-containers:openstudio-1.8.5-mongo-2.4 /var/simdata/openstudio/test/bin/docker-run.sh
+```
 
-Run `rspec` or `rake` to execute the tests.
+To run the tests inside docker and enable debugging, then create a bash shell in docker with:
+```
+docker run -it --rm -v $(pwd):/var/simdata/openstudio nrel/docker-test-containers:openstudio-1.8.5-mongo-2.4 bash
+service mongodb start
+bundle update
+rake 
+# or
+bundle exec rspec <file>:<line>
+```
 
 ## Contributing
 
@@ -100,44 +102,3 @@ Run `rspec` or `rake` to execute the tests.
 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
-
-## Development
-
-If you are testing changes to OpenStudio source code and want to test these on the Vagrant machine you can use the source configuration.  This creates a new virtual machine which can be accessed by adding the name 'source' to the end of standard Vagrant commands.  To set up this machine, build a custom version of OpenStudio, and install that version for testing follow these steps:
-
-* vagrant up source
-* vagrant ssh source
-* sudo apt-get install dpkg-dev git cmake-curses-gui qt5-default libqt5webkit5-dev libboost1.55-all-dev swig ruby2.0 libssl-dev libxt-dev doxygen graphviz
-* sudo ln -s /usr/lib/x86_64-linux-gnu/libruby-2.0.so.2.0.0 /usr/lib/x86_64-linux-gnu/libruby.so.2.0
-** Install clang (OPTIONAL):
-** wget -O - http://llvm.org/apt/llvm-snapshot.gpg.key|sudo apt-key add -
-** sudo apt-add-repository 'deb http://llvm.org/apt/trusty/ llvm-toolchain-trusty-3.5 main'
-** sudo apt-get update
-** sudo apt-get install clang-3.5 
-** echo 'export CC=/usr/bin/clang-3.5' >> ~/.bashrc
-** echo 'export CXX=/usr/bin/clang++-3.5' >> ~/.bashrc
-** source ~/.bashrc
-* cd /home/vagrant
-* git clone https://github.com/NREL/OpenStudio.git openstudio
-* cd openstudio
-* git checkout your_branch_name
-* mkdir build
-* cd build
-* cmake .. -DBUILD_PACKAGE=TRUE -DCMAKE_INSTALL_PREFIX=$OPENSTUDIO_ROOT -DRUBY_EXECUTABLE=/usr/local/rbenv/versions/2.0.0-p481/bin/ruby
-* make -j4
-
-To install do either:
-* cd OpenStudioCore-prefix/src/OpenStudioCore-build/
-* sudo make install
-
-or:
-* make package
-* sudo ./OpenStudio-1.5.1.02b7131b4c-Linux.sh --prefix=/usr/local --exclude-subdir --skip-license
-
-Next you have to do this:
-* export RUBYLIB=/usr/local/Ruby
-* export LD_LIBRARY_PATH=/usr/local/lib
-
-Then you can test that you are using your build by comparing the output of these two commands:
-* ruby -e "require 'openstudio'" -e "puts OpenStudio::openStudioLongVersion"
-* git rev-parse --short HEAD

data/lib/openstudio/extended_runner.rb

@@ -0,0 +1,94 @@
+# Extend OS Runner to persist measure information throughout the workflow
+class ExtendedRunner < OpenStudio::Ruleset::OSRunner
+  # Allow former arguments to be set and read
+  # TODO: Consider having the former arguments passed in in initialization, and define as attr_reader
+  attr_accessor :former_workflow_arguments
+  attr_reader :workflow_arguments
+
+  # Add in @workflow_arguments
+  def initialize(multi_logger)
+    @multi_logger = multi_logger
+    @workflow_arguments = nil
+    super()
+  end
+
+  # Take the OS Argument type and map it correctly to the argument value.
+  #     OPENSTUDIO_ENUM( OSArgumentType,
+  #     ((Boolean)(Bool)(0))
+  #     ((Double)(Double)(1))
+  #     ((Quantity)(Quantity)(2))
+  #     ((Integer)(Int)(3))
+  #     ((String)(String)(4))
+  #     ((Choice)(Choice)(5))
+  #     ((Path)(Path)(6))
+  #     );
+  # @param os_argument_name [String] The string of the argument to check
+  # @param user_arguments [OSArgumentMap] Map of the arguments to check
+  def bad_os_typecasting(os_argument_name, user_arguments)
+    out = nil
+    user_arguments.each do |arg_name, arg|
+      # get the type cast value
+      next unless os_argument_name == arg_name
+
+      case arg.type.valueName
+        when 'Boolean'
+          out = arg.valueAsBool if arg.hasValue
+        when 'Double'
+          out = arg.valueAsDouble if arg.hasValue
+        when 'Quantity'
+          warn 'This OpenStudio Argument Type is deprecated'
+        when 'Integer'
+          out = arg.valueAsInteger if arg.hasValue
+        when 'String'
+          out = arg.valueAsString if arg.hasValue
+        when 'Choice'
+          out = arg.valueAsString if arg.hasValue
+        when 'Path'
+          out = arg.valueAsPath.to_s if arg.hasValue
+      end
+    end
+
+    out
+  end
+
+  # Overloaded argument parsing
+  def validateUserArguments(script_arguments, user_arguments)
+    @workflow_arguments = {}
+    user_arguments.each do |hash|
+      value = bad_os_typecasting(hash, user_arguments)
+      @workflow_arguments[hash.to_sym] = value if value
+    end
+
+    super
+  end
+
+  # Overload registerInfo
+  def registerInfo(message)
+    super
+    @multi_logger.info message
+  end
+
+  # Overload registerInfo
+  def registerWarning(message)
+    super
+    @multi_logger.warn message
+  end
+
+  # Overload registerError
+  def registerError(message)
+    super
+    @multi_logger.error message
+  end
+
+  # Overload registerInitialCondition
+  def registerInitialCondition(message)
+    super
+    @multi_logger.info message
+  end
+
+  # Overload registerFinalCondition
+  def registerFinalCondition(message)
+    super
+    @multi_logger.info message
+  end
+end

data/lib/openstudio/workflow/adapter.rb

@@ -90,10 +90,20 @@ module OpenStudio
               if File.basename(file) =~ /seed|measures|weather/
                 next
               end
+              # skip x-large directory
+              if File.size?(file)
+                next if File.size?(file) >= 15000000
+              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) >= 15000000
+                  next unless File.extname(file) == '.osm' || File.extname(file) == '.idf'
+                end
+              end
 
               zip_file_to_add = file.gsub("#{directory}/", '')
               zf.add(zip_file_to_add, file)

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.delete("\n")
           @dp.save!
         end
       end

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

@@ -126,7 +126,8 @@ module OpenStudio
           begin
             require measure_file_path
             measure = Object.const_get(measure_name).new
-            runner = OpenStudio::Ruleset::OSRunner.new
+            runner = ExtendedRunner.new @logger
+            runner.former_workflow_arguments = @workflow_arguments
           rescue => e
             log_message = "Error requiring measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
             raise log_message
@@ -143,12 +144,12 @@ module OpenStudio
               arguments = measure.arguments
             end
 
-            @logger.info "Extracted the following arguments: #{arguments}"
-
             # Create argument map and initialize all the arguments
             argument_map = OpenStudio::Ruleset::OSArgumentMap.new
-            arguments.each do |v|
-              argument_map[v.name] = v.clone
+            if arguments
+              arguments.each do |v|
+                argument_map[v.name] = v.clone
+              end
             end
             # @logger.info "Argument map for measure is #{argument_map}"
 
@@ -177,15 +178,19 @@ module OpenStudio
             if workflow_item[:measure_type] == 'RubyMeasure'
               measure.run(@model, runner, argument_map)
             elsif workflow_item[:measure_type] == 'EnergyPlusMeasure'
+              runner.setLastOpenStudioModel(@model)
               measure.run(@model_idf, runner, argument_map)
             elsif workflow_item[:measure_type] == 'ReportingMeasure'
-              # This is silly, set the last model and last sqlfile instead of passing it into the measure.run method
+              # This is silly, set the last model, last IDF, and last sqlfile instead of passing it into the measure.run method
               runner.setLastOpenStudioModel(@model)
+              runner.setLastEnergyPlusWorkspace(@model_idf)
               runner.setLastEnergyPlusSqlFilePath(@sql_filename)
 
               measure.run(runner, argument_map)
             end
+            @workflow_arguments[workflow_item[:name].to_sym] = runner.workflow_arguments
             @logger.info "Finished measure.run for '#{workflow_item[:name]}'"
+            GC.start
           rescue => e
             log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
             raise log_message
@@ -195,17 +200,7 @@ module OpenStudio
             result = runner.result
             @logger.info "Running of measure '#{workflow_item[:name]}' completed. Post-processing measure output"
 
-            @logger.info result.initialCondition.get.logMessage unless result.initialCondition.empty?
-            @logger.info result.finalCondition.get.logMessage unless result.finalCondition.empty?
-
-            result.warnings.each { |w| @logger.warn w.logMessage }
-            an_error = false
-            result.errors.each do |w|
-              @logger.error w.logMessage
-              an_error = true
-            end
-            fail "Measure #{measure_name} reported an error, check log" if an_error
-            result.info.each { |w| @logger.info w.logMessage }
+            fail "Measure #{measure_name} reported an error, check log" if result.errors.size != 0
           rescue => e
             log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
             raise log_message

data/lib/openstudio/workflow/jobs/{run_openstudio → run_energyplus}/monthly_report.idf

@@ -29,6 +29,7 @@ Output:Table:Monthly,
     SumOrAverage,            !- Aggregation Type for Variable or Meter 13
     Refrigeration:Electricity,!- Variable or Meter 14 Name
     SumOrAverage;            !- Aggregation Type for Variable or Meter 14
+
 Output:Table:Monthly,
   Building Energy Performance - Natural Gas,  !- Name
     2,                       !- Digits After Decimal
@@ -44,6 +45,7 @@ Output:Table:Monthly,
     SumOrAverage,            !- Aggregation Type for Variable or Meter 5
     Cogeneration:Gas,        !- Variable or Meter 6 Name
     SumOrAverage;            !- Aggregation Type for Variable or Meter 6
+
 Output:Table:Monthly,
   Building Energy Performance - District Heating,  !- Name
     2,                       !- Digits After Decimal
@@ -73,6 +75,7 @@ Output:Table:Monthly,
     SumOrAverage,            !- Aggregation Type for Variable or Meter 12
     Cogeneration:DistrictHeating,!- Variable or Meter 13 Name
     SumOrAverage;            !- Aggregation Type for Variable or Meter 13
+
 Output:Table:Monthly,
   Building Energy Performance - District Cooling,  !- Name
     2,                       !- Digits After Decimal
@@ -102,6 +105,7 @@ Output:Table:Monthly,
     SumOrAverage,            !- Aggregation Type for Variable or Meter 12
     Cogeneration:DistrictCooling,!- Variable or Meter 13 Name
     SumOrAverage;            !- Aggregation Type for Variable or Meter 13
+
 Output:Table:Monthly,
   Building Energy Performance - Electricity Peak Demand,  !- Name
     2,                       !- Digits After Decimal
@@ -133,6 +137,7 @@ Output:Table:Monthly,
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 12
     Cogeneration:Electricity,!- Variable or Meter 13 Name
     ValueWhenMaximumOrMinimum;            !- Aggregation Type for Variable or Meter 13
+
 Output:Table:Monthly,
   Building Energy Performance - Natural Gas Peak Demand,  !- Name
     2,                       !- Digits After Decimal
@@ -150,6 +155,7 @@ Output:Table:Monthly,
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 5
     Cogeneration:Gas,        !- Variable or Meter 6 Name
     ValueWhenMaximumOrMinimum;            !- Aggregation Type for Variable or Meter 6
+
 Output:Table:Monthly,
   Building Energy Performance - District Heating Peak Demand,  !- Name
     2,                       !- Digits After Decimal
@@ -181,6 +187,7 @@ Output:Table:Monthly,
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 12
     Cogeneration:DistrictHeating,!- Variable or Meter 13 Name
     ValueWhenMaximumOrMinimum;            !- Aggregation Type for Variable or Meter 13
+
 Output:Table:Monthly,
   Building Energy Performance - District Cooling Peak Demand,  !- Name
     2,                       !- Digits After Decimal
@@ -212,7 +219,4 @@ Output:Table:Monthly,
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 12
     Cogeneration:DistrictCooling,!- Variable or Meter 13 Name
     ValueWhenMaximumOrMinimum;            !- Aggregation Type for Variable or Meter 13
-    Output:Meter,Electricity:Facility,Timestep; !- [J]
-    Output:Meter,Gas:Facility,Timestep; !- [J]
-    Output:Meter,DistrictCooling:Facility,Timestep; !- [J]
-    Output:Meter,DistrictHeating:Facility,Timestep; !- [J]
+

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

@@ -17,16 +17,14 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-# Force the MakeMakefile logger write file output to null.
-module MakeMakefile::Logging
-  @logfile = File::NULL
-end
-
 class RunEnergyplus
+  ENERGYPLUS_REGEX = /^energyplus\D{0,4}$/i
+  EXPAND_OBJECTS_REGEX = /^expandobjects\D{0,4}$/i
+
   # Initialize
   # param directory: base directory where the simulation files are prepared
   # param logger: logger object in which to write log messages
-  def initialize(directory, logger, time_logger, adapter, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, options = {})
     @logger = logger
 
     energyplus_path = find_energyplus
@@ -40,6 +38,7 @@ class RunEnergyplus
     @run_directory = "#{@directory}/run"
     @adapter = adapter
     @time_logger = time_logger
+    @workflow_arguments = workflow_arguments
     @results = {}
 
     # container for storing the energyplus files there were copied into the local directory. These will be
@@ -108,6 +107,10 @@ class RunEnergyplus
     prepare_energyplus_dir
     @time_logger.stop('Copying EnergyPlus files')
 
+    @time_logger.start('Running EnergyPlus Preprocess Script')
+    energyplus_preprocess("#{@run_directory}/in.idf")
+    @time_logger.start('Running EnergyPlus Preprocess Script')
+
     @time_logger.start('Running EnergyPlus')
     @results = call_energyplus
     @time_logger.stop('Running EnergyPlus')
@@ -117,24 +120,27 @@ class RunEnergyplus
 
   private
 
-  # Look for the location of EnergyPlus
   def find_energyplus
     if ENV['ENERGYPLUSDIR']
       return ENV['ENERGYPLUSDIR']
+      # TODO: check if method exists! first
+    elsif OpenStudio.respond_to? :getEnergyPlusDirectory
+      return OpenStudio.getEnergyPlusDirectory.to_s
     elsif ENV['RUBYLIB'] =~ /OpenStudio/
+      warn 'Finding EnergyPlus by RUBYLIB parsing will not be supported in the near future. Use either ENERGYPLUSDIR'\
+           'env variable or a newer OpenStudio version that has the getEnergyPlusDirectory method'
       path = ENV['RUBYLIB'].split(':')
       path = File.dirname(path.find { |p| p =~ /OpenStudio/ })
       # Grab the version out of the openstudio path
-      path += '/sharedresources/EnergyPlus-8-2-0'
-      @logger.info "found EnergyPlus path of #{path}"
+      path += '/sharedresources/EnergyPlus-8-3-0'
+
       return path
     else
       if /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
-        energyplus_path = 'C:/EnergyPlus-8-2-0'
+        return 'C:/EnergyPlus-8-3-0'
       else
-        energyplus_path = '/usr/local/EnergyPlus-8-2-0'
+        return '/usr/local/EnergyPlus-8-3-0'
       end
-
     end
   end
 
@@ -164,13 +170,13 @@ class RunEnergyplus
       dest_file = "#{@run_directory}/#{File.basename(file)}"
       @energyplus_files << dest_file
 
-      @energyplus_exe = File.basename(dest_file) if File.basename(dest_file) =~ /^energyplus.{0,4}$/i
-      @expand_objects_exe = File.basename(dest_file) if File.basename(dest_file) =~ /^ExpandObjects.{0,4}$/i
+      @energyplus_exe = File.basename(dest_file) if File.basename(dest_file) =~ ENERGYPLUS_REGEX
+      @expand_objects_exe = File.basename(dest_file) if File.basename(dest_file) =~ EXPAND_OBJECTS_REGEX
       FileUtils.copy file, dest_file
     end
 
-    fail "Could not find EnergyPlus Executable in #{@options[:energyplus_path]}" unless @energyplus_exe
-    fail "Could not find ExpandObjects Executable in #{@options[:energyplus_path]}" unless @expand_objects_exe
+    fail "Could not find EnergyPlus executable in #{@options[:energyplus_path]}" unless @energyplus_exe
+    fail "Could not find ExpandObjects executable in #{@options[:energyplus_path]}" unless @expand_objects_exe
 
     @energyplus_files.size > 0
   end
@@ -181,11 +187,6 @@ class RunEnergyplus
       Dir.chdir(@run_directory)
       @logger.info "Starting simulation in run directory: #{Dir.pwd}"
 
-      # @logger.info "Contents of: #{Dir.pwd}"
-      # Dir.glob("*").each do |f|
-      #  @logger.info "  #{f}"
-      # end
-
       File.open('stdout-expandobject', 'w') do |file|
         IO.popen("./#{@expand_objects_exe}") do |io|
           while (line = io.gets)
@@ -247,4 +248,114 @@ class RunEnergyplus
 
     {}
   end
+
+  # Run this code before running energyplus to make sure the reporting variables are setup correctly
+  def energyplus_preprocess(idf_filename)
+    @logger.info 'Running EnergyPlus Preprocess'
+
+    fail "Could not find IDF file in run directory (#{idf_filename})" unless File.exist? idf_filename
+
+    new_objects = []
+    needs_monthlyoutput = false
+
+    # this is a workaround for OpenStudio issue #1699
+    needs_detailedvariable = false
+    needs_hourlyvariable = false
+    needs_dailyvariable = false
+    needs_runperiodvariable = false
+
+    idf = OpenStudio::IdfFile.load(idf_filename).get
+    # save the pre-preprocess file
+    File.open("#{File.dirname(idf_filename)}/pre-preprocess.idf", 'w') { |f| f << idf.to_s }
+
+    needs_sqlobj = idf.getObjectsByType('Output:SQLite'.to_IddObjectType).empty?
+
+    needs_monthlyoutput = idf.getObjectsByName('Building Energy Performance - Natural Gas').empty? ||
+                          idf.getObjectsByName('Building Energy Performance - Electricity').empty? ||
+                          idf.getObjectsByName('Building Energy Performance - District Heating').empty? ||
+                          idf.getObjectsByName('Building Energy Performance - District Cooling').empty?
+
+    # this is a workaround for issue #1699 -- get all the meter requests
+    meters = []
+    meters += idf.getObjectsByType('Output:Meter'.to_IddObjectType) unless idf.getObjectsByType('Output:Meter'.to_IddObjectType).empty?
+    meters += idf.getObjectsByType('Output:Meter:MeterFileOnly'.to_IddObjectType) unless idf.getObjectsByType('Output:Meter:MeterFileOnly'.to_IddObjectType).empty?
+    meters += idf.getObjectsByType('Output:Meter:Cumulative'.to_IddObjectType) unless idf.getObjectsByType('Output:Meter:Cumulative'.to_IddObjectType).empty?
+    meters += idf.getObjectsByType('Output:Meter:Cumulative:MeterFileOnly'.to_IddObjectType) unless idf.getObjectsByType('Output:Meter:Cumulative:MeterFileOnly'.to_IddObjectType).empty?
+
+    # go through each meter and check the reporting frequency
+    meters.each do |meter|
+      reporting_frequency = meter.getString(1, true)
+      if reporting_frequency =~ /detailed/i
+        needs_detailedvariable = true
+      elsif reporting_frequency =~ /hourly/i
+        needs_hourlyvariable = true
+      elsif reporting_frequency =~ /daily/i
+        needs_dailyvariable = true
+      elsif reporting_frequency =~ /monthly/i
+        needs_monthlyvariable = true
+      elsif reporting_frequency =~ /runperiod|environment|annual/i
+        needs_runperiodvariable = true
+      end
+    end
+
+    # turn off the requests if the meter is already a variable
+    variables = idf.getObjectsByType('Output:Variable'.to_IddObjectType)
+    variables.each do |variable|
+      reporting_frequency = variable.getString(2, true)
+      if reporting_frequency =~ /detailed/i
+        needs_detailedvariable = false
+      elsif reporting_frequency =~ /hourly/i
+        needs_hourlyvariable = false
+      elsif reporting_frequency =~ /daily/i
+        needs_dailyvariable = false
+      elsif reporting_frequency =~ /runperiod|environment|annual/i
+        needs_runperiodvariable = false
+      end
+    end
+
+    if needs_sqlobj
+      @logger.info 'Adding SQL Output to IDF'
+      new_objects << '
+        Output:SQLite,
+        SimpleAndTabular;         ! Option Type
+        '
+    end
+
+    if needs_monthlyoutput
+      monthly_report_idf = File.join(File.dirname(__FILE__), 'monthly_report.idf')
+
+      idf_file = OpenStudio::IdfFile.load(File.read(monthly_report_idf), 'EnergyPlus'.to_IddFileType).get
+      idf.addObjects(idf_file.objects)
+    end
+
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Detailed;' if needs_detailedvariable
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Hourly;' if needs_hourlyvariable
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Daily;' if needs_dailyvariable
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,RunPeriod;' if needs_runperiodvariable
+
+    # These are supposedly needed for the calibration report
+    new_objects << 'Output:Meter:MeterFileOnly,Gas:Facility,Daily;'
+    new_objects << 'Output:Meter:MeterFileOnly,Electricity:Facility,Timestep;'
+    new_objects << 'Output:Meter:MeterFileOnly,Electricity:Facility,Daily;'
+    new_objects << 'Output:Variable,*,Zone Air Temperature,Hourly;'
+    new_objects << 'Output:Variable,*,Zone Air Relative Humidity,Hourly;'
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Monthly;'
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Timestep;'
+
+    # Always add in the timestep facility meters
+    new_objects << 'Output:Meter,Electricity:Facility,Timestep;'
+    new_objects << 'Output:Meter,Gas:Facility,Timestep;'
+    new_objects << 'Output:Meter,DistrictCooling:Facility,Timestep;'
+    new_objects << 'Output:Meter,DistrictHeating:Facility,Timestep;'
+
+    new_objects.each do |obj|
+      object = OpenStudio::IdfObject.load(obj).get
+      idf.addObject(object)
+    end
+
+    # save the file
+    File.open(idf_filename, 'w') { |f| f << idf.to_s }
+
+    @logger.info 'Finished EnergyPlus Preprocess'
+  end
 end