openstudio-workflow 0.2.0 → 1.0.0.pat0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 859f53e5f54c14eee213cff7b0bdd7a6bc9d4c98
-  data.tar.gz: b58de6c2993630809e26a27bf735fcac371280cc
+  metadata.gz: 8358ab81f9a6e7ba628d2d890aa6b072e855fa7c
+  data.tar.gz: 775d5d17b2d109c175d3bba6037edd9b577f20a6
 SHA512:
-  metadata.gz: dcb4afd15fa0d9eecb08ee60835a87310c4dc4f8e7c3cc97d87919f6127c6c706df7074315200c054280c2cf6c84a0ce4baacebeefcc6fcdeded08a28dafdeff
-  data.tar.gz: 9fd2d0449335fb0998b936851e042f1f1957817a55e0654bf37d3168420bf5def9bdab975b180ccc381cb66f80e963f9e54b38347d93db7804ea7036f6eddce4
+  metadata.gz: e2a92837bef82dc5f6fd3cbc07bcf01d50c865c6a6ed5ac26922836c20741eb903743946836489a671e643f4cd2412d1178f440b7d9908a77304b991f2cb6813
+  data.tar.gz: de3843c61ab7cb9c575579347800196c46f822a0a2009f803e5c1c415217d92530c320f3b90584f1b2517dc7fb56a8cbb9a20ccf80c6e6ada5a3e02a4dbf6333

data/README.md

@@ -1,6 +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)
+[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/develop.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/develop)
+[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=develop&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=develop)
 [![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.
@@ -24,10 +24,6 @@ Add this line to your application's Gemfile:
 
     gem 'OpenStudio-workflow'
 
-Use this line if you want the bleeding edge:
-
-    gem 'OpenStudio-workflow', github: 'NREL/OpenStudio-workflow-gem', branch: 'EnergyPlus-8.2.0'
-
 And then execute:
     
     Mac/Linux:

data/lib/openstudio-workflow.rb

@@ -62,6 +62,8 @@ module OpenStudio
     def load(adapter_name, run_directory, options = {})
       defaults = { adapter_options: {} }
       options = defaults.merge(options)
+      # We don't have deep merge so just check for the rails_env
+      options[:adapter_options][:rails_env] = :development unless options[:adapter_options][:rails_env]
 
       # Convert various paths to absolute paths
       if options[:adapter_options] && options[:adapter_options][:mongoid_path] &&

data/lib/openstudio/extended_runner.rb

@@ -3,15 +3,26 @@ 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_accessor :past_results
   attr_reader :workflow_arguments
 
   # Add in @workflow_arguments
-  def initialize(multi_logger)
+  def initialize(multi_logger, analysis_hash, datapoint_hash)
     @multi_logger = multi_logger
+    @analysis = analysis_hash
+    @datapoint = datapoint_hash
     @workflow_arguments = nil
     super()
   end
 
+  def analysis
+    return @analysis
+  end
+
+  def datapoint
+    return @datapoint
+  end
+
   # Take the OS Argument type and map it correctly to the argument value.
   #     OPENSTUDIO_ENUM( OSArgumentType,
   #     ((Boolean)(Bool)(0))

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

@@ -41,7 +41,7 @@ module OpenStudio
 
           # how do we log within this file?
           if File.exist? "#{directory}/#{options[:datapoint_filename]}"
-            ::MultiJson.load(File.read("#{directory}/#{options[:datapoint_filename]}"), symbolize_names: true)
+            ::JSON.parse(File.read("#{directory}/#{options[:datapoint_filename]}"), symbolize_names: true)
           else
             fail "Data point file does not exist for #{directory}/#{options[:datapoint_filename]}"
           end
@@ -54,7 +54,7 @@ module OpenStudio
           options = defaults.merge(options)
 
           if File.exist? "#{directory}/#{options[:problem_filename]}"
-            ::MultiJson.load(File.read("#{directory}/#{options[:problem_filename]}"), symbolize_names: true)
+            ::JSON.parse(File.read("#{directory}/#{options[:problem_filename]}"), symbolize_names: true)
           else
             fail "Problem file does not exist for #{directory}/#{options[:problem_filename]}"
           end

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

@@ -46,7 +46,7 @@ module OpenStudio
           base_path = @options[:mongoid_path] ? @options[:mongoid_path] : "#{File.dirname(__FILE__)}/mongo"
 
           Dir["#{base_path}/models/*.rb"].each { |f| require f }
-          Mongoid.load!("#{base_path}/mongoid.yml", :development)
+          Mongoid.load!("#{base_path}/mongoid.yml", @options[:rails_env])
         end
 
         # Tell the system that the process has started

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

@@ -126,8 +126,9 @@ module OpenStudio
           begin
             require measure_file_path
             measure = Object.const_get(measure_name).new
-            runner = ExtendedRunner.new @logger
+            runner = ExtendedRunner.new(@logger, @analysis_json, @datapoint_json)
             runner.former_workflow_arguments = @workflow_arguments
+            runner.past_results = @past_results
           rescue => e
             log_message = "Error requiring measure #{__FILE__}. Failed with #{e.message}, #{e.backtrace.join("\n")}"
             raise log_message
@@ -190,6 +191,8 @@ module OpenStudio
             end
             @workflow_arguments[workflow_item[:name].to_sym] = runner.workflow_arguments
             @logger.info "Finished measure.run for '#{workflow_item[:name]}'"
+
+            # run garbage collector after every measure to help address race conditions
             GC.start
           rescue => e
             log_message = "Runner error #{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
@@ -209,6 +212,11 @@ module OpenStudio
           begin
             measure_attributes = JSON.parse(OpenStudio.toJSON(result.attributes), symbolize_names: true)
             @output_attributes[workflow_item[:name].to_sym] = measure_attributes[:attributes]
+            @past_results[workflow_item[:name].to_sym] = measure_attributes[:attributes]
+
+            # add an applicability flag to all the measure results
+            @output_attributes[workflow_item[:name].to_sym][:applicable] = result.value.value != -1
+            @past_results[workflow_item[:name].to_sym][:applicable] = result.value.value != -1
           rescue => e
             log_message = "#{__FILE__} failed with #{e.message}, #{e.backtrace.join("\n")}"
             @logger.error log_message

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

@@ -24,7 +24,7 @@ class RunEnergyplus
   # 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, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     @logger = logger
 
     energyplus_path = find_energyplus
@@ -39,6 +39,7 @@ class RunEnergyplus
     @adapter = adapter
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @results = {}
 
     # container for storing the energyplus files there were copied into the local directory. These will be
@@ -258,12 +259,6 @@ class RunEnergyplus
     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 }
@@ -275,43 +270,11 @@ class RunEnergyplus
                           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
+    # this is a workaround for issue #1699 -- remove when 1699 is closed.
+    new_objects << 'Output:Variable,*,Zone Air Temperature,Hourly;'
+    new_objects << 'Output:Variable,*,Zone Air Relative Humidity,Daily;'
+    new_objects << 'Output:Variable,*,Site Outdoor Air Drybulb Temperature,Monthly;'
+    new_objects << 'Output:Variable,*,Site Outdoor Air Wetbulb Temperature,Timestep;'
 
     if needs_sqlobj
       @logger.info 'Adding SQL Output to IDF'
@@ -323,24 +286,14 @@ class RunEnergyplus
 
     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;'

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

@@ -24,8 +24,8 @@ class RunOpenstudio
   # 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, workflow_arguments, options = {})
-    defaults = { format: 'hash', use_monthly_reports: false, analysis_root_path: '.' }
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
+    defaults = { format: 'hash', analysis_root_path: '.' }
     warn 'Option of use_monthly_reports is deprecated. Monthly reports are always generated.' if options[:use_monthly_reports]
 
     @options = defaults.merge(options)
@@ -37,6 +37,7 @@ class RunOpenstudio
     @logger = logger
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @logger.info "#{self.class} passed the following options #{@options}"
 
     # initialize instance variables that are needed in the perform section

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

@@ -27,7 +27,7 @@ class RunPostprocess
   # Mixin the MeasureApplication module to apply measures
   include OpenStudio::Workflow::ApplyMeasures
 
-  def initialize(directory, logger, time_logger, adapter, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
@@ -36,6 +36,7 @@ class RunPostprocess
     @logger = logger
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @results = {}
     @output_attributes = {}
 

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

@@ -19,7 +19,7 @@
 
 # Run Prelight job to prepare the directory for simulations.
 class RunPreflight
-  def initialize(directory, logger, time_logger, adapter, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
@@ -27,6 +27,7 @@ class RunPreflight
     @logger = logger
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @results = {}
   end
 

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

@@ -25,7 +25,7 @@ class RunReportingMeasures
   # Mixin the MeasureApplication module to apply measures
   include OpenStudio::Workflow::ApplyMeasures
 
-  def initialize(directory, logger, time_logger, adapter, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     defaults = {}
     @options = defaults.merge(options)
     @directory = directory
@@ -34,6 +34,7 @@ class RunReportingMeasures
     @logger = logger
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @results = {}
     @output_attributes = {}
 
@@ -139,7 +140,9 @@ class RunReportingMeasures
           # TODO: move this to cleaner logic. Use ostruct?
           if variable[:name].include? '.'
             k, v = variable[:name].split('.')
-            if @results.key?(k.to_sym) && @results[k.to_sym][v.to_sym]
+
+            # look for the objective function key and make sure that it is not nil. False is an okay obj function.
+            if @results.key?(k.to_sym) && !@results[k.to_sym][v.to_sym].nil?
               @objective_functions["objective_function_#{variable[:objective_function_index] + 1}"] = @results[k.to_sym][v.to_sym]
               if variable[:objective_function_target]
                 @logger.info "Found objective function target for #{variable[:name]}"
@@ -229,17 +232,24 @@ class RunReportingMeasures
       name: 'standard_reports'
     }
     @logger.info 'Running packaged Standard Reports measures'
-    apply_measure(workflow_item)
+    begin
+      apply_measure(workflow_item)
+    rescue => e
+      @logger.warn "Error applying Standard Reports measure. Failed with #{e.message}, #{e.backtrace.join("\n")} \n Continuing."
+    end
 
-    workflow_item = {
-      display_name: 'Calibration Reports',
-      measure_definition_directory: File.expand_path(File.join(OpenStudio::BCLMeasure.calibrationReportMeasure.directory.to_s, 'measure.rb')),
-      measure_definition_class_name: 'CalibrationReports',
-      measure_type: 'CalibrationReports',
-      name: 'calibration_reports'
-    }
-    @logger.info 'Running packaged Calibration Reports measures'
-    apply_measure(workflow_item)
+    @logger.info "Found #{@model.getUtilityBills.length} utility bills"
+    if @model.getUtilityBills.length > 0
+      workflow_item = {
+        display_name: 'Calibration Reports',
+        measure_definition_directory: File.expand_path(File.join(OpenStudio::BCLMeasure.calibrationReportMeasure.directory.to_s, 'measure.rb')),
+        measure_definition_class_name: 'CalibrationReports',
+        measure_type: 'CalibrationReports',
+        name: 'calibration_reports'
+      }
+      @logger.info 'Running packaged Calibration Reports measures'
+      apply_measure(workflow_item)
+    end
 
     @logger.info 'Finished Running Packaged Measures'
   end

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

@@ -27,7 +27,7 @@ class RunRunmanager
   # 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, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     @logger = logger
 
     energyplus_path = find_energyplus
@@ -46,6 +46,7 @@ class RunRunmanager
     @logger.info "#{self.class} passed the following options #{@options}"
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
 
     # initialize instance variables that are needed in the perform section
     @model = nil

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

@@ -22,7 +22,7 @@ require 'libxml'
 # This actually belongs as another class that gets added as a state dynamically
 class RunXml
   # RunXml
-  def initialize(directory, logger, time_logger, adapter, workflow_arguments, options = {})
+  def initialize(directory, logger, time_logger, adapter, workflow_arguments, past_results, options = {})
     defaults = { analysis_root_path: '.', xml_library_file: 'xml_runner.rb' }
     @options = defaults.merge(options)
     @directory = directory
@@ -33,6 +33,7 @@ class RunXml
     @logger = logger
     @time_logger = time_logger
     @workflow_arguments = workflow_arguments
+    @past_results = past_results
     @logger.info "#{self.class} passed the following options #{@options}"
 
     # initialize instance variables that are needed in the perform section

data/lib/openstudio/workflow/run.rb

@@ -95,6 +95,7 @@ module OpenStudio
         @directory = directory
         @time_logger = TimeLogger.new
         @workflow_arguments = {}
+        @past_results = {}
         # TODO: run directory is a convention right now. Move to a configuration item
         @run_directory = "#{@directory}/run"
 
@@ -310,7 +311,7 @@ module OpenStudio
         require_relative "jobs/#{from_method}/#{from_method}"
         klass_name = from_method.to_s.split('_').map(&:capitalize) * ''
         @logger.info "Getting method for state transition '#{from_method}'"
-        klass = Object.const_get(klass_name).new(@directory, @logger, @time_logger, @adapter, @workflow_arguments, get_job_options)
+        klass = Object.const_get(klass_name).new(@directory, @logger, @time_logger, @adapter, @workflow_arguments, @past_results, get_job_options)
         klass
       end
     end

data/lib/openstudio/workflow/version.rb

@@ -19,6 +19,6 @@
 
 module OpenStudio
   module Workflow
-    VERSION = '0.2.0'
+    VERSION = '1.0.0.pat0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0.pat0
 platform: ruby
 authors:
 - Nicholas Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 1.2.0
 description: Run OpenStudio based simulations using EnergyPlus
 email:
 - nicholas.long@nrel.gov
@@ -115,6 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/openstudio-workflow.rb
 - lib/openstudio/extended_runner.rb
 - lib/openstudio/workflow/adapter.rb
 - lib/openstudio/workflow/adapters/local.rb
@@ -132,10 +136,6 @@ files:
 - lib/openstudio/workflow/run.rb
 - lib/openstudio/workflow/time_logger.rb
 - lib/openstudio/workflow/version.rb
-- lib/openstudio-workflow.rb
-- README.md
-- CHANGELOG.md
-- Rakefile
 homepage: https://github.com/NREL/OpenStudio-workflow-gem
 licenses:
 - LGPL
@@ -151,12 +151,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Workflow Manager