urbanopt-cli 0.8.3 → 0.9.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Lighting
-  def self.apply(runner, model, epw_file, spaces, lighting_groups, lighting, eri_version, schedules_file, cfa, gfa)
+  def self.apply(runner, model, epw_file, spaces, lighting_groups, lighting, eri_version, schedules_file, cfa)
     fractions = {}
     lighting_groups.each do |lg|
       fractions[[lg.location, lg.lighting_type]] = lg.fraction_of_units_in_location
@@ -11,6 +11,11 @@ class Lighting
       return
     end
 
+    gfa = 0
+    if spaces.keys.include? HPXML::LocationGarage
+      gfa = UnitConversions.convert(spaces[HPXML::LocationGarage].floorArea, 'm^2', 'ft^2')
+    end
+
     int_kwh, ext_kwh, grg_kwh = calc_energy(eri_version, cfa, gfa,
                                             fractions[[HPXML::LocationInterior, HPXML::LightingTypeCFL]],
                                             fractions[[HPXML::LocationExterior, HPXML::LightingTypeCFL]],
@@ -43,9 +48,9 @@ class Lighting
         end
 
         if lighting.interior_weekday_fractions.nil?
-          design_level = interior_sch.calcDesignLevel(interior_sch.maxval * int_kwh)
+          design_level = interior_sch.calc_design_level(interior_sch.maxval * int_kwh)
         else
-          design_level = interior_sch.calcDesignLevelFromDailykWh(int_kwh / 365.0)
+          design_level = interior_sch.calc_design_level_from_daily_kwh(int_kwh / 365.0)
         end
         interior_sch = interior_sch.schedule
       else
@@ -79,7 +84,7 @@ class Lighting
       end
       if garage_sch.nil?
         garage_sch = MonthWeekdayWeekendSchedule.new(model, Constants.ObjectNameGarageLighting + ' schedule', lighting.garage_weekday_fractions, lighting.garage_weekend_fractions, lighting.garage_monthly_multipliers, Constants.ScheduleTypeLimitsFraction)
-        design_level = garage_sch.calcDesignLevelFromDailykWh(grg_kwh / 365.0)
+        design_level = garage_sch.calc_design_level_from_daily_kwh(grg_kwh / 365.0)
         garage_sch = garage_sch.schedule
       else
         runner.registerWarning("Both '#{SchedulesFile::ColumnLightingGarage}' schedule file and weekday fractions provided; the latter will be ignored.") if !lighting.garage_weekday_fractions.nil?
@@ -111,7 +116,7 @@ class Lighting
       end
       if exterior_sch.nil?
         exterior_sch = MonthWeekdayWeekendSchedule.new(model, Constants.ObjectNameExteriorLighting + ' schedule', lighting.exterior_weekday_fractions, lighting.exterior_weekend_fractions, lighting.exterior_monthly_multipliers, Constants.ScheduleTypeLimitsFraction)
-        design_level = exterior_sch.calcDesignLevelFromDailykWh(ext_kwh / 365.0)
+        design_level = exterior_sch.calc_design_level_from_daily_kwh(ext_kwh / 365.0)
         exterior_sch = exterior_sch.schedule
       else
         runner.registerWarning("Both '#{SchedulesFile::ColumnLightingExterior}' schedule file and weekday fractions provided; the latter will be ignored.") if !lighting.exterior_weekday_fractions.nil?
@@ -139,7 +144,7 @@ class Lighting
       end
       if exterior_holiday_sch.nil?
         exterior_holiday_sch = MonthWeekdayWeekendSchedule.new(model, Constants.ObjectNameLightingExteriorHoliday + ' schedule', lighting.holiday_weekday_fractions, lighting.holiday_weekend_fractions, lighting.exterior_monthly_multipliers, Constants.ScheduleTypeLimitsFraction, true, lighting.holiday_period_begin_month, lighting.holiday_period_begin_day, lighting.holiday_period_end_month, lighting.holiday_period_end_day)
-        design_level = exterior_holiday_sch.calcDesignLevelFromDailykWh(lighting.holiday_kwh_per_day)
+        design_level = exterior_holiday_sch.calc_design_level_from_daily_kwh(lighting.holiday_kwh_per_day)
         exterior_holiday_sch = exterior_holiday_sch.schedule
       else
         runner.registerWarning("Both '#{SchedulesFile::ColumnLightingExteriorHoliday}' schedule file and weekday fractions provided; the latter will be ignored.") if !lighting.holiday_weekday_fractions.nil?
@@ -199,10 +204,6 @@ class Lighting
       eff_ratio_fl = eff_inc / eff_fl
       eff_ratio_led = eff_inc / eff_led
 
-      # Fractions of lamps that are hardwired vs plug-in
-      frac_hw = 0.9
-      frac_pl = 1.0 - frac_hw
-
       # Efficiency lighting adjustments
       int_adj = (f_int_inc * eff_ratio_inc) + (f_int_fl * eff_ratio_fl) + (f_int_led * eff_ratio_led)
       ext_adj = (f_ext_inc * eff_ratio_inc) + (f_ext_fl * eff_ratio_fl) + (f_ext_led * eff_ratio_led)
@@ -266,7 +267,6 @@ class Lighting
       end
     end
 
-    dec_kws = [0.075, 0.055, 0.040, 0.035, 0.030, 0.025, 0.025, 0.025, 0.025, 0.025, 0.025, 0.030, 0.045, 0.075, 0.130, 0.160, 0.140, 0.100, 0.075, 0.065, 0.060, 0.050, 0.045, 0.045, 0.045, 0.045, 0.045, 0.045, 0.050, 0.060, 0.080, 0.130, 0.190, 0.230, 0.250, 0.260, 0.260, 0.250, 0.240, 0.225, 0.225, 0.220, 0.210, 0.200, 0.180, 0.155, 0.125, 0.100]
     june_kws = [0.060, 0.040, 0.035, 0.025, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.025, 0.030, 0.030, 0.025, 0.020, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.020, 0.020, 0.020, 0.025, 0.025, 0.030, 0.030, 0.035, 0.045, 0.060, 0.085, 0.125, 0.145, 0.130, 0.105, 0.080]
     lighting_seasonal_multiplier =   [1.075, 1.064951905, 1.0375, 1.0, 0.9625, 0.935048095, 0.925, 0.935048095, 0.9625, 1.0, 1.0375, 1.064951905]
     amplConst1 = 0.929707907917098

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

@@ -22,7 +22,8 @@ class Location
     # parsing the weather file.
     if File.exist? weather_cache_path
       weather = WeatherProcess.new(nil, nil, weather_cache_path)
-    else
+    end
+    if weather.nil? || weather.data.AnnualAvgDrybulb.nil?
       weather = WeatherProcess.new(model, runner)
     end
 
@@ -95,4 +96,35 @@ class Location
 
     return
   end
+
+  def self.get_epw_path(hpxml, hpxml_path)
+    epw_path = hpxml.climate_and_risk_zones.weather_station_epw_filepath
+
+    if not File.exist? epw_path
+      test_epw_path = File.join(File.dirname(hpxml_path), epw_path)
+      epw_path = test_epw_path if File.exist? test_epw_path
+    end
+    for level_deep in 1..3
+      next unless not File.exist? epw_path
+
+      level = (['..'] * level_deep).join('/')
+      test_epw_path = File.join(File.dirname(__FILE__), level, 'weather', epw_path)
+      epw_path = test_epw_path if File.exist? test_epw_path
+    end
+    if not File.exist?(epw_path)
+      fail "'#{epw_path}' could not be found."
+    end
+
+    return epw_path
+  end
+
+  def self.get_sim_calendar_year(sim_calendar_year, epw_file)
+    if (not epw_file.nil?) && epw_file.startDateActualYear.is_initialized # AMY
+      sim_calendar_year = epw_file.startDateActualYear.get
+    end
+    if sim_calendar_year.nil?
+      sim_calendar_year = 2007 # For consistency with SAM utility bill calculations
+    end
+    return sim_calendar_year
+  end
 end

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

@@ -273,8 +273,8 @@ class Material
     fail "Unexpected type: #{type}."
   end
 
-  def self.Soil(thick_in)
-    return new(name: "soil #{thick_in} in.", thick_in: thick_in, mat_base: BaseMaterial.Soil)
+  def self.Soil(thick_in, k_in)
+    return new(name: "soil #{thick_in} in.", thick_in: thick_in, mat_base: BaseMaterial.Soil(k_in))
   end
 
   def self.Stud2x(thick_in)
@@ -399,8 +399,8 @@ class BaseMaterial
     return new(rho: (self.InsulationFiberglassLoosefill.rho + self.InsulationCelluloseLoosefill.rho) / 2.0, cp: 0.25)
   end
 
-  def self.Soil
-    return new(rho: 115.0, cp: 0.1, k_in: 12.0)
+  def self.Soil(k_in)
+    return new(rho: 115.0, cp: 0.1, k_in: k_in)
   end
 
   def self.Brick

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

@@ -4,13 +4,13 @@ require 'fileutils'
 
 def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars: [],
                        output_meters: [], run_measures_only: false, print_prefix: '',
-                       ep_input_format: 'idf')
+                       ep_input_format: 'idf', skip_simulation: false, suppress_print: false)
   rm_path(rundir)
   FileUtils.mkdir_p(rundir)
 
   # Use print instead of puts in here in case running inside
   # a Parallel process (see https://stackoverflow.com/a/5044669)
-  print "#{print_prefix}Creating input...\n"
+  print "#{print_prefix}Creating input...\n" unless suppress_print
 
   OpenStudio::Logger.instance.standardOutLogger.setLogLevel(OpenStudio::Fatal)
   os_log = OpenStudio::StringStreamLogSink.new
@@ -92,8 +92,12 @@ def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars
     fail "Unexpected ep_input_format: #{ep_input_format}."
   end
 
+  if skip_simulation
+    return { success: success, runner: runner }
+  end
+
   # Run simulation
-  print "#{print_prefix}Running simulation...\n"
+  print "#{print_prefix}Running simulation...\n" unless suppress_print
   ep_path = File.absolute_path(File.join(OpenStudio.getOpenStudioCLI.to_s, '..', '..', 'EnergyPlus', 'energyplus')) # getEnergyPlusDirectory can be unreliable, using getOpenStudioCLI instead
   simulation_start = Time.now
   command = "\"#{ep_path}\" -w \"#{model.getWeatherFile.path.get}\" #{ep_input_filename}"
@@ -119,7 +123,7 @@ def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars
       break
     end
     if sim_success
-      print "#{print_prefix}Completed simulation in #{sim_time}s.\n"
+      print "#{print_prefix}Completed simulation in #{sim_time}s.\n" unless suppress_print
     else
       print "#{print_prefix}Simulation unsuccessful.\n"
       print "#{print_prefix}See #{File.join(rundir, 'eplusout.err')} for details.\n"
@@ -130,7 +134,7 @@ def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars
     return { success: false, runner: runner }
   end
 
-  print "#{print_prefix}Processing output...\n"
+  print "#{print_prefix}Processing output...\n" unless suppress_print
 
   # Apply reporting measures
   runner.setLastEpwFilePath(File.join(rundir, 'in.epw'))
@@ -140,7 +144,7 @@ def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars
   runner.resetLastEpwFilePath
 
   Dir[File.join(rundir, 'results_*.*')].each do |results_path|
-    print "#{print_prefix}Wrote output file: #{results_path}.\n"
+    print "#{print_prefix}Wrote output file: #{results_path}.\n" unless suppress_print
   end
 
   if not success
@@ -148,10 +152,10 @@ def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars
     print "#{print_prefix}See #{File.join(rundir, 'run.log')} for details.\n"
     return { success: false, runner: runner }
   else
-    print "#{print_prefix}Wrote log file: #{File.join(rundir, 'run.log')}.\n"
+    print "#{print_prefix}Wrote log file: #{File.join(rundir, 'run.log')}.\n" unless suppress_print
   end
 
-  print "#{print_prefix}Done.\n"
+  print "#{print_prefix}Done.\n" unless suppress_print
 
   return { success: true, runner: runner, sim_time: sim_time }
 end
@@ -229,7 +233,7 @@ def print_measure_call(measure_args, measure_dir, runner)
     return
   end
 
-  args_s = hash_to_string(measure_args, delim = ' -> ', separator = " \n")
+  args_s = hash_to_string(measure_args, ' -> ', " \n")
   if args_s.size > 0
     runner.registerInfo("Calling #{measure_dir} measure with arguments:\n#{args_s}")
   else
@@ -490,6 +494,10 @@ def report_os_warnings(os_log, rundir)
       next if s.logMessage.include? 'WorkflowStepResult value called with undefined stepResult'
       next if s.logMessage.include?("Object of type 'Schedule:Constant' and named 'Always") && s.logMessage.include?('points to an object named') && s.logMessage.include?('but that object cannot be located')
       next if s.logMessage.include? 'Appears there are no design condition fields in the EPW file'
+      next if s.logMessage.include? 'Volume calculation will be potentially inaccurate'
+      next if s.logMessage.include? 'Valid instance'
+      next if s.logMessage.include? 'xsdValidate'
+      next if s.logMessage.include? 'xsltValidate'
 
       f << "OS Message: #{s.logMessage}\n"
     end

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

@@ -26,7 +26,7 @@ class MiscLoads
     end
     if sch.nil?
       sch = MonthWeekdayWeekendSchedule.new(model, obj_name + ' schedule', plug_load.weekday_fractions, plug_load.weekend_fractions, plug_load.monthly_multipliers, Constants.ScheduleTypeLimitsFraction)
-      space_design_level = sch.calcDesignLevelFromDailykWh(kwh / 365.0)
+      space_design_level = sch.calc_design_level_from_daily_kwh(kwh / 365.0)
       sch = sch.schedule
     else
       runner.registerWarning("Both '#{col_name}' schedule file and weekday fractions provided; the latter will be ignored.") if !plug_load.weekday_fractions.nil?
@@ -79,7 +79,7 @@ class MiscLoads
       end
       if sch.nil?
         sch = MonthWeekdayWeekendSchedule.new(model, obj_name + ' schedule', fuel_load.weekday_fractions, fuel_load.weekend_fractions, fuel_load.monthly_multipliers, Constants.ScheduleTypeLimitsFraction)
-        space_design_level = sch.calcDesignLevelFromDailyTherm(therm / 365.0)
+        space_design_level = sch.calc_design_level_from_daily_therm(therm / 365.0)
         sch = sch.schedule
       else
         runner.registerWarning("Both '#{col_name}' schedule file and weekday fractions provided; the latter will be ignored.") if !fuel_load.weekday_fractions.nil?
@@ -108,7 +108,7 @@ class MiscLoads
     mfl.setSchedule(sch)
   end
 
-  def self.apply_pool_or_hot_tub_heater(model, pool_or_hot_tub, obj_name, living_space, schedules_file)
+  def self.apply_pool_or_hot_tub_heater(runner, model, pool_or_hot_tub, obj_name, living_space, schedules_file)
     return if pool_or_hot_tub.heater_type == HPXML::TypeNone
 
     heater_kwh = 0
@@ -142,7 +142,7 @@ class MiscLoads
       if (not schedules_file.nil?)
         space_design_level = schedules_file.calc_design_level_from_annual_kwh(col_name: col_name, annual_kwh: heater_kwh)
       else
-        space_design_level = heater_sch.calcDesignLevelFromDailykWh(heater_kwh / 365.0)
+        space_design_level = heater_sch.calc_design_level_from_daily_kwh(heater_kwh / 365.0)
         heater_sch = heater_sch.schedule
       end
 
@@ -150,7 +150,7 @@ class MiscLoads
       mel = OpenStudio::Model::ElectricEquipment.new(mel_def)
       mel.setName(obj_name)
       mel.setEndUseSubcategory(obj_name)
-      mel.setSpace(living_space)
+      mel.setSpace(living_space) # no heat gain, so assign the equipment to an arbitrary space
       mel_def.setName(obj_name)
       mel_def.setDesignLevel(space_design_level)
       mel_def.setFractionRadiant(0)
@@ -162,8 +162,9 @@ class MiscLoads
     if heater_therm > 0
       if not schedules_file.nil?
         space_design_level = schedules_file.calc_design_level_from_annual_therm(col_name: col_name, annual_therm: heater_therm)
-      else
-        space_design_level = heater_sch.calcDesignLevelFromDailyTherm(heater_therm / 365.0)
+      end
+      if space_design_level.nil?
+        space_design_level = heater_sch.calc_design_level_from_daily_therm(heater_therm / 365.0)
         heater_sch = heater_sch.schedule
       end
 
@@ -172,7 +173,7 @@ class MiscLoads
       mfl.setName(obj_name)
       mfl.setEndUseSubcategory(obj_name)
       mfl.setFuelType(EPlus.fuel_type(HPXML::FuelTypeNaturalGas))
-      mfl.setSpace(living_space)
+      mfl.setSpace(living_space) # no heat gain, so assign the equipment to an arbitrary space
       mfl_def.setName(obj_name)
       mfl_def.setDesignLevel(space_design_level)
       mfl_def.setFractionRadiant(0)
@@ -182,7 +183,7 @@ class MiscLoads
     end
   end
 
-  def self.apply_pool_or_hot_tub_pump(model, pool_or_hot_tub, obj_name, living_space, schedules_file)
+  def self.apply_pool_or_hot_tub_pump(runner, model, pool_or_hot_tub, obj_name, living_space, schedules_file)
     pump_kwh = 0
 
     # Create schedule
@@ -210,8 +211,9 @@ class MiscLoads
     if pump_kwh > 0
       if not schedules_file.nil?
         space_design_level = schedules_file.calc_design_level_from_annual_kwh(col_name: col_name, annual_kwh: pump_kwh)
-      else
-        space_design_level = pump_sch.calcDesignLevelFromDailykWh(pump_kwh / 365.0)
+      end
+      if space_design_level.nil?
+        space_design_level = pump_sch.calc_design_level_from_daily_kwh(pump_kwh / 365.0)
         pump_sch = pump_sch.schedule
       end
 
@@ -219,7 +221,7 @@ class MiscLoads
       mel = OpenStudio::Model::ElectricEquipment.new(mel_def)
       mel.setName(obj_name)
       mel.setEndUseSubcategory(obj_name)
-      mel.setSpace(living_space)
+      mel.setSpace(living_space) # no heat gain, so assign the equipment to an arbitrary space
       mel_def.setName(obj_name)
       mel_def.setDesignLevel(space_design_level)
       mel_def.setFractionRadiant(0)

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

@@ -55,6 +55,7 @@ class EUT
   Fireplace = 'Fireplace'
   PV = 'PV'
   Generator = 'Generator'
+  Battery = 'Battery'
 end
 
 class HWT
@@ -139,19 +140,10 @@ class WT
 end
 
 class OutputMethods
-  def self.get_timestamps(timeseries_frequency, msgpackData, hpxml, add_dst_column = false, add_utc_column = false)
+  def self.get_timestamps(msgpackData, hpxml, use_timestamp_start_convention, add_dst_column = false, add_utc_column = false,
+                          use_dview_format = false, timeseries_frequency = nil)
     return if msgpackData.nil?
 
-    if timeseries_frequency == 'hourly'
-      interval_type = 1
-    elsif timeseries_frequency == 'daily'
-      interval_type = 2
-    elsif timeseries_frequency == 'monthly'
-      interval_type = 3
-    elsif timeseries_frequency == 'timestep'
-      interval_type = -1
-    end
-
     if msgpackData.keys.include? 'MeterData'
       # Get data for ReportUtilityBills measure
       ep_timestamps = msgpackData['MeterData']['Monthly']['Rows'].map { |r| r.keys[0] }
@@ -160,7 +152,7 @@ class OutputMethods
       ep_timestamps = msgpackData['Rows'].map { |r| r.keys[0] }
     end
 
-    if add_dst_column
+    if add_dst_column || use_dview_format
       dst_start_ts = Time.utc(hpxml.header.sim_calendar_year, hpxml.header.dst_begin_month, hpxml.header.dst_begin_day, 2)
       dst_end_ts = Time.utc(hpxml.header.sim_calendar_year, hpxml.header.dst_end_month, hpxml.header.dst_end_day, 1)
     end
@@ -170,18 +162,35 @@ class OutputMethods
     end
 
     timestamps = []
-    timestamps_dst = [] if add_dst_column
+    timestamps_dst = [] if add_dst_column || use_dview_format
     timestamps_utc = [] if add_utc_column
-    year = hpxml.header.sim_calendar_year.to_s
+    year = hpxml.header.sim_calendar_year
     ep_timestamps.each do |ep_timestamp|
       month_day, hour_minute = ep_timestamp.split(' ')
-      month, day = month_day.split('/')
-      hour, minute, _ = hour_minute.split(':')
+      month, day = month_day.split('/').map(&:to_i)
+      hour, minute, _ = hour_minute.split(':').map(&:to_i)
+
+      # Convert from EnergyPlus default (end-of-timestep) to start-of-timestep convention
+      if use_timestamp_start_convention
+        if timeseries_frequency == 'timestep'
+          ts_offset = hpxml.header.timestep * 60 # seconds
+        elsif timeseries_frequency == 'hourly'
+          ts_offset = 60 * 60 # seconds
+        elsif timeseries_frequency == 'daily'
+          ts_offset = 60 * 60 * 24 # seconds
+        elsif timeseries_frequency == 'monthly'
+          ts_offset = Constants.NumDaysInMonths(year)[month - 1] * 60 * 60 * 24 # seconds
+        else
+          fail 'Unexpected timeseries_frequency/'
+        end
+      end
+
       ts = Time.utc(year, month, day, hour, minute)
+      ts -= ts_offset unless ts_offset.nil?
 
       timestamps << ts.iso8601.delete('Z')
 
-      if add_dst_column
+      if add_dst_column || use_dview_format
         if (ts >= dst_start_ts) && (ts < dst_end_ts)
           ts_dst = ts + 3600 # 1 hr shift forward
         else
@@ -207,4 +216,17 @@ class OutputMethods
       'monthly' => 'Monthly',
     }
   end
+
+  def self.get_dst_start_end_indexes(timestamps, timestamps_dst)
+    dst_start_ix = nil
+    dst_end_ix = nil
+    timestamps.zip(timestamps_dst).each_with_index do |ts, i|
+      dst_start_ix = i if ts[0] != ts[1] && dst_start_ix.nil?
+      dst_end_ix = i if ts[0] == ts[1] && dst_end_ix.nil? && !dst_start_ix.nil?
+    end
+
+    dst_end_ix = timestamps.size - 1 if dst_end_ix.nil? # run period ends before DST ends
+
+    return dst_start_ix, dst_end_ix
+  end
 end

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

@@ -809,7 +809,7 @@ class Psychrometrics
     itmax = 50 # maximum iterations
     cvg = false
 
-    (1...itmax + 1).each do |i|
+    for i in 1..itmax
       w_ADP = w_fT_R_P_SI(t_ADP, 1.0, p)
       error = h_ADP - h_fT_w_SI(t_ADP, w_ADP)