urbanopt-cli 0.5.1 → 0.5.2

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/lighting.rb

@@ -8,7 +8,6 @@ class Lighting
     end
 
     if fractions[[HPXML::LocationInterior, HPXML::LightingTypeCFL]].nil? # Not the lighting group(s) we're interested in
-      runner.registerWarning('No lighting specified, the model will not include lighting energy use.')
       return
     end
 
@@ -120,6 +119,7 @@ class Lighting
       ltg_def = OpenStudio::Model::ExteriorLightsDefinition.new(model)
       ltg = OpenStudio::Model::ExteriorLights.new(ltg_def)
       ltg.setName(Constants.ObjectNameExteriorLighting)
+      ltg.setEndUseSubcategory(Constants.ObjectNameExteriorLighting)
       ltg_def.setName(Constants.ObjectNameExteriorLighting)
       ltg_def.setDesignLevel(design_level)
       ltg.setSchedule(exterior_sch)
@@ -139,6 +139,7 @@ class Lighting
       ltg_def = OpenStudio::Model::ExteriorLightsDefinition.new(model)
       ltg = OpenStudio::Model::ExteriorLights.new(ltg_def)
       ltg.setName(Constants.ObjectNameLightingExteriorHoliday)
+      ltg.setEndUseSubcategory(Constants.ObjectNameLightingExteriorHoliday)
       ltg_def.setName(Constants.ObjectNameLightingExteriorHoliday)
       ltg_def.setDesignLevel(design_level)
       ltg.setSchedule(exterior_holiday_sch)

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/location.rb

@@ -78,21 +78,34 @@ class Location
     dgts.setAllMonthlyTemperatures([UnitConversions.convert(weather.data.AnnualAvgDrybulb, 'F', 'C')] * 12)
   end
 
-  def self.get_climate_zone_ba(wmo)
-    ba_zone = nil
+  def self.get_climate_zones
     zones_csv = File.join(File.dirname(__FILE__), 'data_climate_zones.csv')
     if not File.exist?(zones_csv)
       fail 'Could not find data_climate_zones.csv'
     end
 
+    return zones_csv
+  end
+
+  def self.get_climate_zone_iecc(wmo)
+    zones_csv = get_climate_zones
+
+    require 'csv'
+    CSV.foreach(zones_csv) do |row|
+      return row[6].to_s if row[0].to_s == wmo.to_s
+    end
+
+    return
+  end
+
+  def self.get_climate_zone_ba(wmo)
+    zones_csv = get_climate_zones
+
     require 'csv'
     CSV.foreach(zones_csv) do |row|
-      if row[0].to_s == wmo.to_s
-        ba_zone = row[5].to_s
-        break
-      end
+      return row[5].to_s if row[0].to_s == wmo.to_s
     end
 
-    return ba_zone
+    return
   end
 end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure.rb

@@ -2,7 +2,7 @@
 
 require 'fileutils'
 
-def run_hpxml_workflow(rundir, hpxml, measures, measures_dir, debug: false, output_vars: [],
+def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars: [],
                        output_meters: [], run_measures_only: false, print_prefix: '')
   rm_path(rundir)
   FileUtils.mkdir_p(rundir)
@@ -51,7 +51,13 @@ def run_hpxml_workflow(rundir, hpxml, measures, measures_dir, debug: false, outp
   forward_translator = OpenStudio::EnergyPlus::ForwardTranslator.new
   forward_translator.setExcludeLCCObjects(true)
   model_idf = forward_translator.translateModel(model)
-  report_ft_errors_warnings(forward_translator, rundir)
+  success = report_ft_errors_warnings(forward_translator, rundir)
+
+  if not success
+    print "#{print_prefix}Creating input unsuccessful.\n"
+    print "#{print_prefix}See #{File.join(rundir, 'run.log')} for details.\n"
+    return { success: false, runner: runner }
+  end
 
   # Apply reporting measure output requests
   apply_energyplus_output_requests(measures_dir, measures, runner, model, model_idf)
@@ -274,6 +280,19 @@ def get_argument_map(model, measure, provided_args, lookup_file, measure_name, r
   return argument_map
 end
 
+def get_value_from_workflow_step_value(step_value)
+  variant_type = step_value.variantType
+  if variant_type == 'Boolean'.to_VariantType
+    return step_value.valueAsBoolean
+  elsif variant_type == 'Double'.to_VariantType
+    return step_value.valueAsDouble
+  elsif variant_type == 'Integer'.to_VariantType
+    return step_value.valueAsInteger
+  elsif variant_type == 'String'.to_VariantType
+    return step_value.valueAsString
+  end
+end
+
 def run_measure(model, measure, argument_map, runner)
   begin
     # run the measure
@@ -298,6 +317,11 @@ def run_measure(model, measure, argument_map, runner)
       runner.registerFinalCondition(result_child.finalCondition.get.logMessage)
     end
 
+    # re-register runner child registered values on the parent runner
+    result_child.stepValues.each do |step_value|
+      runner.registerValue(step_value.name, get_value_from_workflow_step_value(step_value))
+    end
+
     # log messages
     result_child.warnings.each do |warning|
       runner.registerWarning(warning.logMessage)
@@ -338,7 +362,7 @@ end
 def register_error(msg, runner = nil)
   if not runner.nil?
     runner.registerError(msg)
-    fail msg # OS 2.0 will handle this more gracefully
+    fail msg
   else
     raise "ERROR: #{msg}"
   end
@@ -388,14 +412,17 @@ end
 
 def report_ft_errors_warnings(forward_translator, rundir)
   # Report warnings/errors
+  success = true
   File.open(File.join(rundir, 'run.log'), 'a') do |f|
     forward_translator.warnings.each do |s|
       f << "FT Warning: #{s.logMessage}\n"
     end
     forward_translator.errors.each do |s|
       f << "FT Error: #{s.logMessage}\n"
+      success = false
     end
   end
+  return success
 end
 
 def report_os_warnings(os_log, rundir)
@@ -440,3 +467,37 @@ class String
     return true
   end
 end
+
+def get_argument_values(runner, arguments, user_arguments)
+  args = {}
+  arguments.each do |argument|
+    if argument.required
+      case argument.type
+      when 'Choice'.to_OSArgumentType
+        args[argument.name] = runner.getStringArgumentValue(argument.name, user_arguments)
+      when 'Boolean'.to_OSArgumentType
+        args[argument.name] = runner.getBoolArgumentValue(argument.name, user_arguments)
+      when 'Double'.to_OSArgumentType
+        args[argument.name] = runner.getDoubleArgumentValue(argument.name, user_arguments)
+      when 'Integer'.to_OSArgumentType
+        args[argument.name] = runner.getIntegerArgumentValue(argument.name, user_arguments)
+      when 'String'.to_OSArgumentType
+        args[argument.name] = runner.getStringArgumentValue(argument.name, user_arguments)
+      end
+    else
+      case argument.type
+      when 'Choice'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      when 'Boolean'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      when 'Double'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalDoubleArgumentValue(argument.name, user_arguments)
+      when 'Integer'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalIntegerArgumentValue(argument.name, user_arguments)
+      when 'String'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      end
+    end
+  end
+  return args
+end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/misc_loads.rb

@@ -30,17 +30,6 @@ class MiscLoads
     sens_frac = plug_load.frac_sensible
     lat_frac = plug_load.frac_latent
 
-    # check for valid inputs
-    if (sens_frac < 0) || (sens_frac > 1)
-      fail 'Sensible fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if (lat_frac < 0) || (lat_frac > 1)
-      fail 'Latent fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if lat_frac + sens_frac > 1
-      fail 'Sum of sensible and latent fractions must be less than or equal to 1.'
-    end
-
     if apply_ashrae140_assumptions
       # ASHRAE 140, Table 7-9. Sensible loads are 70% radiative and 30% convective.
       rad_frac = 0.7 * sens_frac
@@ -89,17 +78,6 @@ class MiscLoads
     sens_frac = fuel_load.frac_sensible
     lat_frac = fuel_load.frac_latent
 
-    # check for valid inputs
-    if (sens_frac < 0) || (sens_frac > 1)
-      fail 'Sensible fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if (lat_frac < 0) || (lat_frac > 1)
-      fail 'Latent fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if lat_frac + sens_frac > 1
-      fail 'Sum of sensible and latent fractions must be less than or equal to 1.'
-    end
-
     # Add other equipment for the mfl
     mfl_def = OpenStudio::Model::OtherEquipmentDefinition.new(model)
     mfl = OpenStudio::Model::OtherEquipment.new(mfl_def)
@@ -116,6 +94,8 @@ class MiscLoads
   end
 
   def self.apply_pool_or_hot_tub_heater(model, pool_or_hot_tub, obj_name, living_space, schedules_file)
+    return if pool_or_hot_tub.heater_type == HPXML::TypeNone
+
     heater_kwh = 0
     heater_therm = 0
 

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/pv.rb

@@ -8,9 +8,7 @@ class PV
       max_power = pv_system.max_power_output
     else
       # Apportion to single dwelling unit by # bedrooms
-      if pv_system.number_of_bedrooms_served.to_f <= nbeds.to_f
-        fail "Shared PV system number of bedrooms served (#{pv_system.number_of_bedrooms_served}) must be greater than the number of bedrooms in the dwelling unit (#{nbeds})."
-      end
+      fail if pv_system.number_of_bedrooms_served.to_f <= nbeds.to_f # EPvalidator.xml should prevent this
       max_power = pv_system.max_power_output * nbeds.to_f / pv_system.number_of_bedrooms_served.to_f
     end
 

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb

@@ -1203,17 +1203,21 @@ class SchedulesFile
     return external_file
   end
 
-  def set_vacancy(col_names:)
+  def set_vacancy
     return unless @schedules.keys.include? 'vacancy'
     return if @schedules['vacancy'].all? { |i| i == 0 }
 
-    @schedules[col_names[0]].each_with_index do |ts, i|
-      col_names.each do |col_name|
+    col_names = ScheduleGenerator.col_names
+
+    @schedules[col_names.keys[0]].each_with_index do |ts, i|
+      col_names.keys.each do |col_name|
+        next unless col_names[col_name] # skip those unaffected by vacancy
+
         @schedules[col_name][i] *= (1.0 - @schedules['vacancy'][i])
       end
     end
 
-    update(col_names: col_names)
+    update(col_names: col_names.keys)
   end
 
   def import(col_names:)
@@ -1248,9 +1252,14 @@ class SchedulesFile
     return false if @schedules_path.nil?
 
     # need to update schedules csv in generated_files folder (alongside run folder) since this is what the simulation points to
-    schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path)))
+    begin
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path))) # called from cli
+      columns = CSV.read(schedules_path).transpose
+    rescue
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../../../files', File.basename(@schedules_path))) # testing
+      columns = CSV.read(schedules_path).transpose
+    end
 
-    columns = CSV.read(schedules_path).transpose
     col_names.each do |col_name|
       col_num = get_col_index(col_name: col_name)
       columns.each_with_index do |col, i|

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/simcontrols.rb

@@ -9,8 +9,14 @@ class SimControls
     tstep.setNumberOfTimestepsPerHour(60 / header.timestep)
 
     shad = model.getShadowCalculation
-    shad.setShadingCalculationUpdateFrequency(20)
     shad.setMaximumFiguresInShadowOverlapCalculations(200)
+    # Detailed diffuse algorithm is required for window interior shading with varying
+    # transmittance schedules
+    shad.setSkyDiffuseModelingAlgorithm('DetailedSkyDiffuseModeling')
+    # Use EnergyPlus default of 20 days for update frequency; it is a reasonable balance
+    # between speed and accuracy (e.g., sun position, picking up any change in window
+    # interior shading transmittance, etc.).
+    shad.setShadingCalculationUpdateFrequency(20)
 
     outsurf = model.getOutsideSurfaceConvectionAlgorithm
     outsurf.setAlgorithm('DOE-2')

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/unit_conversions.rb

@@ -167,6 +167,8 @@ class UnitConversions
       return x + 273.15
     elsif key == ['f', 'c']
       return (x - 32.0) / 1.8
+    elsif key == ['f', 'k']
+      return (x - 32.0) / 1.8 + 273.15
     elsif key == ['f', 'r']
       return x + 459.67
     elsif key == ['k', 'c']

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Version
-  OS_HPXML_Version = '1.0.0' # Version of the OS-HPXML workflow
+  OS_HPXML_Version = '1.1.0' # Version of the OS-HPXML workflow
   OS_Version = '3.1.0' # Required version of OpenStudio (can be 'X.X' or 'X.X.X')
   HPXML_Version = '3.0' # HPXML schemaVersion
 

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/waterheater.rb

@@ -1192,10 +1192,11 @@ class Waterheater
         ef = calc_ef_from_uef(water_heating_system)
       end
       if ef >= 0.75
-        return 0.778114 * ef + 0.276679
+        re = 0.561 * ef + 0.439
       else
-        return 0.252117 * ef + 0.607997
+        re = 0.252 * ef + 0.608
       end
+      return re
     end
   end
 
@@ -1398,8 +1399,6 @@ class Waterheater
       location_hierarchy = [HPXML::LocationBasementConditioned,
                             HPXML::LocationBasementUnconditioned,
                             HPXML::LocationLivingSpace]
-    else
-      fail "Unexpected IECC climate zone: '#{iecc_zone}'."
     end
     location_hierarchy.each do |space_type|
       if hpxml.has_space_type(space_type)

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/xmlhelper.rb

@@ -8,11 +8,11 @@ class XMLHelper
     parent.children << added
     if not value.nil?
       if datatype == :integer
-        value = to_integer(value)
+        value = to_integer(value, parent, element_name)
       elsif datatype == :float
-        value = to_float(value)
+        value = to_float(value, parent, element_name)
       elsif datatype == :boolean
-        value = to_boolean(value)
+        value = to_boolean(value, parent, element_name)
       elsif datatype != :string
         # If value provided, datatype required
         fail 'Unexpected datatype.'
@@ -58,11 +58,6 @@ class XMLHelper
 
   # Returns the value of 'element_name' in the parent element or nil.
   def self.get_value(parent, element_name, datatype)
-    value, isdefaulted = get_value_and_defaulted(parent, element_name, datatype)
-    return value
-  end
-
-  def self.get_value_and_defaulted(parent, element_name, datatype)
     element = parent.at_xpath(element_name)
     if element.nil?
       return
@@ -70,18 +65,16 @@ class XMLHelper
     value = element.text
 
     if datatype == :integer
-      value = to_integer_or_nil(value)
+      value = to_integer_or_nil(value, parent, element_name)
     elsif datatype == :float
-      value = to_float_or_nil(value)
+      value = to_float_or_nil(value, parent, element_name)
     elsif datatype == :boolean
-      value = to_boolean_or_nil(value)
+      value = to_boolean_or_nil(value, parent, element_name)
     elsif datatype != :string
       fail 'Unexpected datatype.'
     end
 
-    isdefaulted = get_attribute_value(element, 'dataSource') == 'software'
-
-    return value, isdefaulted
+    return value
   end
 
   # Returns the value(s) of 'element_name' in the parent element or [].
@@ -91,11 +84,11 @@ class XMLHelper
       value = value.text
 
       if datatype == :integer
-        value = to_integer_or_nil(value)
+        value = to_integer_or_nil(value, parent, element_name)
       elsif datatype == :float
-        value = to_float_or_nil(value)
+        value = to_float_or_nil(value, parent, element_name)
       elsif datatype == :boolean
-        value = to_boolean_or_nil(value)
+        value = to_boolean_or_nil(value, parent, element_name)
       elsif datatype != :string
         fail 'Unexpected datatype.'
       end
@@ -148,6 +141,12 @@ class XMLHelper
     return element.get(attr_name)
   end
 
+  def self.delete_attribute(element, attr_name)
+    return if element.nil?
+
+    element.unset(attr_name)
+  end
+
   def self.validate(doc, xsd_path, runner = nil)
     if Gem::Specification::find_all_by_name('nokogiri').any?
       require 'nokogiri'
@@ -222,28 +221,28 @@ class XMLHelper
   end
 end
 
-def to_float(value)
+def to_float(value, parent, element_name)
   begin
     return Float(value)
   rescue
-    fail "Cannot convert '#{value}' to float."
+    fail "Cannot convert '#{value}' to float for #{parent.name}/#{element_name}."
   end
 end
 
-def to_integer(value)
+def to_integer(value, parent, element_name)
   begin
     value = Float(value)
   rescue
-    fail "Cannot convert '#{value}' to integer."
+    fail "Cannot convert '#{value}' to integer for #{parent.name}/#{element_name}."
   end
   if value % 1 == 0
     return Integer(value)
   else
-    fail "Cannot convert '#{value}' to integer."
+    fail "Cannot convert '#{value}' to integer for #{parent.name}/#{element_name}."
   end
 end
 
-def to_boolean(value)
+def to_boolean(value, parent = nil, element_name = nil)
   if value.is_a? TrueClass
     return true
   elsif value.is_a? FalseClass
@@ -254,23 +253,25 @@ def to_boolean(value)
     return false
   end
 
-  fail "Cannot convert '#{value}' to boolean."
+  if (not parent.nil?) && (not element_name.nil?)
+    fail "Cannot convert '#{value}' to boolean for #{parent.name}/#{element_name}."
+  end
 end
 
-def to_float_or_nil(value)
+def to_float_or_nil(value, parent, element_name)
   return if value.nil?
 
-  return to_float(value)
+  return to_float(value, parent, element_name)
 end
 
-def to_integer_or_nil(value)
+def to_integer_or_nil(value, parent, element_name)
   return if value.nil?
 
-  return to_integer(value)
+  return to_integer(value, parent, element_name)
 end
 
-def to_boolean_or_nil(value)
+def to_boolean_or_nil(value, parent, element_name)
   return if value.nil?
 
-  return to_boolean(value)
+  return to_boolean(value, parent, element_name)
 end