openstudio-extension 0.1.5 → 0.1.6

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,7 +197,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

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

@@ -1,259 +0,0 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
-# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# *******************************************************************************
-
-module OsLib_Cofee
-
-  # create def to use later to make bar
-  def OsLib_Cofee.createBar(model, spaceTypeHash,lengthXTarget,lengthYTarget,totalFloorArea,numStories,midFloorMultiplier,xmin,ymin,lengthX,lengthY,zmin,zmax,endZones)
-
-    # floor to floor height
-    floor_to_floor_height = (zmax-zmin)/numStories
-
-    # perimeter depth
-    perimeterDepth = OpenStudio::convert(12,"ft","m").get
-    perimeterBufferFactor = 1.5 # this is a margin below which I won't bother splitting the two largest spaces
-
-    # create an array to control sort order of spaces in bar
-    customSpaceTypeBar = []
-    counter = 0
-    spaceTypeHash.sort_by {|key, value| value}.reverse.each do |k,v|
-      next if v == 0 # this line adds support for fractional values of 0
-      if counter == 1
-        if lengthXTarget*(v/totalFloorArea) > perimeterDepth * perimeterBufferFactor and endZones
-          customSpaceTypeBar << [k,totalFloorArea * (perimeterDepth/lengthXTarget)]
-          customSpaceTypeBar << [k,v - (totalFloorArea * (perimeterDepth/lengthXTarget))]
-        else
-          customSpaceTypeBar << [k,v]
-        end
-      elsif counter > 1
-        customSpaceTypeBar << [k,v]
-      end
-      counter += 1
-    end
-
-    # add the largest space type to the end
-    counter = 0
-    spaceTypeHash.sort_by {|key, value| value}.reverse.each do |k,v|
-      if counter == 0
-        # if width is greater than 1.5x perimeter depth then split in half
-        if lengthXTarget*(v/totalFloorArea) > perimeterDepth * perimeterBufferFactor and endZones
-          customSpaceTypeBar << [k,v - (totalFloorArea * (perimeterDepth/lengthXTarget))]
-          customSpaceTypeBar << [k,totalFloorArea * (perimeterDepth/lengthXTarget)]
-        else
-          customSpaceTypeBar << [k,v]
-        end
-      end
-      break
-    end
-
-    # starting z level
-    z = zmin
-    storyCounter = 0
-    barSpaceArray = []
-
-    # create new stories and then add spaces
-    [numStories,3].min.times do # no more than tree loops through this
-      story = OpenStudio::Model::BuildingStory.new(model)
-      story.setNominalFloortoFloorHeight(floor_to_floor_height)
-      story.setNominalZCoordinate(z)
-
-      # starting position for first space
-      x = (lengthX - lengthXTarget)*0.5 + xmin
-      y = (lengthY - lengthYTarget)*0.5 + ymin
-
-      # temp array of spaces (this is to change floor boundary when there is mid floor multiplier)
-      tempSpaceArray = []
-
-      # loop through space types making diagram and spaces.
-      #spaceTypeHash.sort_by {|key, value| value}.reverse.each do |k,v|
-      customSpaceTypeBar.each do |object|
-
-        # get values from what was hash
-        k = object[0]
-        v = object[1]
-
-        # get proper zone multiplier value
-        if storyCounter == 1 and midFloorMultiplier > 1
-          thermalZoneMultiplier = midFloorMultiplier
-        else
-          thermalZoneMultiplier = 1
-        end
-
-        options = {
-            "name" => nil,
-            "spaceType" => k,
-            "story" => story,
-            "makeThermalZone" => true,
-            "thermalZone" => nil,
-            "thermalZoneMultiplier" => thermalZoneMultiplier,
-            "floor_to_floor_height" => floor_to_floor_height,
-        }
-
-        # three paths for spaces depending upon building depth (3, 2 or one cross slices)
-        if lengthYTarget > perimeterDepth * 3  # slice into core and perimeter
-
-          # perimeter polygon a
-          perim_polygon_a = OpenStudio::Point3dVector.new
-          perim_origin_a = OpenStudio::Point3d.new(x,y,z)
-          perim_polygon_a << perim_origin_a
-          perim_polygon_a << OpenStudio::Point3d.new(x,y + perimeterDepth,z)
-          perim_polygon_a << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + perimeterDepth,z)
-          perim_polygon_a << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y,z)
-
-          # create core polygon
-          core_polygon = OpenStudio::Point3dVector.new
-          core_origin = OpenStudio::Point3d.new(x,y + perimeterDepth,z)
-          core_polygon << core_origin
-          core_polygon << OpenStudio::Point3d.new(x,y + lengthYTarget - perimeterDepth,z)
-          core_polygon << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget - perimeterDepth,z)
-          core_polygon << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + perimeterDepth,z)
-
-          # perimeter polygon b                              w
-          perim_polygon_b = OpenStudio::Point3dVector.new
-          perim_origin_b = OpenStudio::Point3d.new(x,y + lengthYTarget - perimeterDepth,z)
-          perim_polygon_b << perim_origin_b
-          perim_polygon_b << OpenStudio::Point3d.new(x,y + lengthYTarget,z)
-          perim_polygon_b << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget,z)
-          perim_polygon_b << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget - perimeterDepth,z)
-
-          # run method to make spaces
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,perim_origin_a,perim_polygon_a,options) # model, origin, polygon, options
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,core_origin,core_polygon,options) # model, origin, polygon, options
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,perim_origin_b,perim_polygon_b,options) # model, origin, polygon, options
-
-        elsif lengthYTarget > perimeterDepth * 2  # slice into two peremeter zones but no core
-
-          # perimeter polygon a
-          perim_polygon_a = OpenStudio::Point3dVector.new
-          perim_origin_a = OpenStudio::Point3d.new(x,y,z)
-          perim_polygon_a << perim_origin_a
-          perim_polygon_a << OpenStudio::Point3d.new(x,y + lengthYTarget/2,z)
-          perim_polygon_a << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget/2,z)
-          perim_polygon_a << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y,z)
-
-          # perimeter polygon b
-          perim_polygon_b = OpenStudio::Point3dVector.new
-          perim_origin_b = OpenStudio::Point3d.new(x,y + lengthYTarget/2,z)
-          perim_polygon_b << perim_origin_b
-          perim_polygon_b << OpenStudio::Point3d.new(x,y + lengthYTarget,z)
-          perim_polygon_b << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget,z)
-          perim_polygon_b << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget/2,z)
-
-          # run method to make spaces
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,perim_origin_a,perim_polygon_a,options) # model, origin, polygon, options
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,perim_origin_b,perim_polygon_b,options) # model, origin, polygon, options
-
-        else # don't slice into core and perimeter
-
-          # create polygon
-          core_polygon = OpenStudio::Point3dVector.new
-          core_origin = OpenStudio::Point3d.new(x,y,z)
-          core_polygon << core_origin
-          core_polygon << OpenStudio::Point3d.new(x,y + lengthYTarget,z)
-          core_polygon << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y + lengthYTarget,z)
-          core_polygon << OpenStudio::Point3d.new(x + lengthXTarget*(v/totalFloorArea),y,z)
-
-          # run method to make space
-          tempSpaceArray << OsLib_Geometry.makeSpaceFromPolygon(model,core_origin,core_polygon,options) # model, origin, polygon, options
-
-        end
-
-        # update points for next run
-        x += lengthXTarget*(v/totalFloorArea)
-
-      end
-
-      # set flags for adiabatic surfaces
-      floorAdiabatic = false
-      ceilingAdiabatic = false
-
-      # update z
-      if midFloorMultiplier == 1
-        z += floor_to_floor_height
-      else
-        z += floor_to_floor_height * midFloorMultiplier - floor_to_floor_height
-
-        if storyCounter == 0
-          ceilingAdiabatic = true
-        elsif storyCounter == 1
-          floorAdiabatic = true
-          ceilingAdiabatic = true
-        else
-          floorAdiabatic = true
-        end
-
-        # alter surfaces boundary conditions and constructions as described above
-        tempSpaceArray.each do |space|
-          space.surfaces.each do |surface|
-            if surface.surfaceType == "RoofCeiling" and ceilingAdiabatic
-              construction = surface.construction # todo - this isn't really the construction I want since it wasn't an interior one, but will work for now
-              surface.setOutsideBoundaryCondition("Adiabatic")
-              if not construction.empty?
-                surface.setConstruction(construction.get)
-              end
-            end
-            if surface.surfaceType == "Floor" and floorAdiabatic
-              construction = surface.construction # todo - this isn't really the construction I want since it wasn't an interior one, but will work for now
-              surface.setOutsideBoundaryCondition("Adiabatic")
-              if not construction.empty?
-                surface.setConstruction(construction.get)
-              end
-            end
-          end
-        end
-
-        # populate bar space array from temp array
-        barSpaceArray << tempSpaceArray
-
-      end
-
-      # update storyCounter
-      storyCounter += 1
-
-    end
-
-    # surface matching (seems more complex than necessary)
-    spaces = OpenStudio::Model::SpaceVector.new
-    model.getSpaces.each do |space|
-      spaces << space
-    end
-    OpenStudio::Model.matchSurfaces(spaces)
-
-    result = barSpaceArray
-    return result
-
-  end
-
-end