openstudio-workflow 1.3.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb02ff2b9ba68076ad3bd7bdd0b07a790db0a90e
-  data.tar.gz: 84f8b7b245040cbef4aae3b45a5b2fe973f0ace8
+SHA256:
+  metadata.gz: c632f0a2834a490fbd25b21ef3f17ff07d77e08bdf76db7d1737a2843665d2b6
+  data.tar.gz: 6ac3e3165ddac8de85d5a364878e4ae18089a9b7c2171b9bf2341cd1c4c9438e
 SHA512:
-  metadata.gz: 466afdf8aaea899d0567f97c1df7674b5a80af09ebc3044410cc3f6a752952e3d65fc9c281aea0480bdfdc13b239819ed4eab4e5d251d194f915929131741e4b
-  data.tar.gz: 7c8f671a81404622f1257077cd24bfd77ab405efe4ec1d6fc8fe45688ed9905509005d27f55658dedecbc46be020c695ac41bc18431be7a22e355775499a6bc3
+  metadata.gz: e274ab7d2787530a70ea4b5f17859640597044b72ec0c62a5b1c35dd459b7e013fe248e8454526998ed66ec22750a4fc02831a30314cf50639717f608b11fa8f
+  data.tar.gz: 830be90f370e3f1290c3dddeeaa63c6e1b7d7f9b4bb7e64747ac04fbf44bd3e89b2f07d11683249aa19600dd331095a87694c55f1bc9fa9102d93bd65bb05071

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 OpenStudio::Workflow Change Log
 ==================================
 
+Version 2.1.1
+-------------
+* Add support for URBANopt Workflow
+* Update reporting measure in tests
+
+Version 2.1.0
+-------------
+* Support for EnergyPlus 9.4. This version will not work with prior versions of EnergyPlus.
+* Add warning when paths are not relative
+
+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
 -------------
 

data/README.md

@@ -4,30 +4,30 @@
 
 ## OpenStudio Workflow Gem
 
-This branch is the development branch for the OpenStudio workflow gem. 
+This branch is the development branch for the OpenStudio workflow gem.
 ## Installation
 
 The OpenStudio Workflow Gem has the following dependencies:
 
-* Ruby 2.2.4
-* OpenStudio 2.x
+* Ruby 2.5.5
+* OpenStudio 3.x
 
-[OpenStudio](http://developer.nrel.gov/downloads/buildings/openstudio/builds/) 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 2.9.1 installed:
+[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:
 
-    export RUBYLIB=/usr/local/openstudio-2.9.1/Ruby
+    export RUBYLIB=/usr/local/openstudio-3.0.0/Ruby
 
 Add this line to your application's Gemfile:
 
     gem 'OpenStudio-workflow'
 
 And then execute:
-    
+
     bundle install
-        
+
 Or install it yourself as:
-    
+
     $ gem install openstudio-workflow
-    
+
 ## Usage
 
 There are currently two adapters to run OpenStudio workflow. The first is a simple Local adapter allowing the user to pass in the directory to simulation. The directory must have an [analysis/problem JSON file](spec/files/local_ex1/analysis_1.json) and a [datapoint JSON file](spec/files/local_ex1/datapoint_1.json).
@@ -52,7 +52,7 @@ rspec spec/
 ### Docker
 
 ```
-export OPENSTUDIO_VERSION=2.9.1
+export OPENSTUDIO_VERSION=3.0.0
 docker run -v $(pwd):/var/simdata/openstudio \
       nrel/openstudio:$OPENSTUDIO_VERSION \
       /var/simdata/openstudio/test/bin/docker-run.sh

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler.setup
 
@@ -34,3 +36,14 @@ task :test_zip do
   puts "Trying to extract #{f}"
   OpenStudio::Workflow.extract_archive(f, 'junk_out', true)
 end
+
+desc 'Transition IDF Files'
+task :transition_idf do
+  lst_path = File.join(Dir.pwd, 'IdfFilesToTransition.lst')
+  File.open(lst_path, 'w') do |file|
+    Dir.glob('**/*.idf').each do |idf|
+      file.puts(File.join(Dir.pwd, idf))
+    end
+  end
+  puts "Use the IDFVersionUpdater and point it to #{lst_path}"
+end

data/lib/openstudio-workflow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -77,6 +79,7 @@ module OpenStudio
         #
         def workflow
           raise "Could not read workflow from #{@osw_abs_path}" if @workflow.nil?
+
           @workflow
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -42,6 +44,7 @@ module OpenStudio
       class Local < OutputAdapters
         def initialize(options = {})
           raise 'The required :output_directory option was not passed to the local output adapter' unless options[:output_directory]
+
           super
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -109,6 +111,7 @@ 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
@@ -117,6 +120,7 @@ module OpenStudio
           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

data/lib/openstudio/workflow/job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/openstudio/workflow/jobs/resources/monthly_report.idf

@@ -1,3 +1,5 @@
+Version,9.4;
+
 Output:Table:Monthly,
   Building Energy Performance - Electricity,  !- Name
     2,                       !- Digits After Decimal
@@ -33,17 +35,17 @@ Output:Table:Monthly,
 Output:Table:Monthly,
   Building Energy Performance - Natural Gas,  !- Name
     2,                       !- Digits After Decimal
-    InteriorEquipment:Gas,   !- Variable or Meter 1 Name
+    InteriorEquipment:NaturalGas,   !- Variable or Meter 1 Name
     SumOrAverage,            !- Aggregation Type for Variable or Meter 1
-    ExteriorEquipment:Gas,   !- Variable or Meter 2 Name
+    ExteriorEquipment:NaturalGas,   !- Variable or Meter 2 Name
     SumOrAverage,            !- Aggregation Type for Variable or Meter 2
-    Heating:Gas,             !- Variable or Meter 3 Name
+    Heating:NaturalGas,             !- Variable or Meter 3 Name
     SumOrAverage,            !- Aggregation Type for Variable or Meter 3
-    Cooling:Gas,             !- Variable or Meter 4 Name
+    Cooling:NaturalGas,             !- Variable or Meter 4 Name
     SumOrAverage,            !- Aggregation Type for Variable or Meter 4
-    WaterSystems:Gas,        !- Variable or Meter 5 Name
+    WaterSystems:NaturalGas,        !- Variable or Meter 5 Name
     SumOrAverage,            !- Aggregation Type for Variable or Meter 5
-    Cogeneration:Gas,        !- Variable or Meter 6 Name
+    Cogeneration:NaturalGas,        !- Variable or Meter 6 Name
     SumOrAverage;            !- Aggregation Type for Variable or Meter 6
 
 Output:Table:Monthly,
@@ -141,19 +143,19 @@ Output:Table:Monthly,
 Output:Table:Monthly,
   Building Energy Performance - Natural Gas Peak Demand,  !- Name
     2,                       !- Digits After Decimal
-    Gas:Facility,  !- Variable or Meter 1 Name
+    NaturalGas:Facility,  !- Variable or Meter 1 Name
     Maximum,            !- Aggregation Type for Variable or Meter 1
-    InteriorEquipment:Gas,   !- Variable or Meter 1 Name
+    InteriorEquipment:NaturalGas,   !- Variable or Meter 1 Name
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 1
-    ExteriorEquipment:Gas,   !- Variable or Meter 2 Name
+    ExteriorEquipment:NaturalGas,   !- Variable or Meter 2 Name
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 2
-    Heating:Gas,             !- Variable or Meter 3 Name
+    Heating:NaturalGas,             !- Variable or Meter 3 Name
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 3
-    Cooling:Gas,             !- Variable or Meter 4 Name
+    Cooling:NaturalGas,             !- Variable or Meter 4 Name
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 4
-    WaterSystems:Gas,        !- Variable or Meter 5 Name
+    WaterSystems:NaturalGas,        !- Variable or Meter 5 Name
     ValueWhenMaximumOrMinimum,            !- Aggregation Type for Variable or Meter 5
-    Cogeneration:Gas,        !- Variable or Meter 6 Name
+    Cogeneration:NaturalGas,        !- Variable or Meter 6 Name
     ValueWhenMaximumOrMinimum;            !- Aggregation Type for Variable or Meter 6
 
 Output:Table:Monthly,

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -52,13 +54,14 @@ class RunEnergyPlus < OpenStudio::Workflow::Job
 
     # Checks and configuration
     raise 'No run_dir specified in the registry' unless @registry[:run_dir]
-    ep_path = @options[:energyplus_path] ? @options[:energyplus_path] : nil
+
+    ep_path = @options[:energyplus_path] || nil
     @logger.warn "Using EnergyPlus path specified in options #{ep_path}" if ep_path
 
     @logger.info 'Starting the EnergyPlus simulation'
-    @registry[:time_logger].start('Running EnergyPlus') if @registry[:time_logger]
+    @registry[:time_logger]&.start('Running EnergyPlus')
     call_energyplus(@registry[:run_dir], ep_path, @output_adapter, @logger, @registry[:workflow_json])
-    @registry[:time_logger].stop('Running EnergyPlus') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Running EnergyPlus')
     @logger.info 'Completed the EnergyPlus simulation'
 
     sql_path = File.join(@registry[:run_dir], 'eplusout.sql')

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -63,9 +65,10 @@ class RunEnergyPlusMeasures < OpenStudio::Workflow::Job
 
     # Save both the OSM and IDF if the :debug option is true
     return nil unless @options[:debug]
-    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
+
+    @registry[:time_logger]&.start('Saving IDF')
     idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
-    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Saving IDF')
     @logger.debug "Saved IDF as #{idf_name}"
 
     nil

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -62,6 +64,7 @@ class RunInitialization < OpenStudio::Workflow::Job
     # DLM: this key is the raw JSON object, it is deprecated and should not be used, use :workflow_json instead
     @registry.register(:workflow) { @input_adapter.workflow }
     raise 'Specified workflow was nil' unless @registry[:workflow]
+
     @logger.debug 'Retrieved the workflow from the adapter'
 
     @registry.register(:osw_dir) { @input_adapter.osw_dir }
@@ -129,6 +132,7 @@ class RunInitialization < OpenStudio::Workflow::Job
       if model_full_path.empty?
         raise "Seed model #{model_path.get} specified in OSW cannot be found"
       end
+
       model_full_path = model_full_path.get
 
       if File.extname(model_full_path.to_s) == '.idf'
@@ -157,9 +161,7 @@ class RunInitialization < OpenStudio::Workflow::Job
     end
 
     if @registry[:openstudio_2]
-      if @registry[:model]
-        @registry[:model].setWorkflowJSON(workflow_json.clone)
-      end
+      @registry[:model]&.setWorkflowJSON(workflow_json.clone)
     end
 
     # DLM: TODO, load weather_file from options so it can be overriden by user_options
@@ -189,6 +191,7 @@ class RunInitialization < OpenStudio::Workflow::Job
       if weather_full_path.empty?
         raise "Weather file '#{weather_path}' specified but cannot be found"
       end
+
       weather_full_path = weather_full_path.get
 
       @registry.register(:wf) { weather_full_path.to_s }

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -79,9 +81,10 @@ class RunOpenStudioMeasures < OpenStudio::Workflow::Job
 
     # Save the OSM if the :debug option is true
     return nil unless @options[:debug]
-    @registry[:time_logger].start('Saving OSM') if @registry[:time_logger]
+
+    @registry[:time_logger]&.start('Saving OSM')
     osm_name = save_osm(@registry[:model], @registry[:root_dir])
-    @registry[:time_logger].stop('Saving OSM') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Saving OSM')
     @logger.debug "Saved model as #{osm_name}"
 
     nil

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -78,9 +80,9 @@ class RunPreprocess < OpenStudio::Workflow::Job
 
     # Perform pre-processing on in.idf to capture logic in RunManager
     if !@options[:skip_energyplus_preprocess]
-      @registry[:time_logger].start('Running EnergyPlus Preprocess') if @registry[:time_logger]
+      @registry[:time_logger]&.start('Running EnergyPlus Preprocess')
       energyplus_preprocess(@registry[:model_idf], @logger)
-      @registry[:time_logger].start('Running EnergyPlus Preprocess') if @registry[:time_logger]
+      @registry[:time_logger]&.start('Running EnergyPlus Preprocess')
       @logger.info 'Finished preprocess job for EnergyPlus simulation'
     end
 
@@ -94,9 +96,10 @@ class RunPreprocess < OpenStudio::Workflow::Job
 
     # Save the generated IDF file if the :debug option is true
     return nil unless @options[:debug]
-    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
+
+    @registry[:time_logger]&.start('Saving IDF')
     idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
-    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Saving IDF')
     @logger.debug "Saved IDF as #{idf_name}"
 
     nil

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -60,14 +62,29 @@ 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
+    @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
+        end
+      end    
+    end
 
     # Load simulation files as required
-    unless @registry[:runner].halted
+    unless @registry[:runner].halted || @registry[:urbanopt]
       if @registry[:model].nil?
         osm_path = File.absolute_path(File.join(@registry[:run_dir], 'in.osm'))
         @logger.debug "Attempting to load #{osm_path}"
         @registry.register(:model) { load_osm('.', osm_path) }
         raise "Unable to load #{osm_path}" unless @registry[:model]
+
         @logger.debug "Successfully loaded #{osm_path}"
       end
       if @registry[:model_idf].nil?
@@ -75,6 +92,7 @@ class RunReportingMeasures < OpenStudio::Workflow::Job
         @logger.debug "Attempting to load #{idf_path}"
         @registry.register(:model_idf) { load_idf(idf_path, @logger) }
         raise "Unable to load #{idf_path}" unless @registry[:model_idf]
+
         @logger.debug "Successfully loaded #{idf_path}"
       end
       if @registry[:sql].nil?

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -66,17 +68,18 @@ class RunTranslation < OpenStudio::Workflow::Job
 
     # Translate the OSM to an IDF
     @logger.info 'Beginning the translation to IDF'
-    @registry[:time_logger].start('Translating to EnergyPlus') if @registry[:time_logger]
+    @registry[:time_logger]&.start('Translating to EnergyPlus')
     model_idf = translate_to_energyplus @registry[:model], @logger
-    @registry[:time_logger].stop('Translating to EnergyPlus') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Translating to EnergyPlus')
     @registry.register(:model_idf) { model_idf }
     @logger.info 'Successfully translated to IDF'
 
     # Save the generated IDF file if the :debug option is true
     return nil unless @options[:debug]
-    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
+
+    @registry[:time_logger]&.start('Saving IDF')
     idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
-    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
+    @registry[:time_logger]&.stop('Saving IDF')
     @logger.debug "Saved IDF as #{idf_name}"
 
     nil