honeybee-openstudio 2.15.0 → 2.16.4

data/lib/measures/from_openstudio_model/tests/from_openstudio_model_test.rb

@@ -0,0 +1,107 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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.
+# *******************************************************************************
+
+require 'openstudio'
+require 'openstudio/ruleset/ShowRunnerOutput'
+require 'minitest/autorun'
+require_relative '../measure.rb'
+require 'fileutils'
+
+class FromOpenstudioModel_Test < Minitest::Test
+  # method to apply arguments, run measure, and assert results (only populate args hash with non-default argument values)
+  def apply_measure_to_model(test_name, args, model_name = nil, result_value = 'Success', warnings_count = 0, info_count = nil)
+    # create an instance of the measure
+    measure = FromOpenstudioModel.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    if model_name.nil?
+      # make an empty model
+      model = OpenStudio::Model::Model.new
+    else
+      # load the test model
+      translator = OpenStudio::OSVersion::VersionTranslator.new
+      path = OpenStudio::Path.new(File.dirname(__FILE__) + '/' + model_name)
+      model = translator.loadModel(path)
+      assert(!model.empty?)
+      model = model.get
+    end
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args.key?(arg.name)
+        assert(temp_arg_var.setValue(args[arg.name]), "could not set #{arg.name} to #{args[arg.name]}.")
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    puts "this is measure #{measure.run(model, runner, argument_map)}"
+    # show the output
+    puts "measure results for #{test_name}"
+    show_output(result)
+
+    # assert that it ran correctly
+    if result_value.nil? then result_value = 'Success' end
+    assert_equal(result_value, result.value.valueName)
+
+    # check count of warning and info messages
+    unless info_count.nil? then assert(result.info.size == info_count) end
+    unless warnings_count.nil? then assert(result.warnings.size == warnings_count, "warning count (#{result.warnings.size}) did not match expectation (#{warnings_count})") end
+
+    # if 'Fail' passed in make sure at least one error message (while not typical there may be more than one message)
+    if result_value == 'Fail' then assert(result.errors.size >= 1) end
+
+  end
+
+  def test_example_model_with_output_path
+    args = {}
+    args['openstudio_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/osm/exampleModel.osm')
+    args['output_file_path'] = File.join(File.dirname(__FILE__) + '/output/exampleModel.hbjson')
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+  def test_example_model_without_output_path
+    args = {}
+    args['openstudio_model'] = File.join(File.dirname(__FILE__) + '/../../../../spec/samples/osm/exampleModel.osm')
+    apply_measure_to_model(__method__.to_s.gsub('test_',''),args, nil)
+  end
+
+end

data/lib/to_openstudio/hvac/template.rb

@@ -83,27 +83,36 @@ module Honeybee
       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
-        os_air_loop = air_loops[-1]
-        loop_name = os_air_loop.name
-        unless loop_name.empty?
-          if @hash[:display_name]
-            os_air_loop.setName(@hash[:display_name] + ' - ' + loop_name.get)
+        os_air_terminal = zones[0].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
+            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
           end
         end
       end
 
       # assign the economizer type if there's an air loop and the economizer is specified
-      if @hash[:economizer_type] && @hash[:economizer_type] != 'Inferred' && os_air_loop
+      if @hash[:economizer_type] && os_air_loop
         oasys = os_air_loop.airLoopHVACOutdoorAirSystem
         unless oasys.empty?
-            os_oasys = oasys.get
-            oactrl = os_oasys.getControllerOutdoorAir
-            oactrl.setEconomizerControlType(@hash[:economizer_type])
+          os_oasys = oasys.get
+          oactrl = os_oasys.getControllerOutdoorAir
+          oactrl.setEconomizerControlType(@hash[:economizer_type])
         end
       end
 
       # set the sensible heat recovery if there's an air loop and the heat recovery is specified
-      if @hash[:sensible_heat_recovery] && @hash[:sensible_heat_recovery] != {:type => 'Autosize'} && os_air_loop
+      if @hash[:sensible_heat_recovery] && @hash[:sensible_heat_recovery] != 0 && os_air_loop
         erv = get_existing_erv(os_air_loop)
         unless erv
           erv = create_erv(openstudio_model, os_air_loop)
@@ -116,7 +125,7 @@ module Honeybee
       end
 
       # set the latent heat recovery if there's an air loop and the heat recovery is specified
-      if @hash[:latent_heat_recovery] && @hash[:latent_heat_recovery] != {:type => 'Autosize'} && os_air_loop
+      if @hash[:latent_heat_recovery] && @hash[:latent_heat_recovery] != 0 && os_air_loop
         erv = get_existing_erv(os_air_loop)
         unless erv
           erv = create_erv(openstudio_model, os_air_loop)
@@ -128,6 +137,60 @@ module Honeybee
         erv.setLatentEffectivenessat75HeatingAirFlow(@hash[:latent_heat_recovery])
       end
 
+      # assign demand controlled ventilation if there's an air loop
+      if @hash[:demand_controlled_ventilation] && os_air_loop
+        oasys = os_air_loop.airLoopHVACOutdoorAirSystem
+        unless oasys.empty?
+          os_oasys = oasys.get
+          oactrl = os_oasys.getControllerOutdoorAir
+          vent_ctrl = oactrl.controllerMechanicalVentilation
+          vent_ctrl.setDemandControlledVentilationNoFail(true)
+          oactrl.resetMinimumFractionofOutdoorAirSchedule
+        end
+      end
+
+      # assign the DOAS availability schedule if there's an air loop and it is specified
+      if @hash[:doas_availability_schedule] && os_air_loop
+        schedule = openstudio_model.getScheduleByName(@hash[:doas_availability_schedule])
+        unless schedule.empty?
+          avail_sch = schedule.get
+          os_air_loop.setAvailabilitySchedule(avail_sch)
+        end
+      end
+
+      # set the outdoor air controller to respect room-level ventilation schedules if they exist
+      if os_air_loop
+        oasys = os_air_loop.airLoopHVACOutdoorAirSystem
+        unless oasys.empty?
+          os_oasys = oasys.get
+          oactrl = os_oasys.getControllerOutdoorAir
+          oa_sch, oa_sch_name = nil, nil
+          zones.each do |zone|
+            oa_spec = zone.spaces[0].designSpecificationOutdoorAir
+            unless oa_spec.empty?
+              oa_spec = oa_spec.get
+              space_oa_sch = oa_spec.outdoorAirFlowRateFractionSchedule
+              unless space_oa_sch.empty?
+                space_oa_sch = space_oa_sch.get
+                space_oa_sch_name = space_oa_sch.name
+                unless space_oa_sch_name.empty?
+                  space_oa_sch_name = space_oa_sch_name.get
+                  if oa_sch_name.nil? || space_oa_sch_name == oa_sch_name
+                    oa_sch, oa_sch_name = space_oa_sch, space_oa_sch_name
+                  else
+                    oa_sch = nil
+                  end
+                end
+              end
+            end
+          end
+          if oa_sch
+            oactrl.resetMinimumFractionofOutdoorAirSchedule
+            oactrl.setMinimumOutdoorAirSchedule(oa_sch)
+          end
+        end
+      end
+
       # if the systems are PTAC and there is ventilation, ensure the system includes it
       if equipment_type.include?('PTAC') || equipment_type.include?('PTHP')
         always_on = openstudio_model.getScheduleByName('Always On').get
@@ -164,6 +227,20 @@ module Honeybee
         end
       end
 
+      # assign an electric humidifier if there's an air loop and the zones have a humidistat
+      if os_air_loop
+        humidistat_exists = false
+        zones.each do |zone|
+          h_stat = zone.zoneControlHumidistat
+          unless h_stat.empty?
+            humidistat_exists = true
+          end
+        end
+        if humidistat_exists
+          humidifier = create_humidifier(openstudio_model, os_air_loop)
+        end
+      end
+
       # set all plants to non-coincident sizing to avoid simualtion control issues on design days
       openstudio_model.getPlantLoops.each do |loop|
         sizing = loop.sizingPlant
@@ -209,5 +286,20 @@ module Honeybee
       heat_ex
     end
 
+    def create_humidifier(model, os_air_loop)
+      # create an electric humidifier
+      humidifier = OpenStudio::Model::HumidifierSteamElectric.new(model)
+      humidifier.setName(@hash[:identifier] + '_Humidifier Unit')
+      humid_controller = OpenStudio::Model::SetpointManagerMultiZoneHumidityMinimum.new(model)
+      humid_controller.setName(@hash[:identifier] + '_Humidifier Controller')
+
+      # add the humidifier to the air loop
+      supply_node = os_air_loop.supplyOutletNode
+      humidifier.addToNode(supply_node)
+      humid_controller.addToNode(supply_node)
+
+      humidifier
+    end
+
   end #TemplateHVAC
 end #Honeybee

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.4
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -152,16 +152,36 @@ files:
 - lib/honeybee/ventcool/opening.rb
 - lib/honeybee/ventcool/simulation.rb
 - lib/measures/.gitkeep
+- lib/measures/from_gbxml_model/LICENSE.md
+- lib/measures/from_gbxml_model/README.md
+- lib/measures/from_gbxml_model/measure.rb
+- lib/measures/from_gbxml_model/measure.xml
+- lib/measures/from_gbxml_model/tests/from_gbxml_model_test.rb
 - lib/measures/from_honeybee_model/LICENSE.md
 - lib/measures/from_honeybee_model/README.md
 - lib/measures/from_honeybee_model/measure.rb
 - lib/measures/from_honeybee_model/measure.xml
 - lib/measures/from_honeybee_model/tests/from_honeybee_model_test.rb
+- lib/measures/from_honeybee_model_to_gbxml/LICENSE.md
+- lib/measures/from_honeybee_model_to_gbxml/README.md
+- lib/measures/from_honeybee_model_to_gbxml/measure.rb
+- lib/measures/from_honeybee_model_to_gbxml/measure.xml
+- lib/measures/from_honeybee_model_to_gbxml/tests/from_honeybee_model_to_gbxml_test.rb
 - lib/measures/from_honeybee_simulation_parameter/LICENSE.md
 - lib/measures/from_honeybee_simulation_parameter/README.md
 - lib/measures/from_honeybee_simulation_parameter/measure.rb
 - lib/measures/from_honeybee_simulation_parameter/measure.xml
 - lib/measures/from_honeybee_simulation_parameter/tests/from_honeybee_simulation_parameter_test.rb
+- lib/measures/from_idf_model/LICENSE.md
+- lib/measures/from_idf_model/README.md
+- lib/measures/from_idf_model/measure.rb
+- lib/measures/from_idf_model/measure.xml
+- lib/measures/from_idf_model/tests/from_idf_model_test.rb
+- lib/measures/from_openstudio_model/LICENSE.md
+- lib/measures/from_openstudio_model/README.md
+- lib/measures/from_openstudio_model/measure.rb
+- lib/measures/from_openstudio_model/measure.xml
+- lib/measures/from_openstudio_model/tests/from_openstudio_model_test.rb
 - lib/to_openstudio.rb
 - lib/to_openstudio/construction/air.rb
 - lib/to_openstudio/construction/opaque.rb