openstudio-extension 0.1.6 → 0.2.0

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

@@ -810,7 +810,6 @@ 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]
@@ -1213,34 +1212,37 @@ 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 = OpenStudio.convert(total_loop_floor_area, source_units, target_units).get
-      total_loop_floor_area_neat = OpenStudio.toNeatString(total_loop_floor_area, 0, true)
+      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)
 
       # output zone and terminal data
+      #julien
       if is_ip_units
-        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_neat} ft^2", '', thermal_zones.size]
+        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_ip_neat} ft^2", '', thermal_zones.size]
       else
-        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'
+        output_data_air_loops[:data] << ['Thermal Zones', 'Total Floor Area', "#{total_loop_floor_area_ip_neat} m^2", '', thermal_zones.size]
       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
@@ -1249,6 +1251,17 @@ 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]
@@ -3011,13 +3024,6 @@ 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|
@@ -3026,10 +3032,6 @@ 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)
@@ -3077,34 +3079,11 @@ 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')
@@ -4670,86 +4649,4 @@ module OsLib_Reporting
 
     return @schedules_overview_section
   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
+end

data/lib/openstudio/extension/runner.rb

@@ -56,18 +56,17 @@ 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. Note if options is used, then a local runner.conf file will not be loaded.
+      #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods.
       #  @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.empty?
+        if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && !options
           puts 'Using runner options from runner.conf file'
           runner_config = OpenStudio::Extension::RunnerConfig.new(dirname)
           @options = runner_config.options

data/lib/openstudio/extension/runner_config.rb

@@ -104,19 +104,6 @@ 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

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.1.6'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/openstudio-extension.gemspec

@@ -5,29 +5,35 @@ require 'openstudio/extension/version'
 Gem::Specification.new do |spec|
   spec.name          = 'openstudio-extension'
   spec.version       = OpenStudio::Extension::VERSION
-  spec.authors       = ['Katherine Fleming', 'Nicholas Long', 'Dan Macumber']
-  spec.email         = ['katherine.fleming@nrel.gov', 'nicholas.long@nrel.gov', 'daniel.macumber@nrel.gov']
   spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Katherine Fleming', 'Nicholas Long', 'Daniel Macumber']
+  spec.email         = ['katherine.fleming@nrel.gov', 'nicholas.long@nrel.gov', 'daniel.macumber@nrel.gov']
 
+  spec.homepage      = 'https://openstudio.net'
   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.homepage      = 'https://openstudio.net'
+  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}"
+  }
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bundler', '~> 1.9'
-  spec.add_dependency 'json_pure', '2.2.0'
+  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.1.7'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.0'
   spec.add_dependency 'parallel', '~> 1.12.0'
 
+  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'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Katherine Fleming
 - Nicholas Long
-- Dan Macumber
+- Daniel Macumber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,70 +18,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: openstudio-workflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
-  name: openstudio-workflow
+  name: openstudio_measure_tester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: openstudio_measure_tester
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: github_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
-  type: :runtime
+        version: 0.18.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - init_templates/template_gemfile.txt
 - init_templates/template_rakefile.txt
 - init_templates/version.rb
+- lib/change_log.rb
 - lib/files/openstudio-extension-gem-test.ddy
 - lib/files/openstudio-extension-gem-test.epw
 - lib/files/openstudio-extension-gem-test.stat
@@ -197,6 +198,7 @@ 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
@@ -215,16 +217,19 @@ files:
 - openstudio-extension.gemspec
 homepage: https://openstudio.net
 licenses: []
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -232,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: openstudio base gem for creating generic extensions with encapsulated data