openstudio-extension 0.2.1 → 0.2.6

data/lib/openstudio-extension.rb

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

data/lib/openstudio/extension.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -228,5 +226,26 @@ module OpenStudio
 
       return osw
     end
+
+    ##
+    # Module method used to check whether a measure is present in an OSW file
+    ##
+    #  @param [Hash] in_osw Initial OSW object as a Hash, keys should be symbolized
+    #  @param [String] measure_dir_name Directory name of measure to set argument on
+    #  @param [String] step_name Optional argument, if present used to further identify the measure
+    #
+    #  @return [Boolean] true or false
+    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
+        end
+      end
+
+      return result
+    end
   end
 end

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

@@ -79,6 +79,11 @@ module OsLib_ModelGeneration
     array << 'Hospital'
     array << 'Outpatient'
     array << 'SuperMarket'
+    array << 'Laboratory'
+    array << 'LargeDataCenterLowITE'
+    array << 'LargeDataCenterHighITE'
+    array << 'SmallDataCenterLowITE'
+    array << 'SmallDataCenterHighITE'
 
     return array
   end
@@ -328,7 +333,7 @@ module OsLib_ModelGeneration
     supermarket_a = 45001.0
     supermarket_p = 866.0
     supermarket_wwr = 1880.0 / (supermarket_p * 20.0)
-    supermarket_aspet_ratio = calc_aspect_ratio(supermarket_a, supermarket_p)
+    supermarket_aspect_ratio = calc_aspect_ratio(supermarket_a, supermarket_p)
 
     hash['SmallOffice'] = { aspect_ratio: 1.5, wwr: 0.15, typical_story: 10.0, perim_mult: 1.0 }
     hash['MediumOffice'] = { aspect_ratio: 1.5, wwr: 0.33, typical_story: 13.0, perim_mult: 1.0 }
@@ -351,7 +356,14 @@ module OsLib_ModelGeneration
     hash['MidriseApartment'] = { aspect_ratio: 2.75, wwr: 0.15, typical_story: 10.0, perim_mult: 1.0 }
     hash['HighriseApartment'] = { aspect_ratio: 2.75, wwr: 0.15, typical_story: 10.0, perim_mult: 1.0 }
     # SuperMarket inputs come from prototype model
-    hash['SuperMarket'] = { aspect_ratio: supermarket_aspet_ratio.round(1), wwr: supermarket_wwr.round(2), typical_story: 20.0, perim_mult: 1.0 }
+    hash['SuperMarket'] = { aspect_ratio: supermarket_aspect_ratio.round(1), wwr: supermarket_wwr.round(2), typical_story: 20.0, perim_mult: 1.0 }
+
+    # Add Laboratory and Data Centers
+    hash['Laboratory'] = { aspect_ratio: 1.33, wwr: 0.12, typical_story: 10.0, perim_mult: 1.0 }
+    hash['LargeDataCenterLowITE'] = { aspect_ratio: 1.67, wwr: 0.0, typical_story: 14.0, perim_mult: 1.0 }
+    hash['LargeDataCenterHighITE'] = { aspect_ratio: 1.67, wwr: 0.0, typical_story: 14.0, perim_mult: 1.0 }
+    hash['SmallDataCenterLowITE'] = { aspect_ratio: 1.5, wwr: 0.0, typical_story: 14.0, perim_mult: 1.0 }
+    hash['SmallDataCenterHighITE'] = { aspect_ratio: 1.5, wwr: 0.0, typical_story: 14.0, perim_mult: 1.0 }
 
     # DEER Prototypes
     hash['Asm'] = { aspect_ratio: 1.0, wwr: 0.19, typical_story: 15.0 }
@@ -664,6 +676,19 @@ module OsLib_ModelGeneration
       hash['Meeting'] = { ratio: 0.99, space_type_gen: true, default: true }
       hash['Restroom'] = { ratio: 0.99, space_type_gen: true, default: true }
       hash['Vestibule'] = { ratio: 0.99, space_type_gen: true, default: true }
+    elsif building_type == 'Laboratory'
+      hash['Office'] = { ratio: 0.50, space_type_gen: true, default: true }
+      hash['Open lab'] = { ratio: 0.35, space_type_gen: true, default: true }
+      hash['Equipment corridor'] = { ratio: 0.05, space_type_gen: true, default: true }
+      hash['Lab with fume hood'] = { ratio: 0.10, space_type_gen: true, default: true }
+    elsif building_type == 'LargeDataCenterHighITE'
+      hash['StandaloneDataCenter'] = { ratio: 1.0, space_type_gen: true, default: true }
+    elsif building_type == 'LargeDataCenterLowITE'
+      hash['StandaloneDataCenter'] = { ratio: 1.0, space_type_gen: true, default: true }
+    elsif building_type == 'SmallDataCenterHighITE'
+      hash['ComputerRoom'] = { ratio: 1.0, space_type_gen: true, default: true }
+    elsif building_type == 'SmallDataCenterLowITE'
+      hash['ComputerRoom'] = { ratio: 1.0, space_type_gen: true, default: true }
       # DEER Prototypes
     elsif building_type == 'Asm'
       hash['Auditorium'] = { ratio: 0.7658, space_type_gen: true, default: true }
@@ -2560,6 +2585,19 @@ module OsLib_ModelGeneration
     # Make the standard applier
     standard = Standard.build((args['template']).to_s)
 
+    # validate climate zone
+    if !args.has_key?('climate_zone') || args['climate_zone'] == 'Lookup From Model'
+      climate_zone = standard.model_get_building_climate_zone_and_building_type(model)['climate_zone']
+      runner.registerInfo("Using climate zone #{climate_zone} from model")
+    else
+      climate_zone = args['climate_zone']
+      runner.registerInfo("Using climate zone #{climate_zone} from user arguments")
+    end
+    if climate_zone == ''
+      runner.registerError("Could not determine climate zone from measure arguments or model.")
+      return false
+    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'
@@ -2646,13 +2684,6 @@ module OsLib_ModelGeneration
       else
         is_residential = 'No'
       end
-      if !args.has_key?('climate_zone') || args['climate_zone'] == 'Lookup From Model'
-        climate_zone = standard.model_get_building_climate_zone_and_building_type(model)['climate_zone']
-        runner.registerInfo("Using climate zone #{climate_zone} from model")
-      else
-        climate_zone = args['climate_zone']
-        runner.registerInfo("Using climate zone #{climate_zone} from user arguments")
-      end
       bldg_def_const_set = standard.model_add_construction_set(model, climate_zone, lookup_building_type, nil, is_residential)
       if bldg_def_const_set.is_initialized
         bldg_def_const_set = bldg_def_const_set.get
@@ -2797,16 +2828,25 @@ module OsLib_ModelGeneration
       end
     end
 
-    # TODO: - when add methods below add bool to enable/disable them with default value to true
+    # add_daylighting_controls (since outdated measure don't have this default to true if arg not found)
+    if !args.has_key?('add_daylighting_controls')
+      args['add_daylighting_controls'] = true
+    end
+    if args['add_daylighting_controls']
+      # remove add_daylighting_controls objects
+      if args['remove_objects']
+        model.getDaylightingControls.each(&:remove)
+      end
 
-    # add daylight controls, need to perform a sizing run for 2010
-    if args['template'] == '90.1-2010'
-      if standard.model_run_sizing_run(model, "#{Dir.pwd}/SRvt") == false
-        log_messages_to_runner(runner, debug = true)
-        return false
+      # add daylight controls, need to perform a sizing run for 2010
+      if args['template'] == '90.1-2010'
+        if standard.model_run_sizing_run(model, "#{Dir.pwd}/SRvt") == false
+          log_messages_to_runner(runner, debug = true)
+          return false
+        end
       end
-    end
     standard.model_add_daylighting_controls(model)
+    end
 
     # add refrigeration
     if args['add_refrigeration']
@@ -3034,20 +3074,6 @@ module OsLib_ModelGeneration
       end
     end
 
-    # add internal mass
-    if args['add_internal_mass']
-
-      if args['remove_objects']
-        model.getSpaceLoads.each do |instance|
-          next unless instance.to_InternalMass.is_initialized
-          instance.remove
-        end
-      end
-
-      # add internal mass to conditioned spaces; needs to happen after thermostats are applied
-      standard.model_add_internal_mass(model, primary_bldg_type)
-    end
-
     # set unmet hours tolerance
     unmet_hrs_tol_r = args['unmet_hours_tolerance']
     unmet_hrs_tol_k = OpenStudio.convert(unmet_hrs_tol_r, 'R', 'K').get

data/lib/openstudio/extension/rake_task.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -51,14 +49,17 @@ module OpenStudio
         setup_subtasks(@name)
       end
 
-      def set_extension_class(extension_class)
+      def set_extension_class(extension_class, github_repo = '')
         @extension_class = extension_class
         @extension = extension_class.new
         @root_dir = @extension.root_dir
-        @measures_dir = @extension.measures_dir
+        # Catch if measures_dir is nil, then just make it an empty string
+        @measures_dir = @extension.measures_dir || ''
+        @staged_path = @measures_dir + '/staged'
         @core_dir = @extension.core_dir
         @doc_templates_dir = @extension.doc_templates_dir
         @files_dir = @extension.files_dir
+        @github_repo = github_repo
       end
 
       private
@@ -67,22 +68,20 @@ module OpenStudio
         namespace name do
           desc 'Run the CLI task to check for measure updates'
           task update_measures: ['measures:add_license', 'measures:add_readme', 'measures:copy_resources', 'update_copyright'] do
-            puts 'updating measures...'
+            puts 'updating measures'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             runner.update_measures(@measures_dir)
           end
 
           desc 'List measures'
           task :list_measures do
-            puts 'Listing measures...'
+            puts 'Listing measures'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             runner.list_measures(@measures_dir)
           end
 
           desc 'Use openstudio system ruby to run tests'
           task :test_with_openstudio do
-            # puts Dir.pwd
-            # puts Rake.original_dir
             puts 'testing with openstudio'
             runner = OpenStudio::Extension::Runner.new(Dir.pwd)
             result = runner.test_measures_with_cli(@measures_dir)
@@ -92,12 +91,6 @@ module OpenStudio
             end
           end
 
-          # TODO: Implement this eventually... comment out for now.
-          # desc 'Use openstudio docker image to run tests'
-          # task :test_with_docker do
-          #   puts 'testing with docker'
-          # end
-
           # namespace for measure operations
           namespace 'measures' do
             desc 'Copy the resources files to individual measures'
@@ -145,14 +138,233 @@ module OpenStudio
             runner.update_copyright(@root_dir, @doc_templates_dir)
           end
 
-          desc 'Copy the measures to a location that can be uploaded to BCL'
-          task :stage_bcl do
-            puts 'Staging measures for BCL'
+          desc 'Print the change log from GitHub. Date format: yyyy-mm-dd'
+          task :change_log, [:start_date, :end_date, :apikey] do |t, args|
+            require 'change_log'
+            cl = ChangeLog.new(@github_repo, *args)
+            cl.process
+            cl.print_issues
           end
 
-          desc 'Upload measures from the specified location.'
-          task :push_bcl do
-            puts 'Push measures to BCL'
+          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']
+                keyword = ENV['bcl_search_keyword']
+              else
+                keyword = 'Space'
+              end
+              num_results = 10
+              # bcl.search params: search_string, filter_string, return_all_results?
+              puts "searching BCL measures for keyword: #{keyword}"
+              results = bcl.search(keyword, "fq[]=bundle:nrel_measure&show_rows=#{num_results}", false)
+              puts "there are #{results[:result].count} results"
+              results[:result].each do |res|
+                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