openstudio-extension 0.2.0 → 0.2.5

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

@@ -810,6 +810,7 @@ module OsLib_Reporting
     summary_types << ['Heating Capacity', 'maxHeatingCapacity', 'W', 1, 'Btu/hr', 1]
     summary_types << ['Cooling Capacity', 'maxCoolingCapacity', 'W', 1, 'ton', 1]
     summary_types << ['Water Flow Rate', 'maxWaterFlowRate', 'm^3/s', 4, 'gal/min', 2]
+    summary_types << ['Rated Power', 'ratedPower', 'W', 1, 'W', 1]
     summary_types.each do |s|
       val_name = s[0]
       val_method = s[1]
@@ -1212,37 +1213,34 @@ module OsLib_Reporting
       thermal_zones.each do |zone|
         total_loop_floor_area += zone.floorArea
       end
-      #julien
+
       source_units = 'm^2'
       if is_ip_units
         target_units = 'ft^2'
       else
         target_units = source_units
       end
-      total_loop_floor_area_ip = OpenStudio.convert(total_loop_floor_area, source_units, target_units).get
-      total_loop_floor_area_ip_neat = OpenStudio.toNeatString(total_loop_floor_area_ip, 0, true)
+      total_loop_floor_area = OpenStudio.convert(total_loop_floor_area, source_units, target_units).get
+      total_loop_floor_area_neat = OpenStudio.toNeatString(total_loop_floor_area, 0, true)
 
       # output zone and terminal data
-      #julien
       if is_ip_units
-        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_ip_neat} ft^2", '', thermal_zones.size]
+        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_neat} ft^2", '', thermal_zones.size]
       else
-        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_ip_neat} m^2", '', thermal_zones.size]
+        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_neat} m^2", '', thermal_zones.size]
+      end
+
+      # heating and cooling temperature range data
+      source_units = 'C'
+      if is_ip_units
+        target_units = 'F'
+        target_units_display = 'F'
+      else
+        target_units = source_units
+        target_units_display = 'C'
       end
       if cooling_temp_ranges.empty?
         cooling_temp_ranges_pretty = "can't inspect schedules"
-
-        #julien
-        source_units = 'C'
-        if is_ip_units
-          target_units = 'F'
-          target_units_display = "F"
-        else
-          target_units = source_units
-          target_units_display = "C"
-        end
-
-
       else
         cooling_temp_ranges_pretty = "#{OpenStudio.convert(cooling_temp_ranges.min, source_units, target_units).get.round(1)} to #{OpenStudio.convert(cooling_temp_ranges.max, source_units, target_units).get.round(1)}"
       end
@@ -1251,17 +1249,6 @@ module OsLib_Reporting
       else
         heating_temps_ranges_pretty = "#{OpenStudio.convert(heating_temps_ranges.min, source_units, target_units).get.round(1)} to #{OpenStudio.convert(heating_temps_ranges.max, source_units, target_units).get.round(1)}"
       end
-
-      #julien
-      source_units = 'C'
-      if is_ip_units
-        target_units = 'F'
-        target_units_display = "F"
-      else
-        target_units = source_units
-        target_units_display = "C"
-      end
-      #julien => ok? Tjs dans la boucle?
       output_data_air_loops[:data] << ['Thermal Zones', 'Cooling Setpoint Range', "#{cooling_temp_ranges_pretty} #{target_units_display}", '', '']
       output_data_air_loops[:data] << ['Thermal Zones', 'Heating Setpoint Range', "#{heating_temps_ranges_pretty} #{target_units_display}", '', '']
       output_data_air_loops[:data] << ['Terminal Types Used', terminals.uniq.sort.join(', '), '', '', terminals.size]
@@ -3024,6 +3011,13 @@ module OsLib_Reporting
     ann_env_pd = OsLib_Reporting.ann_env_pd(sqlFile)
     if ann_env_pd
 
+      # store values about humidity fir reguster values
+      zone_max_hours_over_70_rh = 0
+      zone_max_hours_over_55_rh = 0
+      rh_hours_threshold = 10 #hr
+      num_zones_x_hours_over_70 = 0
+      num_zones_x_hours_over_55 = 0
+
       # get keys
       keys = sqlFile.availableKeyValues(ann_env_pd, 'Hourly', 'Zone Air Relative Humidity')
       keys.each do |key|
@@ -3032,6 +3026,10 @@ module OsLib_Reporting
           humidity_bins[k] = 0
         end
 
+        # reset humidity zone flag
+        zone_rh_count_hr_55 = 0.0
+        zone_rh_count_hr_70 = 0.0
+
         # get desired variable
         output_timeseries = sqlFile.timeSeries(ann_env_pd, 'Hourly', 'Zone Air Relative Humidity', key)
         # loop through timeseries and move the data from an OpenStudio timeseries to a normal Ruby array (vector)
@@ -3079,11 +3077,34 @@ module OsLib_Reporting
           else
             row_color << ''
           end
+
+          # populate rh data for register_values
+          # catch greater than 70 and 80 for runner.registerValue
+          if ['55-60','60-65','65-70','70-75','75-80','>= 80'].include?(k)
+            zone_rh_count_hr_55 += v
+          end
+          if ['70-75','75-80','>= 80'].include?(k)
+            zone_rh_count_hr_70 += v
+          end
+
         end
         row_data += ["#{mean.round(1)} (%)"]
         row_color += ['']
         humidity_table[:data] << row_data
         humidity_table[:data_color] << row_color
+
+        # apply rh zones and max hours
+        if zone_rh_count_hr_55 >= rh_hours_threshold then num_zones_x_hours_over_55 += 1 end
+        if zone_rh_count_hr_70 >= rh_hours_threshold  then num_zones_x_hours_over_70 += 1 end
+        if zone_max_hours_over_55_rh < zone_rh_count_hr_55 then zone_max_hours_over_55_rh = zone_rh_count_hr_55 end
+        if zone_max_hours_over_70_rh < zone_rh_count_hr_70 then zone_max_hours_over_70_rh = zone_rh_count_hr_70 end
+
+        # add rh runner.registerValues to be used as output in analyses
+        runner.registerValue("zone_max_hours_over_70_rh",zone_max_hours_over_70_rh,"hr")
+        runner.registerValue("zone_max_hours_over_55_rh",zone_max_hours_over_55_rh,"hr")
+        runner.registerValue("num_zones_x_hours_over_70",num_zones_x_hours_over_70,"zones")
+        runner.registerValue("num_zones_x_hours_over_55",num_zones_x_hours_over_55,"zones")
+
       end
     else
       runner.registerWarning('An annual simulation was not run. Cannot get annual timeseries data')
@@ -4649,4 +4670,86 @@ module OsLib_Reporting
 
     return @schedules_overview_section
   end
-end
+
+  # create measure_warning_section (creates tables and runner.registerValues)
+  def self.measure_warning_section(model, sqlFile, runner, name_only = false, is_ip_units = true)
+    # array to hold tables
+    measure_tables = []
+
+    # gather data for section
+    @measure_warnings_section = {}
+    @measure_warnings_section[:title] = 'Measure Warnings'
+    @measure_warnings_section[:tables] = measure_tables
+
+    # stop here if only name is requested this is used to populate display name for arguments
+    if name_only == true
+      return @measure_warnings_section
+    end
+
+    # will be used for registerValues
+    num_measures_with_warnings = 0
+    num_warnings = 0
+    num_measures = 0
+
+    # loop through workflow steps
+    runner.workflow.workflowSteps.each do |step|
+      if step.to_MeasureStep.is_initialized
+        measure_step = step.to_MeasureStep.get
+        measure_name = measure_step.measureDirName
+        num_measures += 1
+        if measure_step.name.is_initialized
+          measure_name = measure_step.name.get # this is instance name in PAT
+        end
+        if measure_step.result.is_initialized
+          result = measure_step.result.get
+          # create and populate table if warnings exist
+          if result.warnings.size > 0
+            measure_table_01 = {}
+            measure_table_01[:title] = measure_name
+            measure_table_01[:header] = ['Warning']
+            measure_table_01[:data] = []
+            num_measures_with_warnings += 1
+
+            # step through warnings
+            start_counter = num_warnings
+            result.warnings.each do |step|
+              # add rows to table and register value
+              num_warnings += 1
+              if num_warnings < start_counter + 25
+                measure_table_01[:data] << [step.logMessage]
+              else
+                measure_table_01[:data] << ["* See OSW file for full list of warnings. This measure has #{result.warnings.size} warnings."]
+              end
+            end
+            # add table to section
+            measure_tables << measure_table_01
+          end
+        else
+          # puts "No result for #{measure_name}"
+        end
+      else
+        # puts "This step is not a measure"
+      end
+    end
+
+    # add summary table (even when there are no warnings)
+    measure_table_summary = {}
+    measure_table_summary[:title] = "Measure Warning Summary"
+    measure_table_summary[:header] = ['Description','Count']
+    measure_table_summary[:data] = []
+
+    # add summary rows
+    measure_table_summary[:data] << ['Number of measures in workflow',num_measures]
+    measure_table_summary[:data] << ['Number of measures with warnings',num_measures_with_warnings]
+    measure_table_summary[:data] << ['Total number of warnings',num_warnings]
+
+    # add table to section
+    measure_tables << measure_table_summary
+
+    runner.registerValue("number_of_measures_with_warnings", num_measures_with_warnings)
+    runner.registerValue("number_warnings", num_warnings)
+
+    return @measure_warnings_section
+  end
+
+end

data/lib/openstudio/extension/rake_task.rb

@@ -49,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
@@ -65,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)
@@ -90,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'
@@ -143,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