honeybee-openstudio 2.33.6 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb5fa50e1c896889d81a5addfacf5db33e384f9a9c40f32f09c5964e9da2de76
-  data.tar.gz: a6d221fad4de2c03ad3de093b8e430511744e1b5111e372ecf4ffea75d8b6851
+  metadata.gz: 0db23d24e0621410e05134519babfe4ae11c803b8df518b3e587afb836eb0304
+  data.tar.gz: b2984946072c3c094057e5e0f97dd52c15012290fa6953d1b245d95c9f9f6a06
 SHA512:
-  metadata.gz: 04a7362bdc83c91137e6cf6c7bd7f9a8c4d887f39b5b1f7a54d46e86e98fe4c52a1c3690d432fac3f3135c53a85de257885b567156febb88efc9a888669a87a8
-  data.tar.gz: 98e3efbfda5be87a15b3a8cd8f062e38cebc60e872d71439981fc5307df4b72bcd9adaa408d2c83357979f4301ff845930d185a51deb42c9edad831387660582
+  metadata.gz: e948fb628063eb9f0d7bc6477aaa3e05b425cc68ac0e3127472a7a8df34f7050d70901538f39656aaa39198465a6515ccc9697d632d38249ac1914e218f9dafc
+  data.tar.gz: 46cf5d6d1619847528ce5ae15b592dab6c16492b87deb13ca38c5270af7918af581e18891b6062c3904f3b9b0322812815e53cb633dde1699f2b580461650005

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.33.6'
+  spec.version       = '2.34.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/measures/from_honeybee_model/measure.rb

@@ -36,6 +36,7 @@ require 'to_openstudio'
 
 require 'fileutils'
 require 'pathname'
+require 'json'
 
 # start the measure
 class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
@@ -87,17 +88,19 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
       return false
     end
 
+    # get the input arguments
     model_json = runner.getStringArgumentValue('model_json', user_arguments)
     schedule_csv_dir = runner.getStringArgumentValue('schedule_csv_dir', user_arguments)
     include_datetimes = runner.getBoolArgumentValue('include_datetimes', user_arguments)
 
+    # load the HBJSON file
     if !File.exist?(model_json)
       runner.registerError("Cannot find file '#{model_json}'")
       return false
     end
-
     honeybee_model = Honeybee::Model.read_from_disk(model_json)
 
+    # setup the schedule directory
     if schedule_csv_dir && !schedule_csv_dir.empty?
       schedule_csv_dir = Pathname.new(schedule_csv_dir).cleanpath
       if !Dir.exist?(schedule_csv_dir)
@@ -107,11 +110,88 @@ class FromHoneybeeModel < OpenStudio::Measure::ModelMeasure
       honeybee_model.set_schedule_csv_dir(schedule_csv_dir, include_datetimes)
     end
 
+    # translate the Honeybee Model to OSM
     STDOUT.flush
     honeybee_model.to_openstudio_model(model)
     STDOUT.flush
 
+    # if there are any detailed HVACs, incorproate them into the OSM
     generated_files_dir = "#{runner.workflow.absoluteRootDir}/generated_files"
+    unless $detailed_hvac_hash.nil? || $detailed_hvac_hash.empty?
+      runner.registerInfo("Translating Detailed HVAC systems in '#{generated_files_dir}'")
+      if $ironbug_exe.nil?
+        runner.registerError("No Ironbug installation was found on the system.")
+      end
+      FileUtils.mkdir_p(generated_files_dir)
+      $detailed_hvac_hash.each do |hvac_id, hvac_spec|
+        # write the JSON and OSM files
+        hvac_json_path = generated_files_dir + '/' + hvac_id + '.json'
+        osm_path = generated_files_dir + '/' + hvac_id + '.osm'
+        File.open(hvac_json_path, 'w') do |f|
+          f.write(hvac_spec.to_json)
+        end
+        model.save(osm_path, true)
+        # call the Ironbug console to add the HVAC to the OSM
+        ironbug_exe = '"' + $ironbug_exe + '"'
+        system(ironbug_exe + ' "' + osm_path + '" "' + hvac_json_path + '"')
+        # load the new model
+        translator = OpenStudio::OSVersion::VersionTranslator.new
+        o_model = translator.loadModel(osm_path)
+        if o_model.empty?
+          runner.registerError("Could not load Ironbug model from '" + osm_path.to_s + "'.")
+          return false
+        end
+        new_model = o_model.get
+        # replace the current model with the contents of the loaded model
+        handles = OpenStudio::UUIDVector.new
+        model.objects.each do |obj|
+          handles << obj.handle
+        end
+        model.removeObjects(handles)
+        # add new file to empty model
+        model.addObjects(new_model.toIdfFile.objects)
+      end
+    end
+
+    # if an efficiency standard has been set on the model, then run sizing and set everything
+    building = model.getBuilding
+    unless building.standardsTemplate.empty?
+      puts 'Autosizing HVAC systems and assigning efficiencies'
+      standard_id = building.standardsTemplate.get
+      require 'openstudio-standards'
+      standard = Standard.build(standard_id)
+      # Set the heating and cooling sizing parameters
+      standard.model_apply_prm_sizing_parameters(model)
+      # Perform a sizing run
+      if standard.model_run_sizing_run(model, "#{Dir.pwd}/SR1") == false
+        log_messages_to_runner(runner, debug = true)
+        return false
+      end
+      # If there are any multizone systems, reset damper positions
+      # to achieve a 60% ventilation effectiveness minimum for the system
+      # following the ventilation rate procedure from 62.1
+      standard.model_apply_multizone_vav_outdoor_air_sizing(model)
+      # get the climate zone  
+      climate_zone_obj = model.getClimateZones.getClimateZone('ASHRAE', 2006)
+      if climate_zone_obj.empty
+        climate_zone_obj = model.getClimateZones.getClimateZone('ASHRAE', 2013)
+      end
+      climate_zone = climate_zone_obj.value
+      # get the building type
+      bldg_type = nil
+      unless building.standardsBuildingType.empty?
+        bldg_type = building.standardsBuildingType.get
+      end
+      # Apply the prototype HVAC assumptions
+      standard.model_apply_prototype_hvac_assumptions(model, bldg_type, climate_zone)
+      # Apply the HVAC efficiency standard
+      standard.model_apply_hvac_efficiency_standard(model, climate_zone)
+      puts 'Done with autosizing HVAC systems!'
+    end
+
+    puts 'Done with Model translation!'
+
+    # copy the CSV schedules into the directory where EnergyPlus can find them
     if schedule_csv_dir && !schedule_csv_dir.empty?
       if Dir.exist?(schedule_csv_dir)
         runner.registerInfo("Copying exported schedules from '#{schedule_csv_dir}' to '#{generated_files_dir}'")

data/lib/to_openstudio/hvac/Model.hvac.rb

@@ -308,6 +308,10 @@ class OpenStudio::Model::Model
     when 'Furnace'
       # includes ventilation, whereas residential forced air furnace does not.
       standard.model_add_hvac_system(self, 'Forced Air Furnace', ht = 'NaturalGas', znht = nil, cl = nil, heated_zones)
+    
+    when 'Furnace_Electric'
+      # includes ventilation, whereas residential forced air furnace does not.
+      standard.model_add_hvac_system(self, 'Forced Air Furnace', ht = 'Electricity', znht = nil, cl = nil, heated_zones)
 
     when 'GasHeaters'
       standard.model_add_hvac_system(self, 'Unit Heaters', ht = 'NaturalGas', znht = nil, cl = nil, heated_zones)

data/lib/to_openstudio/hvac/template.rb

@@ -90,26 +90,28 @@ module Honeybee
 
       # Get the air loops and assign the display name to the air loop name if it exists
       os_air_loops = []
-      air_loops = openstudio_model.getAirLoopHVACs
-      unless air_loops.length == $air_loop_count  # check if any new loops were added
-        $air_loop_count = air_loops.length
-        zones.each do |zon|
-          os_air_terminal = zon.airLoopHVACTerminal
-          unless os_air_terminal.empty?
-            os_air_terminal = os_air_terminal.get
-            os_air_loop_opt = os_air_terminal.airLoopHVAC
-            unless os_air_loop_opt.empty?
-              os_air_loop = os_air_loop_opt.get
-              os_air_loops << os_air_loop
-              loop_name = os_air_loop.name
-              unless loop_name.empty?
-                # set the name of the air loop to align with the HVAC name
-                if @hash[:display_name]
-                  clean_name = @hash[:display_name].to_s.gsub(/[^.A-Za-z0-9_-] /, " ")
-                  os_air_loop.setName(clean_name + ' - ' + loop_name.get)
+      unless equipment_type.to_s.include? 'Furnace'
+        air_loops = openstudio_model.getAirLoopHVACs
+        unless air_loops.length == $air_loop_count
+          $air_loop_count = air_loops.length
+          zones.each do |zon|
+            os_air_terminal = zon.airLoopHVACTerminal
+            unless os_air_terminal.empty?
+              os_air_terminal = os_air_terminal.get
+              os_air_loop_opt = os_air_terminal.airLoopHVAC
+              unless os_air_loop_opt.empty?
+                os_air_loop = os_air_loop_opt.get
+                os_air_loops << os_air_loop
+                loop_name = os_air_loop.name
+                unless loop_name.empty?
+                  # set the name of the air loop to align with the HVAC name
+                  if @hash[:display_name]
+                    clean_name = @hash[:display_name].to_s.gsub(/[^.A-Za-z0-9_-] /, " ")
+                    os_air_loop.setName(clean_name + ' - ' + loop_name.get)
+                  end
                 end
+                break if !equipment_type.include? 'PSZ'  # multiple air loops have been added
               end
-              break if !equipment_type.include? 'PSZ'  # multiple air loops have been added
             end
           end
         end
@@ -197,6 +199,21 @@ module Honeybee
         end
       end
 
+      # change furnace to electric if specified
+      if equipment_type.to_s.include? 'Furnace_Electric'
+        openstudio_model.getAirLoopHVACUnitarySystems.sort.each do |obj|
+          unless obj.heatingCoil.empty?
+            old_coil = obj.heatingCoil.get
+            heat_coil = OpenStudio::Model::CoilHeatingElectric.new(openstudio_model)
+            unless old_coil.name.empty?
+              heat_coil.setName(old_coil.name.get)
+            end
+            obj.setHeatingCoil(heat_coil)
+            old_coil.remove()
+          end
+        end
+      end
+
       # assign the economizer type if there's an air loop and the economizer is specified
       if @hash[:economizer_type] && !os_air_loops.empty?
         os_air_loops.each do |os_air_loop|

data/lib/to_openstudio/model.rb

@@ -92,10 +92,6 @@ module Honeybee
       # create all openstudio objects in the model
       create_openstudio_objects(log_report)
 
-      if log_report
-        puts 'Done with Model translation!'
-      end
-
       @openstudio_model
     end
 
@@ -105,7 +101,9 @@ module Honeybee
     def create_openstudio_objects(log_report=true)
       # assign a standards building type so that David's measures can run
       building = @openstudio_model.getBuilding
-      building.setStandardsBuildingType('MediumOffice')
+      if building.standardsBuildingType.empty?
+        building.setStandardsBuildingType('MediumOffice')
+      end
 
       # initialize a global variable for whether the AFN is used instead of simple ventilation
       $use_simple_vent = true
@@ -127,6 +125,8 @@ module Honeybee
       $programtype_setpoint_hash = Hash.new  # hash to track Setpoint objects
       $interior_afn_srf_hash = Hash.new  # track whether an adjacent surface is already in the AFN
       $shw_for_plant = nil  # track whether a hot water plant is needed
+      $detailed_hvac_hash = Hash.new  # track the detailed HVAC systems that have been assigned
+      $ironbug_exe = nil  # ironbug executable; will be overwritten by any detailed HVACs
 
       # create all of the non-geometric model elements
       if @hash[:properties].key?(:energy)
@@ -572,6 +572,11 @@ module Honeybee
                 end
               end
             end
+          elsif system_type == 'DetailedHVAC'
+            $detailed_hvac_hash[hvac[:identifier]] = hvac[:specification]
+            unless hvac[:ironbug_exe].nil?
+              $ironbug_exe = hvac[:ironbug_exe]
+            end
           elsif TemplateHVAC.types.include?(system_type)
             template_system = TemplateHVAC.new(hvac)
             template_system.to_openstudio(@openstudio_model, hvac['rooms'])

data/lib/to_openstudio/simulation/parameter_model.rb

@@ -35,6 +35,16 @@ require 'openstudio'
 
 module Honeybee
   class SimulationParameter
+    @@standard_mapper = {
+      DOE_Ref_Pre_1980: 'DOE Ref Pre-1980',
+      DOE_Ref_1980_2004: 'DOE Ref 1980-2004',
+      ASHRAE_2004: '90.1-2004',
+      ASHRAE_2007: '90.1-2007',
+      ASHRAE_2010: '90.1-2010',
+      ASHRAE_2013: '90.1-2013',
+      ASHRAE_2016: '90.1-2016',
+      ASHRAE_2019: '90.1-2019'
+    }
 
     # convert to openstudio model, clears errors and warnings
     def to_openstudio_model(openstudio_model=nil, log_report=false)
@@ -226,6 +236,22 @@ module Honeybee
         climate_zone_objs.setClimateZone('ASHRAE', cz)
       end
 
+      # note any efficency standards that have been assigned to the 
+      if @hash[:sizing_parameter]
+        if @hash[:sizing_parameter][:efficiency_standard]
+          std_gem_standard = @@standard_mapper[@hash[:sizing_parameter][:efficiency_standard].to_sym]
+          building = @openstudio_model.getBuilding
+          building.setStandardsTemplate(std_gem_standard)
+        end
+        if @hash[:sizing_parameter][:climate_zone]
+          climate_zone_objs.setClimateZone('ASHRAE', @hash[:sizing_parameter][:climate_zone])
+        end
+        if @hash[:sizing_parameter][:building_type]
+          building = @openstudio_model.getBuilding
+          building.setStandardsBuildingType(@hash[:sizing_parameter][:building_type])
+        end
+      end
+
       # set Outputs for the simulation
       if @hash[:output]
         if @hash[:output][:outputs]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.33.6
+  version: 2.34.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure