openstudio-extension 0.2.0 → 0.2.1

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

@@ -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/extension/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -56,17 +58,18 @@ module OpenStudio
       ##
       #  @param [String] dirname Directory to run commands in, defaults to Dir.pwd. If directory includes a Gemfile then create a local bundle.
       #  @param bundle_without [Hash] Hash describing the distribution of the variable.
-      #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods.
+      #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods. Note if options is used, then a local runner.conf file will not be loaded.
       #  @option options [String] :max_datapoints Max number of datapoints to run
       #  @option options [String] :num_parallel Number of simulations to run in parallel at a time
       #  @option options [String] :run_simulations Set to true to run the simulations
       #  @option options [String] :verbose Set to true to receive extra information while running simulations
       def initialize(dirname = Dir.pwd, bundle_without = [], options = {})
         # DLM: I am not sure if we want to use the main root directory to create these bundles
-        # had the idea of passing in a Gemfile name/alias and path to Gemfile, then doing the bundle in ~/OpenStudio/#{alias} or something like that?
+        # had the idea of passing in a Gemfile name/alias and path to Gemfile, then doing the bundle
+        # in ~/OpenStudio/#{alias} or something like that?
 
         # if the dirname contains a runner.conf file, then use the config file to specify the parameters
-        if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && !options
+        if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && options.empty?
           puts 'Using runner options from runner.conf file'
           runner_config = OpenStudio::Extension::RunnerConfig.new(dirname)
           @options = runner_config.options
@@ -562,14 +565,14 @@ module OpenStudio
           Dir[path[:glob]].each do |file|
             puts "Updating license in file #{file}"
             f = File.read(file)
-            if f =~ path[:regex]
+            if f.match?(path[:regex])
               puts '  License found -- updating'
               File.open(file, 'w') { |write| write << f.gsub(path[:regex], path[:license]) }
             elsif f =~ /\(C\)/i || f =~ /\(Copyright\)/i
               puts '  File already has copyright -- skipping'
             else
               puts '  No license found -- adding'
-              if f =~ /#!/
+              if f.match?(/#!/)
                 puts '  CANNOT add license to file automatically, add it manually and it will update automatically in the future'
                 next
               end

data/lib/openstudio/extension/runner_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -38,7 +40,7 @@ require 'json'
 module OpenStudio
   module Extension
     class RunnerConfig
-      FILENAME = 'runner.conf'.freeze
+      FILENAME = 'runner.conf'
 
       ##
       # Class to store configuration of the runner options.
@@ -104,6 +106,19 @@ module OpenStudio
         end
       end
 
+      ##
+      # Update a runner config value
+      #
+      # @param [String] key, The name of the key to update
+      # @param [Variant] new_value, The new value to set the `key` to.
+      def update_config(key, new_value)
+        if @data.key? key.to_sym
+          @data[key.to_sym] = new_value
+        else
+          raise "Could not find key '#{key}' to update in RunnerConfig."
+        end
+      end
+
       ##
       # Return the options as hash
       def options

data/lib/openstudio/extension/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -35,6 +37,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.1'
   end
 end

data/openstudio-extension.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'openstudio/extension/version'
@@ -13,10 +15,10 @@ Gem::Specification.new do |spec|
   spec.summary       = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
   spec.description   = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
   spec.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',
-      #'documentation_uri' =>  'https://www.rubydoc.info/gems/openstudio-extension-gem/#{gem.version}',
-      'source_code_uri' => "https://github.com/NREL/openstudio-extension-gem/tree/v#{spec.version}"
+    'bug_tracker_uri' => 'https://github.com/NREL/openstudio-extension-gem/issues',
+    'changelog_uri' => 'https://github.com/NREL/openstudio-extension-gem/blob/develop/CHANGELOG.md',
+    # 'documentation_uri' =>  'https://www.rubydoc.info/gems/openstudio-extension-gem/#{gem.version}',
+    'source_code_uri' => "https://github.com/NREL/openstudio-extension-gem/tree/v#{spec.version}"
   }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -29,12 +31,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.5.0'
 
   spec.add_dependency 'bundler', '~> 2.1'
-  spec.add_dependency 'openstudio-workflow', '~> 1.3.4'
-  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.0'
-  spec.add_dependency 'parallel', '~> 1.12.0'
+  spec.add_dependency 'openstudio-workflow', '~> 2.0.0'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.2'
+  spec.add_dependency 'parallel', '~> 1.19.1'
 
   spec.add_development_dependency 'github_api', '~> 0.18.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,42 +32,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: openstudio_measure_tester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
   name: github_api
   requirement: !ruby/object:Gem::Requirement
@@ -88,42 +88,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.54.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '3.9'
 description: openstudio base gem for creating generic extensions with encapsulated
   data and measures.
 email:
@@ -198,7 +184,6 @@ files:
 - lib/openstudio/extension/core/check_weather_files.rb
 - lib/openstudio/extension/core/deer_vintages.rb
 - lib/openstudio/extension/core/os_lib_aedg_measures.rb
-- lib/openstudio/extension/core/os_lib_cofee.rb
 - lib/openstudio/extension/core/os_lib_constructions.rb
 - lib/openstudio/extension/core/os_lib_geometry.rb
 - lib/openstudio/extension/core/os_lib_helper_methods.rb
@@ -220,7 +205,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.2.0
+  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.2.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -237,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: openstudio base gem for creating generic extensions with encapsulated data