urbanopt-cli 0.8.3 → 0.9.1

data/example_files/resources/hpxml-measures/BuildResidentialScheduleFile/tests/build_residential_schedule_file_test.rb

@@ -33,7 +33,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('smooth schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -42,7 +41,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     assert_in_epsilon(6020, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
@@ -72,6 +71,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(2994, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4158, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4204, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
   end
 
@@ -84,7 +84,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('smooth schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -93,7 +92,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod=Dec 1 - Jan 31') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     vacancy_hrs = 31.0 * 2.0 * 24.0
@@ -126,6 +125,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(2994 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4158 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4204 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert_in_epsilon(vacancy_hrs, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnVacancy, schedules: sf.tmp_schedules), 0.1)
   end
 
@@ -138,7 +138,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('stochastic schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -147,7 +146,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
@@ -177,9 +176,55 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(298, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(325, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
   end
 
+  def test_stochastic_subset_of_columns
+    hpxml = _create_hpxml('base.xml')
+    XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
+
+    columns = [SchedulesFile::ColumnCookingRange,
+               SchedulesFile::ColumnDishwasher,
+               SchedulesFile::ColumnHotWaterDishwasher,
+               SchedulesFile::ColumnClothesWasher,
+               SchedulesFile::ColumnHotWaterClothesWasher,
+               SchedulesFile::ColumnClothesDryer,
+               SchedulesFile::ColumnHotWaterFixtures]
+
+    @args_hash['schedules_type'] = 'stochastic'
+    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+    @args_hash['schedules_column_names'] = columns.join(', ')
+    model, hpxml, result = _test_measure()
+
+    info_msgs = result.info.map { |x| x.logMessage }
+    assert(info_msgs.any? { |info_msg| info_msg.include?('ColumnNames') })
+
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
+    sf.validate_schedules(year: 2007)
+
+    columns.each do |column|
+      assert(sf.schedules.keys.include?(column))
+    end
+    (SchedulesFile.ColumnNames - columns).each do |column|
+      assert(!sf.schedules.keys.include?(column))
+    end
+  end
+
+  def test_stochastic_subset_of_columns_invalid_name
+    hpxml = _create_hpxml('base.xml')
+    XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
+
+    @args_hash['schedules_type'] = 'stochastic'
+    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+    @args_hash['schedules_column_names'] = "foobar, #{SchedulesFile::ColumnCookingRange}, foobar2"
+    _model, _hpxml, result = _test_measure(expect_fail: true)
+
+    error_msgs = result.errors.map { |x| x.logMessage }
+    assert(error_msgs.any? { |error_msg| error_msg.include?("Invalid column name specified: 'foobar'.") })
+    assert(error_msgs.any? { |error_msg| error_msg.include?("Invalid column name specified: 'foobar2'.") })
+  end
+
   def test_stochastic_vacancy
     hpxml = _create_hpxml('base.xml')
     XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
@@ -190,7 +235,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('stochastic schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -199,7 +243,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod=Dec 1 - Jan 31') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     vacancy_hrs = 31.0 * 2.0 * 24.0
@@ -232,9 +276,62 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(298 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(325 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(887 * occupied_ratio, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert_in_epsilon(vacancy_hrs, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnVacancy, schedules: sf.tmp_schedules), 0.1)
   end
 
+  def test_stochastic_debug
+    hpxml = _create_hpxml('base.xml')
+    XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
+
+    @args_hash['schedules_type'] = 'stochastic'
+    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+    @args_hash['debug'] = true
+    model, hpxml, result = _test_measure()
+
+    info_msgs = result.info.map { |x| x.logMessage }
+    assert(info_msgs.any? { |info_msg| info_msg.include?('stochastic schedule') })
+    assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
+    assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
+    assert(info_msgs.any? { |info_msg| info_msg.include?('State=CO') })
+    assert(!info_msgs.any? { |info_msg| info_msg.include?('RandomSeed') })
+    assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
+    assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
+
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
+    sf.validate_schedules(year: 2007)
+
+    assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingInterior, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(4090, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingExterior, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(4090, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingGarage, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(150, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnLightingExteriorHoliday, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnCookingRange, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(6673, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnRefrigerator, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(6673, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnExtraRefrigerator, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(6673, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnFreezer, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnDishwasher, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnClothesWasher, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnClothesDryer, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(3250, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnCeilingFan, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(4840, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPlugLoadsOther, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2288, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPlugLoadsTV, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(8760, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPlugLoadsVehicle, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(3671, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPlugLoadsWellPump, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2074, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnFuelLoadsGrill, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(3671, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnFuelLoadsLighting, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(3671, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnFuelLoadsFireplace, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2471, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPoolPump, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2471, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnPoolHeater, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2502, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotTubPump, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(2650, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotTubHeater, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(298, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(325, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert_in_epsilon(3067, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnSleeping, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
+  end
+
   def test_random_seed
     hpxml = _create_hpxml('base-location-baltimore-md.xml')
     XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
@@ -245,7 +342,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('stochastic schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -254,7 +350,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
@@ -284,13 +380,13 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(298, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(325, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(898, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
 
     @args_hash['schedules_random_seed'] = 2
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('stochastic schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -299,7 +395,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
@@ -329,6 +425,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(226, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(244, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(1077, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
   end
 
@@ -341,7 +438,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('smooth schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2012') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=60') })
@@ -350,7 +446,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod=Jan 1 - Dec 31') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2012)
 
     vacancy_hrs = 366.0 * 24.0
@@ -382,6 +478,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(0, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(0, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(0, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert_in_epsilon(vacancy_hrs, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnVacancy, schedules: sf.tmp_schedules), 0.1)
   end
 
@@ -393,7 +490,6 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     model, hpxml, result = _test_measure()
 
     info_msgs = result.info.map { |x| x.logMessage }
-    warn_msgs = result.warnings.map { |x| x.logMessage }
     assert(info_msgs.any? { |info_msg| info_msg.include?('smooth schedule') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('SimYear=2007') })
     assert(info_msgs.any? { |info_msg| info_msg.include?('MinutesPerStep=10') })
@@ -402,7 +498,7 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert(info_msgs.any? { |info_msg| info_msg.include?('GeometryNumOccupants=3.0') })
     assert(!info_msgs.any? { |info_msg| info_msg.include?('VacancyPeriod') })
 
-    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths, col_names: SchedulesFile.ColumnNames)
+    sf = SchedulesFile.new(model: model, schedules_paths: hpxml.header.schedules_filepaths)
     sf.validate_schedules(year: 2007)
 
     assert_in_epsilon(6020, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnOccupants, schedules: sf.tmp_schedules), 0.1)
@@ -432,10 +528,32 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     assert_in_epsilon(2994, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterDishwasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4158, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterClothesWasher, schedules: sf.tmp_schedules), 0.1)
     assert_in_epsilon(4204, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::ColumnHotWaterFixtures, schedules: sf.tmp_schedules), 0.1)
+    assert(!sf.schedules.keys.include?(SchedulesFile::ColumnSleeping))
     assert(!sf.schedules.keys.include?(SchedulesFile::ColumnVacancy))
   end
 
-  def _test_measure()
+  def test_non_integer_number_of_occupants
+    ['smooth', 'stochastic'].each do |schedule_mode|
+      num_occupants = 3.2
+
+      hpxml = _create_hpxml('base.xml')
+      hpxml.building_occupancy.number_of_residents = num_occupants
+      XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
+
+      @args_hash['schedules_type'] = schedule_mode
+      @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, "occupancy-#{schedule_mode}.csv"))
+      _model, _hpxml, result = _test_measure()
+
+      info_msgs = result.info.map { |x| x.logMessage }
+      if schedule_mode == 'smooth'
+        assert(info_msgs.any? { |info_msg| info_msg.include?("GeometryNumOccupants=#{num_occupants}") })
+      else
+        assert(info_msgs.any? { |info_msg| info_msg.include?("GeometryNumOccupants=#{Float(Integer(num_occupants))}") })
+      end
+    end
+  end
+
+  def _test_measure(expect_fail: false)
     # create an instance of the measure
     measure = BuildResidentialScheduleFile.new
 
@@ -459,11 +577,14 @@ class BuildResidentialScheduleFileTest < Minitest::Test
     measure.run(model, runner, argument_map)
     result = runner.result
 
-    # show the output
-    show_output(result) unless result.value.valueName == 'Success'
-
     # assert that it ran correctly
-    assert_equal('Success', result.value.valueName)
+    if expect_fail
+      show_output(result) unless result.value.valueName == 'Fail'
+      assert_equal('Fail', result.value.valueName)
+    else
+      show_output(result) unless result.value.valueName == 'Success'
+      assert_equal('Success', result.value.valueName)
+    end
 
     hpxml = HPXML.new(hpxml_path: @tmp_hpxml_path)
 

data/example_files/resources/hpxml-measures/Changelog.md

@@ -1,3 +1,79 @@
+## OpenStudio-HPXML v1.5.1
+
+__New Features__
+- When `Battery/Location` not provided, now defaults to garage if present, otherwise outside.
+- BuildResidentialScheduleFile measure:
+  - Allows requesting a subset of end uses (columns) to be generated.
+
+__Bugfixes__
+- Fixes total/net electricity timeseries outputs to include battery charging/discharging energy.
+- Fixes error when a non-electric water heater has jacket insulation and the UEF metric is used.
+
+## OpenStudio-HPXML v1.5.0
+
+__New Features__
+- Updates to OpenStudio 3.5.0/EnergyPlus 22.2.
+- Updates to newer proposed HPXML v4.0:
+  - **Breaking change**: Replaces `FrameFloors/FrameFloor` with `Floors/Floor`.
+  - **Breaking change**: `Floor/FloorType` (WoodFrame, StructuralInsulatedPanel, SteelFrame, or SolidConcrete) is a required input.
+  - **Breaking change**: All `Ducts` must now have a `SystemIdentifier`.
+  - **Breaking change**: Replaces `WallType/StructurallyInsulatedPanel` with `WallType/StructuralInsulatedPanel`.
+  - **Breaking change**: Replaces `SoftwareInfo/extension/SimulationControl/DaylightSaving/Enabled` with `Building/Site/TimeZone/DSTObserved`.
+  - **Breaking change**: Replaces `StandbyLoss` with `StandbyLoss[Units="F/hr"]/Value` for an indirect water heater.
+  - **Breaking change**: Replaces `BranchPipingLoopLength` with `BranchPipingLength` for a hot water recirculation system.
+  - **Breaking change**: Replaces `Floor/extension/OtherSpaceAboveOrBelow` with `Floor/FloorOrCeiling`.
+  - **Breaking change**: For PTAC with heating, replaces `HeatingSystem` of type PackagedTerminalAirConditionerHeating with `CoolingSystem/IntegratedHeating*` elements.
+- **Breaking change**: Now performs full HPXML XSD schema validation (previously just limited checks); yields runtime speed improvements.
+- **Breaking change**: HVAC/DHW equipment efficiencies can no longer be defaulted (e.g., based on age of equipment); they are now required.
+- **Breaking change**: Deprecates ReportHPXMLOutput measure; HVAC autosized capacities & design loads moved to `results_annual.csv`.
+- **Breaking change**: BuildResidentialHPXML measure: Replaces arguments using 'auto' for defaults with optional arguments of the appropriate data type.
+- Utility bill calculations:
+  - **Breaking change**: Removes utility rate and PV related arguments from the ReportUtilityBills measure in lieu of HPXML file inputs.
+  - Allows calculating one or more utility bill scenarios (e.g., net metering vs feed-in tariff compensation types for a simulation with PV).
+  - Adds detailed calculations for tiered, time-of-use, or real-time pricing electric rates using OpenEI tariff files.  
+- Lithium ion battery:
+  - Allows detailed charging/discharging schedules via CSV files.
+  - Allows setting round trip efficiency.
+  - **Breaking change**: Lifetime model is temporarily disabled; `Battery/extension/LifetimeModel` is not allowed.
+- Allows SEER2/HSPF2 efficiency types for central air conditioners and heat pumps.
+- Allows setting the natural ventilation availability (days/week that operable windows can be opened); default changed from 7 to 3 (M/W/F).
+- Allows specifying duct surface area multipliers.
+- Allows modeling CFIS ventilation systems with supplemental fans.
+- Allows shared dishwasher/clothes washer to be attached to a hot water distribution system instead of a single water heater.
+- Allows heating/cooling seasons that don't span the entire year.
+- Allows modeling room air conditioners with heating or reverse cycle.
+- Allows setting the ground soil conductivity used for foundation heat transfer and ground source heat pumps.
+- Allows setting the EnergyPlus temperature capacitance multiplier.
+- EnergyPlus modeling changes:
+  - Switches Kiva foundation model timestep from 'Hourly' to 'Timestep'; small increase in runtime for sub-hourly simulations.
+  - Improves Kiva foundation model heat transfer by providing better initial temperature assumptions based on foundation type and insulation levels.
+- Annual/timeseries outputs:
+  - Allows timeseries timestamps to be start or end of timestep convention; **Breaking change**: now defaults to start of timestep.
+  - Adds annual emission outputs disaggregated by end use; timeseries emission outputs disaggregated by end use can be requested.
+  - Allows generating timeseries unmet hours for heating and cooling.
+  - Allows CSV timeseries output to be formatted for use with the DView application.
+  - Adds heating/cooling setpoints to timeseries outputs when requesting zone temperatures.
+  - Disaggregates Battery outputs from PV outputs.
+  - Design temperatures, used to calculate design loads for HVAC equipment autosizing, are now output in `in.xml` and `results_annual.csv`.
+
+__Bugfixes__
+- Fixes possible incorrect autosizing of heat pump *separate* backup systems with respect to duct loads.
+- Fixes incorrect autosizing of heat pump *integrated* backup systems if using MaxLoad/HERS sizing methodology and cooling design load exceeds heating design load.
+- Fixes heating (or cooling) setpoints affecting the conditioned space temperature outside the heating (or cooling) season.
+- Fixes handling non-integer number of occupants when using the stochastic occupancy schedule generator.
+- Fixes units for Peak Loads (kBtu/hr, not kBtu) in annual results file.
+- Fixes possible output error for ground source heat pumps with a shared hydronic circulation loop.
+- Provides an error message if the EnergyPlus simulation used infinite energy.
+- Fixes zero energy use for a ventilation fan w/ non-zero fan power and zero airflow rate.
+- Fixes excessive heat transfer when foundation wall interior insulation does not start from the top of the wall.
+- Fixes how relative paths are treated when using an OpenStudio Workflow.
+- Fixes possible simulation error if a slab has an ExposedPerimeter near zero.
+- Fixes possible "Could not identify surface type for surface" error.
+- Fixes possible ruby error when defaulting water heater location.
+- Battery round trip efficiency now correctly affects results.
+- BuildResidentialHPXML measure: 
+  - Fixes aspect ratio convention for single-family attached and multifamily dwelling units.
+
 ## OpenStudio-HPXML v1.4.0
 
 __New Features__
@@ -240,7 +316,7 @@ __Bugfixes__
 
 __New Features__
 - New [Schematron](http://schematron.com) validation (EPvalidator.xml) replaces custom ruby validation (EPvalidator.rb)
-- **[Breaking Change]** `BuildingConstruction/ResidentialFacilityType` ("single-family detached", "single-family attached", "apartment unit", or "manufactured home") is a required input
+- **[Breaking change]** `BuildingConstruction/ResidentialFacilityType` ("single-family detached", "single-family attached", "apartment unit", or "manufactured home") is a required input
 - Ability to model shared systems for Attached/Multifamily dwelling units
   - Shared HVAC systems (cooling towers, chillers, central boilers, water loop heat pumps, fan coils, ground source heat pumps on shared hydronic circulation loops)
   - Shared water heaters serving either A) multiple dwelling units' service hot water or B) a shared laundry/equipment room, as well as hot water recirculation systems
@@ -248,7 +324,7 @@ __New Features__
   - Shared hot water recirculation systems
   - Shared ventilation systems (optionally with preconditioning equipment and recirculation)
   - Shared PV systems
-  - **[Breaking Change]** Appliances located in MF spaces (i.e., "other") must now be specified in more detail (i.e., "other heated space", "other non-freezing space", "other multifamily buffer space", or "other housing unit")
+  - **[Breaking change]** Appliances located in MF spaces (i.e., "other") must now be specified in more detail (i.e., "other heated space", "other non-freezing space", "other multifamily buffer space", or "other housing unit")
 - Enclosure
   - New optional inputs: `Roof/RoofType`, `Wall/Siding`, and `RimJoist/Siding`
   - New optional inputs: `Skylight/InteriorShading/SummerShadingCoefficient` and `Skylight/InteriorShading/SummerShadingCoefficient`
@@ -256,7 +332,7 @@ __New Features__
   - New optional input to specify presence of flue/chimney, which results in increased infiltration
   - Allows adobe wall type
   - Allows `AirInfiltrationMeasurement/HousePressure` to be any value (previously required to be 50 Pa)
-  - **[Breaking Change]** `Roof/RadiantBarrierGrade` input now required when there is a radiant barrier
+  - **[Breaking change]** `Roof/RadiantBarrierGrade` input now required when there is a radiant barrier
 - HVAC
   - Adds optional high-level HVAC autosizing controls
     - `AllowIncreasedFixedCapacities`: Describes how HVAC equipment with fixed capacities are handled. If true, the maximum of the user-specified fixed capacity and the heating/cooling design load will be used to reduce potential for unmet loads. Defaults to false.
@@ -268,11 +344,11 @@ __New Features__
 - Appliances & Plug Loads
   - Allows _multiple_ `Refrigerator` and `Freezer`
   - Allows `Pool`, `HotTub`, `PlugLoad` of type "electric vehicle charging" and "well pump", and `FuelLoad` of type "grill", "lighting", and "fireplace"
-  - **[Breaking Change]** "other" and "TV other" plug loads now required
+  - **[Breaking change]** "other" and "TV other" plug loads now required
 - Lighting
   - Allows lighting schedules and holiday lighting
-- **[Breaking Change]** For hydronic distributions, `HydronicDistributionType` is now required
-- **[Breaking Change]** For DSE distributions, `AnnualHeatingDistributionSystemEfficiency` and `AnnualCoolingDistributionSystemEfficiency` are both always required
+- **[Breaking change]** For hydronic distributions, `HydronicDistributionType` is now required
+- **[Breaking change]** For DSE distributions, `AnnualHeatingDistributionSystemEfficiency` and `AnnualCoolingDistributionSystemEfficiency` are both always required
 - Allows more HPXML fuel types to be used for HVAC, water heating, appliances, etc.
 - New inputs to define Daylight Saving period; defaults to enabled
 - Adds more reporting of warnings/errors to run.log
@@ -288,7 +364,7 @@ __Bugfixes__
 __New Features__
 - Dwelling units of single-family attached/multifamily buildings:
   - Adds new generic space types "other heated space", "other multifamily buffer space", and "other non-freezing space" for surface `ExteriorAdjacentTo` elements. "other housing unit", i.e. adiabatic surfaces, was already supported.
-  - **[Breaking Change]** For `FrameFloors`, replaces "other housing unit above" and "other housing unit below" enumerations with "other housing unit". All four "other ..." spaces must have an `extension/OtherSpaceAboveOrBelow` property set to either "above" or "below".
+  - **[Breaking change]** For `FrameFloors`, replaces "other housing unit above" and "other housing unit below" enumerations with "other housing unit". All four "other ..." spaces must have an `extension/OtherSpaceAboveOrBelow` property set to either "above" or "below".
   - Allows ducts and water heaters to be located in all "other ..." spaces.
   - Allows all appliances to be located in "other", in which internal gains are neglected.
 - Allows `Fireplace` and `FloorFurnace` for heating system types.
@@ -299,15 +375,15 @@ __New Features__
 - Allows user-specified `Refrigerator` and `CookingRange` schedules to be provided.
 - HVAC capacity elements are no longer required; if not provided, ACCA Manual J autosizing calculations will be used (-1 can continue to be used for capacity elements but is discouraged).
 - Duct locations/areas can be defaulted by specifying supply/return `Duct` elements without `DuctSurfaceArea` and `DuctLocation`. `HVACDistribution/DistributionSystemType/AirDistribution/NumberofReturnRegisters` can be optionally provided to inform the default duct area calculations.
-- **[Breaking Change]** Lighting inputs now use `LightingType[LightEmittingDiode | CompactFluorescent | FluorescentTube]` instead of `ThirdPartyCertification="ERI Tier I" or ThirdPartyCertification="ERI Tier II"`.
-- **[Breaking Change]** `HVACDistribution/ConditionedFloorAreaServed` is now required for air distribution systems.
-- **[Breaking Change]** Infiltration and attic ventilation specified using natural air changes per hour now uses `ACHnatural` instead of `extension/ConstantACHnatural`.
-- **[Breaking Change]** The optional `PerformanceAdjustment` input for instantaneous water heaters is now treated as a performance multiplier (e.g., 0.92) instead of derate (e.g., 0.08).
+- **[Breaking change]** Lighting inputs now use `LightingType[LightEmittingDiode | CompactFluorescent | FluorescentTube]` instead of `ThirdPartyCertification="ERI Tier I" or ThirdPartyCertification="ERI Tier II"`.
+- **[Breaking change]** `HVACDistribution/ConditionedFloorAreaServed` is now required for air distribution systems.
+- **[Breaking change]** Infiltration and attic ventilation specified using natural air changes per hour now uses `ACHnatural` instead of `extension/ConstantACHnatural`.
+- **[Breaking change]** The optional `PerformanceAdjustment` input for instantaneous water heaters is now treated as a performance multiplier (e.g., 0.92) instead of derate (e.g., 0.08).
 - Adds ASHRAE 140 Class II test files.
 - SimulationOutputReport reporting measure:
   - New optional timeseries outputs:  airflows (e.g., infiltration, mechanical ventilation, natural ventilation, whole house fan) and weather (e.g., temperatures, wind speed, solar).
   - Timeseries frequency can now be set to 'none' as an alternative to setting all include_timeseries_foo variables to false.
-  - **[Breaking Change]** Renames "Wood" to "Wood Cord" to better distinguish from "Wood Pellets".
+  - **[Breaking change]** Renames "Wood" to "Wood Cord" to better distinguish from "Wood Pellets".
 - Modeling improvements:
   - Improved calculation for infiltration height
   - Infiltration & mechanical ventilation now combined using ASHRAE 62.2 Normative Appendix C.
@@ -333,10 +409,10 @@ __Bugfixes__
 ## OpenStudio-HPXML v0.9.0 Beta
 
 __New Features__
-- **[Breaking Change]** Updates to OpenStudio v3.0.0 and EnergyPlus 9.3
+- **[Breaking change]** Updates to OpenStudio v3.0.0 and EnergyPlus 9.3
 - Numerous HPXML inputs are now optional with built-in defaulting, particularly for water heating, appliances, and PV. Set the `debug` argument to true to output a in.xml HPXML file with defaults applied for inspection. See the documentation for defaulting equations/assumptions/references.
-- **[Breaking Change]** If clothes washer efficiency inputs are provided, `LabelUsage` is now required.
-- **[Breaking Change]** If dishwasher efficiency inputs are provided, `LabelElectricRate`, `LabelGasRate`, `LabelAnnualGasCost`, and `LabelUsage` are now required.
+- **[Breaking change]** If clothes washer efficiency inputs are provided, `LabelUsage` is now required.
+- **[Breaking change]** If dishwasher efficiency inputs are provided, `LabelElectricRate`, `LabelGasRate`, `LabelAnnualGasCost`, and `LabelUsage` are now required.
 - Adds optional specification of simulation controls including timestep and begin/end dates.
 - Adds optional `extension/UsageMultiplier` inputs for appliances, plug loads, lighting, and water fixtures. Can be used to, e.g., reflect high/low usage occupants.
 - Adds ability to model a dehumidifier.
@@ -344,9 +420,9 @@ __New Features__
 - Improved desuperheater model; desuperheater can now be connected to heat pump water heaters.
 - Updated clothes washer/dryer and dishwasher models per ANSI/RESNET/ICC 301-2019 Addendum A.
 - Solar thermal systems modeled with `SolarFraction` can now be connected to combi water heating systems.
-- **[Breaking Change]** Replaces optional `epw_output_path` and `osm_output_path` arguments with a single optional `output_dir` argument; adds an optional `debug` argument.
-- **[Breaking Change]** Replaces optional `BuildingConstruction/extension/FractionofOperableWindowArea` with optional `Window/FractionOperable`.
-- **[Breaking Change]** Replaces optional `extension/EPWFileName` with optional `extension/EPWFilePath` to allow absolute paths to be provided as an alternative to just the file name.
+- **[Breaking change]** Replaces optional `epw_output_path` and `osm_output_path` arguments with a single optional `output_dir` argument; adds an optional `debug` argument.
+- **[Breaking change]** Replaces optional `BuildingConstruction/extension/FractionofOperableWindowArea` with optional `Window/FractionOperable`.
+- **[Breaking change]** Replaces optional `extension/EPWFileName` with optional `extension/EPWFilePath` to allow absolute paths to be provided as an alternative to just the file name.
 - Replaces REXML xml library with Oga for better runtime performance.
 - Additional error-checking.
 - SimulationOutputReport reporting measure:
@@ -364,7 +440,7 @@ __Bugfixes__
 
 ## OpenStudio-HPXML v0.8.0 Beta
 
-__Breaking Changes__
+__Breaking changes__
 - Weather cache files are now in .csv instead of .cache format.
 - `extension/StandbyLoss` changed to `StandbyLoss` for indirect water heaters.
 - `Site/extension/DisableNaturalVentilation` changed to `BuildingConstruction/extension/FractionofOperableWindowArea` for more granularity.

data/example_files/resources/hpxml-measures/Gemfile

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'nokogiri', '~> 1.10'
 gem 'oga'
-gem 'schematron-nokogiri'
 gem 'rake'
-gem 'minitest', '~> 5.9'
+gem 'minitest', '5.15'
 gem 'minitest-reporters'
 gem 'msgpack'
 gem 'parallel'

data/example_files/resources/hpxml-measures/Gemfile.lock

@@ -5,32 +5,23 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     docile (1.4.0)
-    mini_portile2 (2.8.0)
     minitest (5.15.0)
     minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    msgpack (1.5.1)
-    nokogiri (1.13.4)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    nokogiri (1.13.4-x64-mingw32)
-      racc (~> 1.4)
+    msgpack (1.5.2)
     oga (3.3)
       ast
       ruby-ll (~> 2.1)
     parallel (1.22.1)
-    racc (1.6.0)
     rake (13.0.6)
     ruby-ll (2.1.2)
       ansi
       ast
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
-    schematron-nokogiri (0.0.3)
-      nokogiri (~> 1.6)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -43,15 +34,13 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
-  minitest (~> 5.9)
+  minitest (= 5.15)
   minitest-reporters
   msgpack
-  nokogiri (~> 1.10)
   oga
   parallel
   rake
   rubyzip
-  schematron-nokogiri
   simplecov
   simplecov-html