openstudio-extension 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b97c709824bf3884fb41b661e80677e74e968e21d8af1b5fc45fbece3c419b9
-  data.tar.gz: c225a47bec7fb5d176be730e7e3d21a17b0acdf455f71f5cad41853abbbda684
+  metadata.gz: c1d5fc1ae05ebc04e7ba917e74002f1c9c574fb03354c1dc9a8a12dd5fa1f897
+  data.tar.gz: 876541d14c4ccc7a97eb7a617d40c7dc68f58f1a49959491d51919e8af068f17
 SHA512:
-  metadata.gz: 43720385e7e367fa63f21775d66b69ff52df63c289f5155f65b1d49023cf184ab854bfbde63254596aad9986b3d8b4db5ad358f17c121ea9153bd9fa7aefa66a
-  data.tar.gz: 2fc1e01489b19a2797465e682dc86a387697e1c3cfc34ce6110994300213cf3b50de8cfa0b62983c21c360ed5537ce9ff7b03b023ea074590a73e4a813834155
+  metadata.gz: d3df31fdd6f8bd2805af4c69effc71f3ebb50c4ea1863f728737140623b42b87ebd5f2a05555b13eb8a0b2237a1eb73b8184723593bd89805a157bed4ec545ff
+  data.tar.gz: 20e1d537b0bd4ac570a6c8e90aa44de68434aaa573b1142fe560b340c9b9d8dca2182cea1c3dc9b6ca42c688afebe25ca3c5f1d2cf9382ed549645aa06a46ce3

data/.gitignore

@@ -17,6 +17,7 @@
 /lib/measures/.rubocop*
 /lib/measures/staged
 /lib/measures/staged/*
+.DS_Store
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
     - lib/measures/**/resources/*
     - lib/openstudio/extension/core/**/*
 
+require: rubocop-performance
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml
 

data/CHANGELOG.md

@@ -1,7 +1,34 @@
 # OpenStudio Extension Gem
 
+## Version 0.5.1
+
+* Fix adjancent surface matching 
+
+## Version 0.5.0
+
+* Update OpenStudio Workflow Gem to 2.3.0 (support for epJSON)
+* Fixed [#133]( https://github.com/NREL/openstudio-extension-gem/pull/133 ), cleanup readme and rework BCL tasks
+* Fixed [#135]( https://github.com/NREL/openstudio-extension-gem/pull/135 ), Intersect tests 072021
+* Fixed [#136]( https://github.com/NREL/openstudio-extension-gem/pull/136 ), Osm from haystack
+* Fixed [#137]( https://github.com/NREL/openstudio-extension-gem/issues/137 ), Edge case error in hospital bar
+* Fixed [#138]( https://github.com/NREL/openstudio-extension-gem/issues/138 ), os_lib_model_generation does not assign SWH type correctly
+* Fixed [#139]( https://github.com/NREL/openstudio-extension-gem/pull/139 ), fix swh_src assignment operators
+* Fixed [#142]( https://github.com/NREL/openstudio-extension-gem/pull/142 ), added arg for hoo_var_method and updated test to use it
+
+## Version 0.4.4
+
+* Update BCL gem to version 0.7.1 which upgrades REXML and Spreadsheet with security patches
+* Minor updates to documentation
+
+## Version 0.4.3
+
+* Update measure tester gem which upgrades Rubocop to 1.15
+* Update styles to v4 based on new version of Rubocop
+
 ## Version 0.4.2
 
+* Fixes [#113](https://github.com/NREL/openstudio-extension-gem/issues/113) Fix bad args behavior on bar_from_building_type_ratios
+* Fixes [#103](https://github.com/NREL/openstudio-extension-gem/issues/103) make check_upstream_measure_for_arg more robust for non string arguments
 * Updatd version of openstudio-standards for development to openstudio-standards 0.2.13
 * Added ASHRAE 90.1 2016 and 2019 to get_doe_templates method in os_lib_model_generation.rb file. This method is used by a number of measures to generate allowable argument values
 

data/Gemfile

@@ -3,7 +3,6 @@ source 'http://rubygems.org'
 # Specify your gem's dependencies in openstudio-extension.gemspec
 
 # line below used for testing when need to test against branch instead of release of standards. Should be commented out prior to merge to develop
-#gem 'openstudio-standards', github: 'NREL/openstudio-standards', branch: 'fix/901_2016_2019_properties' # for os_lib unit tests
+# gem 'openstudio-standards', github: 'NREL/openstudio-standards', branch: 'fix/901_2016_2019_properties' # for os_lib unit tests
 
 gemspec
-

data/README.md

@@ -10,10 +10,10 @@ Derivative extension gems should include this gem to access common functionality
 * OpenStudio CLI functionality such as list_measures and update_measures
 * adding documentation and license files to measures
 * adding core resource files to measures
-* pushing measures to BCL
+* correct structure for contributing content to the Building Component Library (BCL)
 
 Extension gems will contain a small group of related measures. Each extension gem will be the unique location to find these measures, and will be responsible for
-testing and maintaining the measures as well as pushing them to BCL. 
+testing and maintaining the measures as well as indexing them on BCL. 
 
 ## Usage
 
@@ -31,14 +31,15 @@ Each OpenStudio extension gem should define its own module name to ensure that t
 
 ## Installation
 
-To use this and other extension gems, you will need Ruby 2.5.x and OpenStudio 3.0.0 or greater.  
+To use the latest version of this and other extension gems, you will need Ruby 2.7.x and OpenStudio 3.1.0 or greater.  For earlier versions, view the [compatibility matrix](#compatibility-matrix) below.
 
 ### Windows Installation
-Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.5.5 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.5.5-x64.exe).
+Install Ruby with Devkit using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.7.2 (x64)](
+https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.7.2-1/rubyinstaller-devkit-2.7.2-1-x64.exe).
 
-Install Devkit using the [mingw64](https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe) installer.
+Make sure that you select **option 3: MSYS2 and MINGW development toolchain** during the installation process.
 
-Check the ruby installation returns the correct Ruby version (2.5.x):
+Check the ruby installation returns the correct Ruby version (2.7.x):
 ```
 ruby -v
 ```
@@ -48,10 +49,10 @@ Install bundler from the command line
 gem install bundler -v 2.1
 ```
 
-Install OpenStudio.  Create a file ```C:\ruby-2.5.5-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
+Install OpenStudio.  Create a file ```C:\ruby-2.7.2-1-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
 
 ```ruby
-require 'C:\openstudio-3.0.0\Ruby\openstudio.rb'
+require 'C:\openstudio-3.1.0\Ruby\openstudio.rb'
 ```
 
 Verify your OpenStudio and Ruby configuration:
@@ -65,7 +66,7 @@ rbenv can be installed via [Homebrew](https://brew.sh/):
 ```
 brew install rbenv
 rbenv init
-rbenv install 2.5.5
+rbenv install 2.7.2
 ```
 
 Also install bundler
@@ -76,10 +77,18 @@ gem install bundler -v 2.1
 Install [OpenStudio](https://www.openstudio.net/downloads).
 
 Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within
-the OpenStudio Application you just downloaded (replace 3.0.0 with the version you are using):
+the OpenStudio Application you just downloaded (replace 3.1.0 with the version you are using):
 ```
-export RUBYLIB=/Applications/OpenStudio-3.0.0/Ruby
+export RUBYLIB=/Applications/OpenStudio-3.1.0/Ruby
 ```
+## Compatibility Matrix
+
+|OpenStudio Extension Gem|OpenStudio|Ruby|
+|:--------------:|:----------:|:--------:|
+| 0.4.0 - 0.4.4  | 3.2      | 2.7    |
+| 0.3.0 - 0.3.2  | 3.1      | 2.5    |
+| 0.2.0 - 0.2.6  | 3.0      | 2.5    |
+| 0.1.6 and below | 2.9 and below      | 2.2.4    |
 
 
 ## Contents
@@ -138,7 +147,7 @@ Note that this folder is for 'core' functionality; if a measure's requires a new
 Having a single repository for all measures, such as the OpenStudio-measures repo, can be cumbersome to test and keep up to date. 
 In this new framework, each extension gem will contain one or more related measures.  The gem will be the new 'home' of these measures, and the repo owner will be responsible for testing and keeping the measures up to date.
 
-In the short term, in order to preserve the PAT/OS App functionality, resource files will still be copied directly into the measures, and these measures will be pushed to BCL.
+In the short term, in order to preserve the PAT/OS App functionality, resource files will still be copied directly into the measures, and these measures will be indexed on the BCL.
 
 ### Rake Tasks
 
@@ -146,10 +155,7 @@ Common Rake Tasks that are available to derivative extension gems include:
 
 | Rake Task | Description |
 | --------- | ----------- |
-| openstudio:bcl:test_login            | Test BCL login |
 | openstudio:bcl:search_measures       | Search BCL |
-| openstudio:bcl:stage[reset]          | Copy the measures/components to a staging location |
-| openstudio:bcl:push                  | Upload measures from the staging location |
 | openstudio:change_log[start_date,end_date,apikey] | Print the change log from GitHub. Specify dates in yyyy-mm-dd format |
 | openstudio:list_measures             | List all measures in the calling gem |
 | openstudio:measures:add_license      | Add License File to measures in the calling gem |
@@ -182,9 +188,10 @@ The following table contains all current extension gems.
 | OpenStudio Calibration Gem | openstudio-calibration | https://github.com/NREL/openstudio-calibration-gem |
 | OpenStudio EE Gem | openstudio-ee | https://github.com/NREL/openstudio-ee-gem | 
 | OpenStudio District Systems Gem | openstudio-district-systems | https://github.com/NREL/openstudio-district-systems-gem | 
+| OpenStudio Load Flexibility Measures Gem | openstudio-load-flexibility-measures | https://github.com/NREL/openstudio-load-flexibility-measures-gem |
 | URBANopt Core Gem | urbanopt-core | https://github.com/urbanopt/urbanopt-core-gem |
 | URBANopt GeoJSON Gem | urbanopt-geojson | https://github.com/urbanopt/urbanopt-geojson-gem | 
-| URBANopt Scenario Gem | urbanopt-scenario | https://github.com/urbanopt/urbanopt-scenario-gem |
+| URBANopt Reporting Gem | urbanopt-reporting | https://github.com/urbanopt/urbanopt-reporting-gem |
 | BuildingSync Gem | buildingsync | https://github.com/BuildingSync/BuildingSync-gem | 
 
 ### Initializing a new Extension Gem
@@ -208,12 +215,8 @@ The OpenStudio-extension gem can be used to easily initialize a new derivative e
 * All files and classes should have underscores (no dashes) and (lowercase snake_case)
 * Dashes should be used in module names
 
-### Pushing to BCL
-Use the rake tasks listed above to stage and push measures to BCL.  
-**Note of warning**: Use caution when pushing to the BCL.  Public and private measures could be pushed to BCL from within an extension gem, even though the extension gem repo may be private.
-
-TODO: Add warning to rake task and lists what gems will be pushed 
-TODO: Check that license files, etc. are present in each measure before pushing to BCL
+### Contributing measures to the BCL
+Register your extension gem repo with the [BCL Manifest](https://github.com/BuildingComponentLibrary/bcl-manifest) and [follow the instructions](https://github.com/BuildingComponentLibrary/bcl-manifest#contribute-content) to contribute content to the BCL.
 
 ## Include in a project
 
@@ -232,6 +235,10 @@ Or install it yourself as:
 
     $ gem install 'openstudio-extension'
 
+# Contributing 
+
+Please review the [OpenStudio Contribution Policy](https://openstudio.net/openstudio-contribution-policy) if you would like to contribute code to this gem.
+
 # Releasing the gem
 
 * Update CHANGELOG.md

data/Rakefile

@@ -45,10 +45,10 @@ desc 'Initialize a new gem'
 task :init_new_gem do
   puts 'Initializing a new extension gem'
   print "\n Enter the name of the new gem directory (ex: openstudio-something-gem. Should end with '-gem'): "
-  gem_name = STDIN.gets.chomp
+  gem_name = $stdin.gets.chomp
 
   print "\n Enter the path (full or relative to this repo) where you want the new gem directory to be created: "
-  dir_path = STDIN.gets.chomp
+  dir_path = $stdin.gets.chomp
 
   # check if directory already exists at path, if so error
   full_dir_name = dir_path + gem_name
@@ -61,7 +61,7 @@ task :init_new_gem do
   end
 
   # copy file structure
-  FileUtils.cp('.gitignore', full_dir_name + '/.gitignore')
+  FileUtils.cp('.gitignore', "#{full_dir_name}/.gitignore")
   FileUtils.cp_r(File.join(File.dirname(__FILE__), 'init_templates/template_gemfile.txt'), File.join(full_dir_name, 'Gemfile'))
   FileUtils.cp_r(File.join(File.dirname(__FILE__), 'doc_templates'), full_dir_name)
 

data/lib/change_log.rb

@@ -144,7 +144,7 @@ class ChangeLog
     puts "Total Open Issues: #{@total_open_issues.length}"
     puts "Total Open Pull Requests: #{@total_open_pull_requests.length}"
     puts "\nDate Range: #{@start_date.strftime('%m/%d/%y')} - #{@end_date.strftime('%m/%d/%y')}:"
-    puts "\nNew Issues: #{@new_issues.length} (" + @new_issues.map(&:number).join(', ') + ')'
+    puts "\nNew Issues: #{@new_issues.length} (#{@new_issues.map(&:number).join(', ')})"
 
     puts "\nClosed Issues: #{@closed_issues.length}"
     @closed_issues.each { |issue| puts print_issue(issue) }

data/lib/openstudio/extension/core/os_lib_geometry.rb

@@ -327,8 +327,7 @@ module OsLib_Geometry
     end
 
     # sort array by floor area, this hash will be altered to reduce floor area for each space type to 0
-    #space_types_running_count = space_types.sort_by { |k, v| v[:floor_area] }
-    space_types_running_count = space_types
+    space_types_running_count = space_types.sort_by { |k, v| v[:floor_area] }
 
     # array entry for each story
     footprints = []

data/lib/openstudio/extension/core/os_lib_model_generation.rb

@@ -36,6 +36,9 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
+# used to load haystack json in typical_building_from_model
+require 'json'
+
 module OsLib_ModelGeneration
   # simple list of building types that are valid for get_space_types_from_building_type
   # for general public use use extended = false
@@ -1143,12 +1146,13 @@ module OsLib_ModelGeneration
               spaces_temp = OpenStudio::Model::SpaceVector.new
               spaces_temp << space_a
               spaces_temp << space_b
+              # attempt to intersect and match walls on a story, but later secondary match will look for missted matches and turn them to adiabaitc
               # intersect and sort
               OpenStudio::Model.intersectSurfaces(spaces_temp)
               OpenStudio::Model.matchSurfaces(spaces_temp)
             end
           end
-          runner.registerInfo("Intersecting and matching surfaces in story #{story.name}, this will create additional geometry.")
+          runner.registerInfo("Intersecting and matching surfaces in story #{story.name}, this will create additional geometry. Diagnstoic intersection and matching done a in paris of spaces.")
         end
       end
 
@@ -1169,6 +1173,8 @@ module OsLib_ModelGeneration
           story.spaces.sort.each do |space|
             story_spaces << space
           end
+          # attempt to intersect and match walls on a story, but later secondary match will look for missted matches and turn them to adiabaitc
+          # intersect and sort
           OpenStudio::Model.intersectSurfaces(story_spaces)
           OpenStudio::Model.matchSurfaces(story_spaces)
           runner.registerInfo("Intersecting and matching surfaces in story #{story.name}, this will create additional geometry.")
@@ -1193,6 +1199,75 @@ module OsLib_ModelGeneration
       end
     end
 
+    # set wall boundary condtions to adiabatic if using make_mid_story_surfaces_adiabatic prior to windows being made
+    if bar_hash[:make_mid_story_surfaces_adiabatic]
+
+      runner.registerInfo("Finding non-exterior walls and setting boundary condition to adiabatic")
+
+      # need to organize by story incase top story is partial story
+      # should also be only for a single bar
+      story_bounding = {}
+      missed_match_count = 0
+
+      # gather new spaces by story
+      new_spaces.each do |space|
+        story = space.buildingStory.get
+          if story_bounding.has_key?(story)
+            story_bounding[story][:spaces] << space
+          else
+            story_bounding[story] = {:spaces => [space]}
+          end
+      end
+
+      # get bounding box for each story
+      story_bounding.each do |story,v|
+
+        # get bounding_box
+        bounding_box = OpenStudio::BoundingBox.new
+        v[:spaces].each do |space|
+          space.surfaces.each do |space_surface|
+            bounding_box.addPoints(space.transformation * space_surface.vertices)
+          end
+        end
+        min_x = bounding_box.minX.get
+        min_y = bounding_box.minY.get
+        max_x = bounding_box.maxX.get
+        max_y = bounding_box.maxY.get
+        ext_wall_toll = 0.01
+
+        # check surfaces again against min/max and change to adiabatic if not fully on one min or max x or y
+        # todo - may need to look at aidiabiatc constructions in downstream measure. Some may be exterior party wall others may be interior walls
+        v[:spaces].each do |space|
+          space.surfaces.each do |space_surface|
+            next if not space_surface.surfaceType == "Wall"
+            next if space_surface.outsideBoundaryCondition == "Surface" # if if found a match leave it alone, don't change to adiabiatc
+            surface_bounding_box = OpenStudio::BoundingBox.new
+            surface_bounding_box.addPoints(space.transformation * space_surface.vertices)
+            surface_on_outside = false
+            # check xmin
+            if (surface_bounding_box.minX.get - min_x).abs < ext_wall_toll && (surface_bounding_box.maxX.get - min_x).abs < ext_wall_toll then surface_on_outside = true end
+            # check xmax
+            if (surface_bounding_box.minX.get - max_x).abs < ext_wall_toll && (surface_bounding_box.maxX.get - max_x).abs < ext_wall_toll then surface_on_outside = true end
+            # check ymin
+            if (surface_bounding_box.minY.get - min_y).abs < ext_wall_toll && (surface_bounding_box.maxY.get - min_y).abs < ext_wall_toll then surface_on_outside = true end
+            # check ymax
+            if (surface_bounding_box.minY.get - max_y).abs < ext_wall_toll && (surface_bounding_box.maxY.get - max_y).abs < ext_wall_toll then surface_on_outside = true end
+
+            # change if not exterior
+            if !surface_on_outside
+              space_surface.setOutsideBoundaryCondition("Adiabatic")
+              missed_match_count += 1
+            end
+          end
+        end
+      end
+
+      if missed_match_count > 0
+        runner.registerInfo("#{missed_match_count} surfaces that were exterior appear to be interior walls and had boundary condition chagned to adiabiatic.")
+      end
+
+    end
+
     # sort stories (by name for now but need better way)
     sorted_stories = {}
     new_spaces.each do |space|
@@ -1697,9 +1772,6 @@ module OsLib_ModelGeneration
     end
     fraction = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 0.0, 'max' => 1.0, 'min_eq_bool' => true, 'max_eq_bool' => true, 'arg_array' => fraction_args)
 
-    positive_args = ['total_bldg_floor_area']
-    positive = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 0.0, 'max' => nil, 'min_eq_bool' => false, 'max_eq_bool' => false, 'arg_array' => positive_args)
-
     one_or_greater_args = ['num_stories_above_grade']
     one_or_greater = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 1.0, 'max' => nil, 'min_eq_bool' => true, 'max_eq_bool' => false, 'arg_array' => one_or_greater_args)
 
@@ -1710,13 +1782,13 @@ module OsLib_ModelGeneration
                     'party_wall_stories_south',
                     'party_wall_stories_east',
                     'party_wall_stories_west',
+                    'total_bldg_floor_area',
                     'single_floor_area',
                     'bar_width']
     non_neg = OsLib_HelperMethods.checkDoubleAndIntegerArguments(runner, user_arguments, 'min' => 0.0, 'max' => nil, 'min_eq_bool' => true, 'max_eq_bool' => false, 'arg_array' => non_neg_args)
 
     # return false if any errors fail
     if !fraction then return false end
-    if !positive then return false end
     return false if !one_or_greater
     return false if !non_neg
 
@@ -1815,10 +1887,6 @@ module OsLib_ModelGeneration
       args = bar_arg_check_setup(model,runner,user_arguments,false) # false stops it from checking args on used in bar_from_building_type_ratios
       if !args then return false end
 
-      # identify primary building type for building form defaults
-      primary_building_type = "PrimarySchool" # see what building type represents the most floro area
-      building_form_defaults = building_form_defaults(primary_building_type)
-
       # process arg into hash
       space_type_hash_name = {}
       args['space_type_hash_string'][0..-1].split(/, /).each { |entry| entryMap = entry.split(/=>/); value_str = entryMap[1]; space_type_hash_name[entryMap[0].strip[0..-1].to_s] = value_str.nil? ? '' : value_str.strip[0..-1].to_f }
@@ -1866,6 +1934,11 @@ module OsLib_ModelGeneration
         building_type_fraction_of_building += ratio
       end
 
+      # identify primary building type for building form defaults
+      primary_building_type = building_type_hash.keys.first # update to choose building with highest ratio
+      runner.registerInfo("Creating bar with space type ratio proided as argument.")
+      runner.registerInfo("Using building type from first ratio #{primary_building_type} as the primary building type. This is used for building form defaults.")
+
       # todo - confirm if this will get normalized up/down later of if I should fix or stop here instead of just a warning
       if building_type_fraction_of_building > 1.0
         runner.registerWarning("Sum of Space Type Ratio of #{building_type_fraction_of_building} is greater than the expected value of 1.0")
@@ -1877,6 +1950,8 @@ module OsLib_ModelGeneration
 
       # if aspect ratio, story height or wwr have argument value of 0 then use smart building type defaults
       primary_building_type = args['bldg_type_a']
+      runner.registerInfo("Creating bar space type ratios by building type based on ratios from prototype models.")
+      runner.registerInfo("#{primary_building_type} will be used for building form defaults.")
 
     end
 
@@ -2512,7 +2587,7 @@ module OsLib_ModelGeneration
     runner.registerValue('ew_wall_area_ip', wall_ew_ip, 'ft^2')
     # for now using perimeter of ground floor and average story area (building area / num_stories)
     runner.registerValue('floor_area_to_perim_ratio', model.getBuilding.floorArea / (OsLib_Geometry.calculate_perimeter(model) * num_stories))
-    runner.registerValue('bar_width', OpenStudio.convert(bars['primary'][:width], 'm', 'ft').get, 'ft')
+    runner.registerValue('bar_width_output', OpenStudio.convert(bars['primary'][:width], 'm', 'ft').get, 'ft')
 
     if args['party_wall_fraction'] > 0 || args['party_wall_stories_north'] > 0 || args['party_wall_stories_south'] > 0 || args['party_wall_stories_east'] > 0 || args['party_wall_stories_west'] > 0
       runner.registerInfo('Target facade area by orientation not validated when party walls are applied')
@@ -2709,6 +2784,29 @@ module OsLib_ModelGeneration
       return false
     end
 
+    # if haystack_file used find the file
+    # todo - may want to allow NA, empty string or some other value to skip so a measure can ake this optional witht using optional measure arguments
+    if args['haystack_file']
+      haystack_file = runner.workflow.findFile(args['haystack_file'])
+      if haystack_file.is_initialized
+        haystack_file = haystack_file.get.to_s
+
+        # load JSON file
+        json = nil
+        File.open(haystack_file, 'r') do |file|
+          json = file.read
+          # uncomment to inspect haystack json
+          # puts json
+        end
+
+      else
+        runner.registerError("Did not find #{args['haystack_file']} in paths described in OSW file.")
+        return false
+      end
+    else
+      haystack_file = nil
+    end
+
     # make sure daylight savings is turned on up prior to any sizing runs being done.
     if args['enable_dst']
       start_date = '2nd Sunday in March'
@@ -2934,9 +3032,9 @@ module OsLib_ModelGeneration
         if args['htg_src'] == 'NaturalGas' || args['htg_src'] == 'DistrictHeating'
           args['swh_src'] = 'NaturalGas' # If building has gas service, probably uses natural gas for SWH
         elsif args['htg_src'] == 'Electricity'
-          args['swh_src'] == 'Electricity' # If building is doing space heating with electricity, probably used for SWH
+          args['swh_src'] = 'Electricity' # If building is doing space heating with electricity, probably used for SWH
         elsif args['htg_src'] == 'DistrictAmbient'
-          args['swh_src'] == 'HeatPump' # If building has district ambient loop, it is fancy and probably uses HPs for SWH
+          args['swh_src'] = 'HeatPump' # If building has district ambient loop, it is fancy and probably uses HPs for SWH
         else
           args['swh_src'] = nil # Use inferences built into OpenStudio Standards for each building and space type
         end
@@ -3092,12 +3190,20 @@ module OsLib_ModelGeneration
                            sys_type # same as primary system type
                          end
 
-          # Group zones by story
-          story_zone_lists = standard.model_group_zones_by_story(model, sys_group['zones'])
+          # group zones
+          if haystack_file.nil?
+            # Group zones by story
+            bldg_zone_lists = standard.model_group_zones_by_story(model, sys_group['zones'])
+          else
+            # todo - group zones using haystack file instead of building stories
+            # todo - need to do something similar to use haystack to indentify secondary zones
+            bldg_zone_lists = standard.model_group_zones_by_story(model, sys_group['zones'])
+            runner.registerInfo("***This code will define which zones are on air loops for inferred system***")
+          end
 
           # On each story, add the primary system to the primary zones
           # and add the secondary system to any zones that are different.
-          story_zone_lists.each do |story_group|
+          bldg_zone_lists.each do |story_group|
             # Differentiate primary and secondary zones, based on
             # operating hours and internal loads (same as 90.1 PRM)
             pri_sec_zone_lists = standard.model_differentiate_primary_secondary_thermal_zones(model, story_group)
@@ -3137,12 +3243,21 @@ module OsLib_ModelGeneration
         # Group the zones by occupancy type.  Only split out non-dominant groups if their total area exceeds the limit.
         sys_groups = standard.model_group_zones_by_type(model, OpenStudio.convert(20_000, 'ft^2', 'm^2').get)
         sys_groups.each do |sys_group|
-          # Group the zones by story
-          story_groups = standard.model_group_zones_by_story(model, sys_group['zones'])
+
+          # group zones
+          if haystack_file.nil?
+            # Group zones by story
+            bldg_zone_groups = standard.model_group_zones_by_story(model, sys_group['zones'])
+          else
+            # todo - group zones using haystack file instead of building stories
+            # todo - need to do something similar to use haystack to indentify secondary zones
+            bldg_zone_groups = standard.model_group_zones_by_story(model, sys_group['zones'])
+            runner.registerInfo("***This code will define which zones are on air loops for user specified system***")
+          end
 
           # Add the user specified HVAC system for each story.
           # Single-zone systems will get one per zone.
-          story_groups.each do |zones|
+          bldg_zone_groups.each do |zones|
             unless model.add_cbecs_hvac_system(standard, args['system_type'], zones)
               runner.registerError("HVAC system type '#{args['system_type']}' not recognized. Check input system type argument against Model.hvac.rb for valid hvac system type names.")
               return false
@@ -3157,8 +3272,17 @@ module OsLib_ModelGeneration
       # Infer the current hours of operation schedule for the building
       op_sch = standard.model_infer_hours_of_operation_building(model)
 
+      # setup hoo_var_method (should be hours or fractional)
+      if args.has_key?('hoo_var_method')
+        hoo_var_method = args['hoo_var_method']
+      else
+        # support measures that don't supply this argument
+        hoo_var_method = 'hours'
+      end
+
       # Convert existing schedules in the model to parametric schedules based on current hours of operation
-      standard.model_setup_parametric_schedules(model)
+      runner.registerInfo("Generating parametric schedules from ruleset schedules using #{hoo_var_method} variable method for hours of operation fromula.")
+      standard.model_setup_parametric_schedules(model, hoo_var_method: hoo_var_method)
 
       # Create start and end times from start time and duration supplied
       wkdy_start_time = nil
@@ -3254,11 +3378,11 @@ module OsLib_ModelGeneration
 
     # change night cycling control to "Thermostat" cycling and increase thermostat tolerance to 1.99999
     manager_night_cycles = model.getAvailabilityManagerNightCycles
-    
+    runner.registerInfo("Changing thermostat tollerance to 1.99999 for #{manager_night_cycles.size} night cycle manager objects.")
+
     manager_night_cycles.each do |night_cycle|
       night_cycle.setThermostatTolerance(1.9999)
       night_cycle.setCyclingRunTimeControlType("Thermostat")
-      runner.registerInfo(" night_cycle == #{night_cycle}")
     end
 
     # report final condition of model

data/lib/openstudio/extension/rake_task.rb

@@ -55,7 +55,7 @@ module OpenStudio
         @root_dir = @extension.root_dir
         # Catch if measures_dir is nil, then just make it an empty string
         @measures_dir = @extension.measures_dir || ''
-        @staged_path = @measures_dir + '/staged'
+        @staged_path = "#{@measures_dir}/staged"
         @core_dir = @extension.core_dir
         @doc_templates_dir = @extension.doc_templates_dir
         @files_dir = @extension.files_dir
@@ -147,19 +147,11 @@ module OpenStudio
           end
 
           namespace 'bcl' do
-            desc 'Test BCL login'
-            task :test_login do
-              puts 'test BCL login'
-              bcl = ::BCL::ComponentMethods.new
-              bcl.login
-            end
-
             # for custom search, populate env var: bcl_search_keyword
             desc 'Search BCL'
             task :search_measures do
               puts 'test search BCL'
               bcl = ::BCL::ComponentMethods.new
-              bcl.login
 
               # check for env var specifying keyword first
               if ENV['bcl_search_keyword']
@@ -176,195 +168,6 @@ module OpenStudio
                 puts(res[:measure][:name]).to_s
               end
             end
-
-            # to call with argument: "openstudio:bcl:stage[true]" (true = remove existing staged content)
-            desc 'Copy the measures/components to a location that can be uploaded to BCL'
-            task :stage, [:reset] do |t, args|
-              puts 'Staging measures for BCL'
-              # initialize BCL and login
-              bcl = ::BCL::ComponentMethods.new
-              bcl.login
-
-              # process reset options: true to clear out old staged content
-              options = { reset: false }
-              if args[:reset].to_s == 'true'
-                options[:reset] = true
-              end
-
-              # ensure staged dir exists
-              FileUtils.mkdir_p(@staged_path)
-
-              # delete existing tarballs if reset is true
-              if options[:reset]
-                puts 'Deleting existing staged content'
-                FileUtils.rm_rf(Dir.glob("#{@staged_path}/*"))
-              end
-
-              # create new and existing directories
-              FileUtils.mkdir_p(@staged_path.to_s + '/update')
-              FileUtils.mkdir_p(@staged_path.to_s + '/push/component')
-              FileUtils.mkdir_p(@staged_path.to_s + '/push/measure')
-
-              # keep track of noop, update, push
-              noops = 0
-              new_ones = 0
-              updates = 0
-
-              # get all content directories to process
-              dirs = Dir.glob("#{@measures_dir}/*")
-
-              dirs.each do |dir|
-                next if dir.include?('Rakefile') || File.basename(dir) == 'staged'
-                current_d = Dir.pwd
-                content_name = File.basename(dir)
-                puts '', '---'
-                puts "Generating #{content_name}"
-
-                Dir.chdir(dir)
-
-                # figure out whether to upload new or update existing
-                files = Pathname.glob('**/*')
-                uuid = nil
-                vid = nil
-                content_type = 'measure'
-
-                paths = []
-                files.each do |file|
-                  # don't tar tests/outputs directory
-                  next if file.to_s.start_with?('tests/output') # From measure testing process
-                  next if file.to_s.start_with?('tests/test') # From openstudio-measure-tester-gem
-                  next if file.to_s.start_with?('tests/coverage') # From openstudio-measure-tester-gem
-                  next if file.to_s.start_with?('test_results') # From openstudio-measure-tester-gem
-                  paths << file.to_s
-                  if file.to_s =~ /^.{0,2}component.xml$/ || file.to_s =~ /^.{0,2}measure.xml$/
-                    if file.to_s.match?(/^.{0,2}component.xml$/)
-                      content_type = 'component'
-                    end
-                    # extract uuid  and vid
-                    uuid, vid = bcl.uuid_vid_from_xml(file)
-                  end
-                end
-                puts "UUID: #{uuid}, VID: #{vid}"
-
-                # note: if uuid is missing, will assume new content
-                action = bcl.search_by_uuid(uuid, vid)
-                puts "#{content_name} ACTION TO TAKE: #{action}"
-                # new content functionality needs to know if measure or component.  update is agnostic.
-                if action == 'noop' # ignore up-to-date content
-                  puts "  - WARNING: local #{content_name} uuid and vid match BCL... no update will be performed"
-                  noops += 1
-                  next
-                elsif action == 'update'
-                  # puts "#{content_name} labeled as update for BCL"
-                  destination = @staged_path + '/' + action + '/' + "#{content_name}.tar.gz"
-                  updates += 1
-                elsif action == 'push'
-                  # puts "#{content_name} labeled as new content for BCL"
-                  destination = @staged_path + '/' + action + '/' + content_type + "/#{content_name}.tar.gz"
-                  new_ones += 1
-                end
-
-                puts "destination: #{destination}"
-
-                # copy over only if 'reset_receipts' is set to TRUE. otherwise ignore if file exists already
-                if File.exist?(destination)
-                  if options[:reset]
-                    FileUtils.rm(destination)
-                    ::BCL.tarball(destination, paths)
-                  else
-                    puts "*** WARNING: File #{content_name}.tar.gz already exists in staged directory... keeping existing file. To overwrite, set reset_receipts arg to true ***"
-                  end
-                else
-                  ::BCL.tarball(destination, paths)
-                end
-                Dir.chdir(current_d)
-              end
-              puts '', "****STAGING DONE**** #{new_ones} new content, #{updates} updates, #{noops} skipped (already up-to-date on BCL)", ''
-            end
-
-            desc 'Upload measures from the specified location.'
-            task :push do
-              puts 'Push measures to BCL'
-
-              # initialize BCL and login
-              bcl = ::BCL::ComponentMethods.new
-              bcl.login
-              reset = false
-
-              total_count = 0
-              successes = 0
-              errors = 0
-              skipped = 0
-
-              # grab all the new measure and component tar files and push to bcl
-              ['measure', 'component'].each do |content_type|
-                items = []
-                paths = Pathname.glob(@staged_path.to_s + "/push/#{content_type}/*.tar.gz")
-                paths.each do |path|
-                  # puts path
-                  items << path.to_s
-                end
-
-                items.each do |item|
-                  puts item.split('/').last
-                  total_count += 1
-
-                  receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
-                  if !reset && File.exist?(receipt_file)
-                    skipped += 1
-                    puts 'SKIP: receipt file found'
-                    next
-                  end
-
-                  valid, res = bcl.push_content(item, true, "nrel_#{content_type}")
-                  if valid
-                    successes += 1
-                  else
-                    errors += 1
-                    if res.key?(:error)
-                      puts "  ERROR MESSAGE: #{res[:error]}"
-                    else
-                      puts "ERROR: #{res.inspect.chomp}"
-                    end
-                  end
-                  puts '', '---'
-                end
-              end
-
-              # grab all the updated content (measures and components) tar files and push to bcl
-              items = []
-              paths = Pathname.glob(@staged_path.to_s + '/update/*.tar.gz')
-              paths.each do |path|
-                # puts path
-                items << path.to_s
-              end
-              items.each do |item|
-                puts item.split('/').last
-                total_count += 1
-
-                receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
-                if !reset && File.exist?(receipt_file)
-                  skipped += 1
-                  puts 'SKIP: receipt file found'
-                  next
-                end
-
-                valid, res = bcl.update_content(item, true)
-                if valid
-                  successes += 1
-                else
-                  errors += 1
-                  if res.key?(:error)
-                    puts "  ERROR MESSAGE: #{res[:error]}"
-                  else
-                    puts "ERROR MESSAGE: #{res.inspect.chomp}"
-                  end
-                end
-                puts '', '---'
-              end
-
-              puts "****UPLOAD DONE**** #{total_count} total, #{successes} success, #{errors} failures, #{skipped} skipped"
-            end
           end
         end
       end

data/lib/openstudio/extension/runner.rb

@@ -121,15 +121,15 @@ module OpenStudio
 
             # test to see if bundle is installed
             check_bundle = run_command('bundle -v', get_clean_env)
-            if !check_bundle
-              raise "Failed to run command 'bundle -v', check that bundle is installed" if !File.exist?(@dirname)
+            if !check_bundle && !File.exist?(@dirname)
+              raise "Failed to run command 'bundle -v', check that bundle is installed"
             end
 
             # TODO: check that ruby version is correct
 
             # check existing config
             needs_config = true
-            if File.exist?('./.bundle/config')  # checking wrt gemfile_dir
+            if File.exist?('./.bundle/config') # checking wrt gemfile_dir
               puts 'config exists'
               needs_config = false
               config = YAML.load_file('./.bundle/config')
@@ -166,10 +166,8 @@ module OpenStudio
             end
 
             needs_update = needs_config || needs_platform
-            if !needs_update
-              if !File.exist?('Gemfile.lock') || File.mtime(@gemfile_path) > File.mtime('Gemfile.lock')
-                needs_update = true
-              end
+            if !needs_update && (!File.exist?('Gemfile.lock') || File.mtime(@gemfile_path) > File.mtime('Gemfile.lock'))
+              needs_update = true
             end
 
             puts "needs_update = #{needs_update}"
@@ -241,7 +239,7 @@ module OpenStudio
             puts "Error running command: '#{command}'"
             puts "stdout: #{stdout_str}"
             puts "stderr: #{stderr_str}"
-            STDOUT.flush
+            $stdout.flush
             result = false
           end
         ensure
@@ -318,10 +316,10 @@ module OpenStudio
 
         puts 'SYSTEM CALL:'
         puts the_call
-        STDOUT.flush
+        $stdout.flush
         result = run_command(the_call, get_clean_env)
         puts "DONE, result = #{result}"
-        STDOUT.flush
+        $stdout.flush
 
         return result
       end
@@ -358,10 +356,10 @@ module OpenStudio
 
           puts 'SYSTEM CALL:'
           puts the_call
-          STDOUT.flush
+          $stdout.flush
           result &&= run_command(the_call, get_clean_env)
           puts "DONE, result = #{result}"
-          STDOUT.flush
+          $stdout.flush
         end
 
         return result
@@ -425,7 +423,7 @@ module OpenStudio
           measures = Dir.glob(File.join(measures_dir, '**/**/resources/*.rb'))
         end
 
-        # Note: some older measures like AEDG use 'OsLib_SomeName' instead of 'os_lib_some_name'
+        # NOTE: some older measures like AEDG use 'OsLib_SomeName' instead of 'os_lib_some_name'
         # this script isn't replacing those copies
 
         # loop through resource files
@@ -523,11 +521,9 @@ module OpenStudio
           return false
         end
 
-        if File.exist?(File.join(doc_templates_dir, 'LICENSE.md'))
-          if File.exist?(File.join(root_dir, 'LICENSE.md'))
-            puts 'updating LICENSE.md in root dir'
-            FileUtils.cp(File.join(doc_templates_dir, 'LICENSE.md'), File.join(root_dir, 'LICENSE.md'))
-          end
+        if File.exist?(File.join(doc_templates_dir, 'LICENSE.md')) && File.exist?(File.join(root_dir, 'LICENSE.md'))
+          puts 'updating LICENSE.md in root dir'
+          FileUtils.cp(File.join(doc_templates_dir, 'LICENSE.md'), File.join(root_dir, 'LICENSE.md'))
         end
 
         ruby_regex = /^\#\s?[\#\*]{12,}.*copyright.*?\#\s?[\#\*]{12,}\s*$/mi
@@ -593,7 +589,7 @@ module OpenStudio
                 puts '  CANNOT add license to file automatically, add it manually and it will update automatically in the future'
                 next
               end
-              File.open(dir_file, 'w') { |write| write << f.insert(0, path[:license] + "\n") }
+              File.open(dir_file, 'w') { |write| write << f.insert(0, "#{path[:license]}\n") }
             end
           end
         end
@@ -631,7 +627,7 @@ module OpenStudio
 
         if @options[:run_simulations]
           cli = OpenStudio.getOpenStudioCLI
-          out_log = run_osw_path + '.log'
+          out_log = "#{run_osw_path}.log"
           # if Gem.win_platform?
           #   # out_log = "nul"
           # else
@@ -655,10 +651,10 @@ module OpenStudio
 
           puts 'SYSTEM CALL:'
           puts the_call
-          STDOUT.flush
+          $stdout.flush
           result = run_command(the_call, get_clean_env)
           puts "DONE, result = #{result}"
-          STDOUT.flush
+          $stdout.flush
         else
           puts 'simulations are not performed, since to the @options[:run_simulations] is set to false'
         end

data/lib/openstudio/extension/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.5.1'.freeze
   end
 end

data/lib/openstudio/extension.rb

@@ -209,11 +209,9 @@ module OpenStudio
     def self.set_measure_argument(osw, measure_dir_name, argument_name, argument_value, step_name = nil)
       result = false
       osw[:steps].each do |step|
-        if step[:measure_dir_name] == measure_dir_name
-          if step_name.nil? || step[:name] == step_name
-            step[:arguments][argument_name.to_sym] = argument_value
-            result = true
-          end
+        if step[:measure_dir_name] == measure_dir_name && (step_name.nil? || step[:name] == step_name)
+          step[:arguments][argument_name.to_sym] = argument_value
+          result = true
         end
       end
 
@@ -239,10 +237,8 @@ module OpenStudio
     def self.measure_in_osw(osw, measure_dir_name, step_name = nil)
       result = false
       osw[:steps].each do |step|
-        if step[:measure_dir_name] == measure_dir_name
-          if step_name.nil? || step[:name] == step_name
-            result = true
-          end
+        if step[:measure_dir_name] == measure_dir_name && (step_name.nil? || step[:name] == step_name)
+          result = true
         end
       end
 

data/openstudio-extension.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.7.0'
 
-  spec.add_dependency 'bcl', '~> 0.7.0'
+  spec.add_dependency 'bcl', '~> 0.7.1'
   spec.add_dependency 'bundler', '>= 2.1.0'
   spec.add_dependency 'octokit', '~> 4.18.0' # for change logs
-  spec.add_dependency 'openstudio-workflow', '~> 2.2.0'
-  spec.add_dependency 'openstudio_measure_tester', '~> 0.3.0'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.3.1'
+  spec.add_dependency 'openstudio-workflow', '~> 2.3.0'
   spec.add_dependency 'parallel', '~> 1.19.1'
 
   spec.add_development_dependency 'openstudio-standards', '~> 0.2.13' # for os_lib unit tests

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Katherine Fleming
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,33 +56,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.18.0
 - !ruby/object:Gem::Dependency
-  name: openstudio-workflow
+  name: openstudio_measure_tester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
-  name: openstudio_measure_tester
+  name: openstudio-workflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -233,7 +233,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/openstudio-extension-gem/issues
   changelog_uri: https://github.com/NREL/openstudio-extension-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.4.2
+  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.5.1
 post_install_message: 
 rdoc_options: []
 require_paths: