openstudio-extension 0.7.1 → 0.8.0

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

@@ -1,135 +0,0 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-
-module OsLib_OutdoorAirAndInfiltration
-  # delete any infiltration objects used in the model.
-  def self.eraseInfiltrationUsedInModel(model, runner)
-    # get space infiltration objects.
-    space_infiltration_objects = model.getSpaceInfiltrationDesignFlowRates.sort
-
-    # hash to hold schedules used for infiltration objects in the model
-    @infiltrationSchedulesHardAssigned = {}
-
-    def OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
-      # get schedule and add to hash
-      if !space_infiltration_object.isScheduleDefaulted
-        if !space_infiltration_object.schedule.empty?
-          schedule = space_infiltration_object.schedule.get
-          if @infiltrationSchedulesHardAssigned.key?(schedule)
-            @infiltrationSchedulesHardAssigned[schedule] = @infiltrationSchedulesHardAssigned[schedule] + 1
-          else
-            @infiltrationSchedulesHardAssigned[schedule] = 1
-          end
-        end
-      end
-      space_infiltration_object.remove
-    end
-
-    # remove space infiltration objects
-    number_removed = 0
-    number_left = 0
-    space_infiltration_objects.each do |space_infiltration_object|
-      opt_space_type = space_infiltration_object.spaceType
-      if opt_space_type.empty?
-        # add schedule if exists to array and remove object
-        OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
-        number_removed += 1
-      elsif !opt_space_type.get.spaces.empty?
-        # add schedule if exists to array and remove object
-        OsLib_OutdoorAirAndInfiltration.addScheduleToArrayAndRemove(space_infiltration_object)
-        number_removed += 1
-      else
-        number_left += 1
-      end
-    end
-    if number_removed > 0
-      runner.registerInfo("#{number_removed} infiltration objects were removed.")
-    end
-    if number_left > 0
-      runner.registerInfo("#{number_left} infiltration objects in unused space types were left in the model. They will not be altered.")
-    end
-
-    result = @infiltrationSchedulesHardAssigned.sort_by { |k, v| v }.reverse # want schedule with largest key first
-    return result
-  end
-
-  # create new infiltration def and apply it to all spaces throughout the entire building
-  def self.addSpaceInfiltrationDesignFlowRate(model, runner, objects, options = {})
-    # set defaults to use if user inputs not passed in
-    defaults = {
-      'nameSuffix' => ' - infiltration', # add this to object name for infiltration
-      'defaultBuildingSchedule' => nil, # this will set schedule set for selected object
-      'schedule' => nil, # this will hard assign a schedule
-      'setCalculationMethod' => nil, # should be string like setFlowerExteriorSurfaceArea
-      'valueForSelectedCalcMethod' => nil
-    }
-
-    # merge user inputs with defaults
-    options = defaults.merge(options)
-    building = model.getBuilding
-    newSpaceInfiltrationObjects = []
-
-    # set default building infiltration schedule if requested
-    if !options['defaultBuildingSchedule'].nil?
-      if !building.defaultScheduleSet.empty?
-        defaultScheduleSet = building.defaultScheduleSet.get
-      else
-        defaultScheduleSet = OpenStudio::Model::DefaultScheduleSet.new(model)
-        defaultScheduleSet.setName('Default Schedules')
-        building.setDefaultScheduleSet(defaultScheduleSet)
-      end
-      # set requested default schedule
-      defaultScheduleSet.setInfiltrationSchedule(options['defaultBuildingSchedule'])
-    end
-
-    # note: object should be the building, or an array of space and or space types
-    if objects == building
-      # if no default space type then add an empty one (to hold new space infiltration object)
-      if building.spaceType.empty?
-        new_default = OpenStudio::Model::SpaceType.new(model)
-        new_default.setName('Building Default Space Type')
-        building.setSpaceType(new_default)
-        runner.registerInfo("Adding a building default space type to hold space infiltration for spaces that previously didn't have a space type.")
-      end
-
-      # change objects to be all space types used in the model
-      objects = []
-      space_types = model.getSpaceTypes.sort
-      space_types.each do |space_type|
-        if !space_type.spaces.empty?
-          objects << space_type
-        end
-      end
-    end
-
-    # loop through objects
-    objects.each do |object|
-      # create the infiltration object and associate with space or space type
-      new_infil = OpenStudio::Model::SpaceInfiltrationDesignFlowRate.new(model)
-      newSpaceInfiltrationObjects << new_infil
-      eval("new_infil.#{options['setCalculationMethod']}(#{options['valueForSelectedCalcMethod']})")
-      if !object.to_SpaceType.empty?
-        new_infil.setSpaceType(object)
-      elsif !object.to_Space.empty?
-        new_infil.setSpace(object)
-      else
-        runner.registerWarning("#{object.name} isn't a space or a space type. Can't assign infiltration object to it.")
-      end
-      new_infil.setName("#{object.name} #{options['nameSuffix']}")
-
-      # set hard assigned schedule if requested
-      if options['schedule']
-        new_infil.setSchedule(options['schedule'])
-      end
-
-      if new_infil.schedule.empty?
-        runner.registerWarning("The new infiltration object for space type '#{object.name}' does not have a schedule. Assigning a default schedule set including an infiltration schedule to the space type or the building will address this.")
-      end
-    end
-
-    result = newSpaceInfiltrationObjects
-    return result
-  end
-end

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

@@ -1,170 +0,0 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-
-require 'json'
-
-module OsLib_Reporting
-  # setup - get model, sql, and setup web assets path
-  def self.setup(runner)
-    results = {}
-
-    # get the last model
-    model = runner.lastOpenStudioModel
-    if model.empty?
-      runner.registerError('Cannot find last model.')
-      return false
-    end
-    model = model.get
-
-    # get the last idf
-    workspace = runner.lastEnergyPlusWorkspace
-    if workspace.empty?
-      runner.registerError('Cannot find last idf file.')
-      return false
-    end
-    workspace = workspace.get
-
-    # get the last sql file
-    sqlFile = runner.lastEnergyPlusSqlFile
-    if sqlFile.empty?
-      runner.registerError('Cannot find last sql file.')
-      return false
-    end
-    sqlFile = sqlFile.get
-    model.setSqlFile(sqlFile)
-
-    # populate hash to pass to measure
-    results[:model] = model
-    # results[:workspace] = workspace
-    results[:sqlFile] = sqlFile
-    results[:web_asset_path] = OpenStudio.getSharedResourcesPath / OpenStudio::Path.new('web_assets')
-
-    return results
-  end
-
-  # cleanup - prep html
-  def self.gen_html(html_in_path, web_asset_path, sections, name)
-    # instance variables for erb
-    @sections = sections
-    @name = name
-
-    # read in template
-    if File.exist?(html_in_path)
-      html_in_path = html_in_path
-    else
-      html_in_path = "#{File.dirname(__FILE__)}/report.html.erb"
-    end
-    html_in = ''
-    File.open(html_in_path, 'r') do |file|
-      html_in = file.read
-    end
-
-    # configure template with variable values
-    renderer = ERB.new(html_in)
-    html_out = renderer.result(binding)
-
-    # write html file
-    html_out_path = './report.html'
-    File.open(html_out_path, 'w') do |file|
-      file << html_out
-      # make sure data is written to the disk one way or the other
-      begin
-        file.fsync
-      rescue StandardError
-        file.flush
-      end
-    end
-
-    return html_out_path
-  end
-
-  # developer notes
-  # method below is custom version of standard OpenStudio results methods. It passes an array of sections vs. a single section.
-  # It doesn't use the model or SQL file. It just gets data form OpenStudio attributes passed in
-  # It doesn't have a name_only section since it doesn't populate user arguments
-
-  def self.sections_from_check_attributes(check_elems, runner)
-    # inspecting check attributes
-    # make single table with checks.
-    # make second table with flag description (with column for where it came from)
-
-    # array to hold sections
-    sections = []
-
-    # gather data for section
-    qaqc_check_summary = {}
-    qaqc_check_summary[:title] = 'List of Checks in Measure'
-    qaqc_check_summary[:header] = ['Name', 'Category', 'Flags', 'Description']
-    qaqc_check_summary[:data] = []
-    qaqc_check_summary[:data_color] = []
-    @qaqc_check_section = {}
-    @qaqc_check_section[:title] = 'QAQC Check Summary'
-    @qaqc_check_section[:tables] = [qaqc_check_summary]
-
-    # add sections to array
-    sections << @qaqc_check_section
-
-    # counter for flags thrown
-    num_flags = 0
-
-    check_elems.each do |check|
-      # gather data for section
-      qaqc_flag_details = {}
-      qaqc_flag_details[:title] = "List of Flags Triggered for #{check.valueAsAttributeVector.first.valueAsString}."
-      qaqc_flag_details[:header] = ['Flag Detail']
-      qaqc_flag_details[:data] = []
-      @qaqc_flag_section = {}
-      @qaqc_flag_section[:title] = check.valueAsAttributeVector.first.valueAsString.to_s
-      @qaqc_flag_section[:tables] = [qaqc_flag_details]
-
-      check_name = nil
-      check_cat = nil
-      check_desc = nil
-      flags = []
-      # loop through attributes (name,category,description,then optionally one or more flag attributes)
-      check.valueAsAttributeVector.each_with_index do |value, index|
-        if index == 0
-          check_name = value.valueAsString
-        elsif index == 1
-          check_cat = value.valueAsString
-        elsif index == 2
-          check_desc = value.valueAsString
-        else # should be flag
-          flags << value.valueAsString
-          qaqc_flag_details[:data] << [value.valueAsString]
-          runner.registerWarning("#{check_name} - #{value.valueAsString}")
-          num_flags += 1
-        end
-      end
-
-      # add row to table for this check
-      qaqc_check_summary[:data] << [check_name, check_cat, flags.size, check_desc]
-
-      # add info message for check if no flags found (this way user still knows what ran)
-      if check.valueAsAttributeVector.size < 4
-        runner.registerInfo("#{check_name} - no flags.")
-      end
-
-      # color cells based and add runner register values based on flag status
-      if !flags.empty?
-        qaqc_check_summary[:data_color] << ['', '', 'indianred', '']
-        runner.registerValue(check_name.downcase.tr(' ', '_'), flags.size, 'flags')
-      else
-        qaqc_check_summary[:data_color] << ['', '', 'lightgreen', '']
-        runner.registerValue(check_name.downcase.tr(' ', '_'), flags.size, 'flags')
-      end
-
-      # add table for this check if there are flags
-      if !qaqc_flag_details[:data].empty?
-        sections << @qaqc_flag_section
-      end
-    end
-
-    # add total flags registerValue
-    runner.registerValue('total_qaqc_flags', num_flags, 'flags')
-
-    return sections
-  end
-end