urbanopt-cli 0.9.3 → 0.10.0

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_water_heater.rb

@@ -371,7 +371,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check water heater
     assert_equal(2, model.getWaterHeaterMixeds.size) # preheat tank + water heater
-    wh = model.getWaterHeaterMixeds.select { |wh| (not wh.name.get.include? 'storage tank') }[0]
+    wh = model.getWaterHeaterMixeds.find { |wh| (not wh.name.get.include? 'storage tank') }
     assert_equal(fuel, wh.heaterFuelType)
     assert_equal(loc, wh.ambientTemperatureThermalZone.get.name.get)
     assert_in_epsilon(tank_volume, wh.tankVolume.get, 0.001)
@@ -384,7 +384,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check desuperheater
     assert_equal(1, model.getCoilWaterHeatingDesuperheaters.size)
-    preheat_tank = model.getWaterHeaterMixeds.select { |wh| wh.name.get.include? 'storage tank' }[0]
+    preheat_tank = model.getWaterHeaterMixeds.find { |wh| wh.name.get.include? 'storage tank' }
     dsh_coil = model.getCoilWaterHeatingDesuperheaters[0]
     assert_equal(true, dsh_coil.heatingSource.get.to_CoilCoolingDXSingleSpeed.is_initialized)
     assert_equal(preheat_tank, dsh_coil.heatRejectionTarget.get.to_WaterHeaterMixed.get)
@@ -409,7 +409,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check water heater
     assert_equal(2, model.getWaterHeaterMixeds.size) # preheat tank + water heater
-    wh = model.getWaterHeaterMixeds.select { |wh| (not wh.name.get.include? 'storage tank') }[0]
+    wh = model.getWaterHeaterMixeds.find { |wh| (not wh.name.get.include? 'storage tank') }
     assert_equal(fuel, wh.heaterFuelType)
     assert_equal(loc, wh.ambientTemperatureThermalZone.get.name.get)
     assert_in_epsilon(tank_volume, wh.tankVolume.get, 0.001)
@@ -422,7 +422,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check desuperheater
     assert_equal(1, model.getCoilWaterHeatingDesuperheaters.size)
-    preheat_tank = model.getWaterHeaterMixeds.select { |wh| wh.name.get.include? 'storage tank' }[0]
+    preheat_tank = model.getWaterHeaterMixeds.find { |wh| wh.name.get.include? 'storage tank' }
     dsh_coil = model.getCoilWaterHeatingDesuperheaters[0]
     assert_equal(true, dsh_coil.heatingSource.get.to_CoilCoolingDXMultiSpeed.is_initialized)
     assert_equal(preheat_tank, dsh_coil.heatRejectionTarget.get.to_WaterHeaterMixed.get)
@@ -447,7 +447,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check water heater
     assert_equal(2, model.getWaterHeaterMixeds.size) # preheat tank + water heater
-    wh = model.getWaterHeaterMixeds.select { |wh| (not wh.name.get.include? 'storage tank') }[0]
+    wh = model.getWaterHeaterMixeds.find { |wh| (not wh.name.get.include? 'storage tank') }
     assert_equal(fuel, wh.heaterFuelType)
     assert_equal(loc, wh.ambientTemperatureThermalZone.get.name.get)
     assert_in_epsilon(tank_volume, wh.tankVolume.get, 0.001)
@@ -460,7 +460,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
 
     # Check desuperheater
     assert_equal(1, model.getCoilWaterHeatingDesuperheaters.size)
-    preheat_tank = model.getWaterHeaterMixeds.select { |wh| wh.name.get.include? 'storage tank' }[0]
+    preheat_tank = model.getWaterHeaterMixeds.find { |wh| wh.name.get.include? 'storage tank' }
     dsh_coil = model.getCoilWaterHeatingDesuperheaters[0]
     assert_equal(true, dsh_coil.heatingSource.get.to_CoilCoolingWaterToAirHeatPumpEquationFit.is_initialized)
     assert_equal(preheat_tank, dsh_coil.heatRejectionTarget.get.to_WaterHeaterMixed.get)
@@ -534,7 +534,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
       assert_equal(plant_loop.fluidType, 'Water')
       loop = plant_loop
     end
-    pump = loop.supplyComponents.select { |comp| comp.to_PumpConstantSpeed.is_initialized }[0]
+    pump = loop.supplyComponents.find { |comp| comp.to_PumpConstantSpeed.is_initialized }
     assert_equal(pump_power, pump.to_PumpConstantSpeed.get.ratedPowerConsumption.get)
     assert_equal(collector_attached_to_tank, true)
   end
@@ -607,7 +607,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
       assert_equal(plant_loop.fluidType, 'Water')
       loop = plant_loop
     end
-    pump = loop.supplyComponents.select { |comp| comp.to_PumpConstantSpeed.is_initialized }[0]
+    pump = loop.supplyComponents.find { |comp| comp.to_PumpConstantSpeed.is_initialized }
     assert_equal(pump_power, pump.to_PumpConstantSpeed.get.ratedPowerConsumption.get)
     assert_equal(collector_attached_to_tank, true)
   end
@@ -680,7 +680,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
       assert_equal(plant_loop.fluidType, 'PropyleneGlycol')
       loop = plant_loop
     end
-    pump = loop.supplyComponents.select { |comp| comp.to_PumpConstantSpeed.is_initialized }[0]
+    pump = loop.supplyComponents.find { |comp| comp.to_PumpConstantSpeed.is_initialized }
     assert_equal(pump_power, pump.to_PumpConstantSpeed.get.ratedPowerConsumption.get)
     assert_equal(collector_attached_to_tank, true)
   end
@@ -753,7 +753,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
       assert_equal(plant_loop.fluidType, 'Water')
       loop = plant_loop
     end
-    pump = loop.supplyComponents.select { |comp| comp.to_PumpConstantSpeed.is_initialized }[0]
+    pump = loop.supplyComponents.find { |comp| comp.to_PumpConstantSpeed.is_initialized }
     assert_equal(pump_power, pump.to_PumpConstantSpeed.get.ratedPowerConsumption.get)
     assert_equal(collector_attached_to_tank, true)
   end
@@ -821,7 +821,7 @@ class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
       assert_equal(plant_loop.fluidType, 'Water')
       loop = plant_loop
     end
-    pump = loop.supplyComponents.select { |comp| comp.to_PumpConstantSpeed.is_initialized }[0]
+    pump = loop.supplyComponents.find { |comp| comp.to_PumpConstantSpeed.is_initialized }
     assert_equal(pump_power, pump.to_PumpConstantSpeed.get.ratedPowerConsumption.get)
     assert_equal(collector_attached_to_tank, true)
   end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/tests/test_weather.rb

@@ -4,73 +4,211 @@ require_relative '../resources/minitest_helper'
 require 'openstudio'
 require 'openstudio/measure/ShowRunnerOutput'
 require 'fileutils'
-require_relative '../measure.rb'
-
-class HPXMLtoOpenStudioWaterHeaterTest < MiniTest::Test
-  def setup
-    @root_path = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..'))
-    @sample_files_path = File.join(@root_path, 'workflow', 'sample_files')
-    @cache_orig = File.join(@root_path, 'weather', 'USA_CO_Denver.Intl.AP.725650_TMY3-cache.csv')
-    @cache_bak = @cache_orig + '.bak'
-    File.rename(@cache_orig, @cache_bak) unless File.exist? @cache_bak
-  end
+require_relative '../resources/weather.rb'
+require_relative '../resources/unit_conversions.rb'
+require_relative '../resources/psychrometrics.rb'
+require_relative '../resources/materials.rb'
+require_relative '../resources/constants.rb'
+require_relative '../resources/util.rb'
 
-  def teardown
-    File.rename(@cache_bak, @cache_orig) if File.exist? @cache_bak # Put original file back
+class HPXMLtoOpenStudioWeatherTest < MiniTest::Test
+  def weather_dir
+    return File.join(File.dirname(__FILE__), '..', '..', 'weather')
   end
 
-  def test_weather_cache
-    args_hash = {}
-    args_hash['hpxml_path'] = File.absolute_path(File.join(@sample_files_path, 'base.xml'))
-    _model, _hpxml = _test_measure(args_hash)
-  end
+  def test_denver
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+    weather = WeatherProcess.new(epw_path: File.join(weather_dir, 'USA_CO_Denver.Intl.AP.725650_TMY3.epw'), runner: runner)
+
+    # Check header
+    assert_equal('Denver Intl Ap', weather.header.City)
+    assert_equal('CO', weather.header.State)
+    assert_equal('USA', weather.header.Country)
+    assert_equal('TMY3', weather.header.DataSource)
+    assert_equal('725650', weather.header.Station)
+    assert_equal(39.83, weather.header.Latitude)
+    assert_equal(-104.65, weather.header.Longitude)
+    assert_equal(-7.0, weather.header.Timezone)
+    assert_in_delta(5413.4, weather.header.Altitude, 0.1)
+    assert_in_delta(0.82, weather.header.LocalPressure, 0.01)
 
-  def test_weather_cache_marshal_dump
-    # DFHPs can trigger code in hvac_sizing.rb where we Marshal.dump the weather object.
-    # This tests that that code is successful.
-    # See https://github.com/NREL/OpenStudio-HPXML/pull/1144 for reference.
-    File.open(@cache_orig, 'w') do |_line| # Open file so that OS-HPXML can't write the cache file
-      args_hash = {}
-      args_hash['hpxml_path'] = File.absolute_path(File.join(@sample_files_path, 'base-hvac-dual-fuel-air-to-air-heat-pump-1-speed.xml'))
-      _model, _hpxml = _test_measure(args_hash)
+    # Check data
+    assert_equal(1, weather.header.RecordsPerHour)
+    assert_in_delta(51.6, weather.data.AnnualAvgDrybulb, 0.1)
+    assert_in_delta(3072.3, weather.data.CDD50F, 0.1)
+    assert_in_delta(883.6, weather.data.CDD65F, 0.1)
+    assert_in_delta(2497.2, weather.data.HDD50F, 0.1)
+    assert_in_delta(5783.5, weather.data.HDD65F, 0.1)
+    assert_equal(0.59, weather.data.WSF)
+    [33.4, 31.9, 43.0, 42.5, 59.9, 73.6, 72.1, 72.7, 66.5, 50.1, 37.2, 34.6].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDrybulbs[i], 0.1)
     end
+    [47.4, 46.6, 55.2, 53.7, 72.8, 88.7, 86.2, 85.9, 82.1, 63.2, 48.7, 48.9].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyHighDrybulbs[i], 0.1)
+    end
+    [19.3, 19.9, 30.3, 31.1, 47.4, 57.9, 59.1, 61.0, 52.4, 38.4, 27.0, 23.0].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyLowDrybulbs[i], 0.1)
+    end
+    [44.1, 40.9, 40.6, 42.2, 48.2, 54.3, 59.5, 62.8, 63.1, 60.4, 55.3, 49.4].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.GroundMonthlyTemps[i], 0.1)
+    end
+
+    # Check design
+    assert_in_delta(6.8, weather.design.HeatingDrybulb, 0.1)
+    assert_in_delta(91.8, weather.design.CoolingDrybulb, 0.1)
+    assert_in_delta(60.1, weather.design.CoolingWetbulb, 0.1)
+    assert_in_delta(0.0061, weather.design.CoolingHumidityRatio, 0.0001)
+    assert_in_delta(27.4, weather.design.DailyTemperatureRange, 0.1)
+
+    # Check runner
+    assert_equal(0, runner.result.stepErrors.size)
+    assert_equal(0, runner.result.stepWarnings.size)
   end
 
-  def _test_measure(args_hash)
-    # create an instance of the measure
-    measure = HPXMLtoOpenStudio.new
+  def test_honolulu
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+    weather = WeatherProcess.new(epw_path: File.join(weather_dir, 'USA_HI_Honolulu.Intl.AP.911820_TMY3.epw'), runner: runner)
+
+    # Check header
+    assert_equal('Honolulu Intl Arpt', weather.header.City)
+    assert_equal('HI', weather.header.State)
+    assert_equal('USA', weather.header.Country)
+    assert_equal('TMY3', weather.header.DataSource)
+    assert_equal('911820', weather.header.Station)
+    assert_equal(21.32, weather.header.Latitude)
+    assert_equal(-157.93, weather.header.Longitude)
+    assert_equal(-10.0, weather.header.Timezone)
+    assert_in_delta(6.6, weather.header.Altitude, 0.1)
+    assert_in_delta(1.0, weather.header.LocalPressure, 0.01)
 
+    # Check data
+    assert_equal(1, weather.header.RecordsPerHour)
+    assert_in_delta(76.8, weather.data.AnnualAvgDrybulb, 0.1)
+    assert_in_delta(9798.7, weather.data.CDD50F, 0.1)
+    assert_in_delta(4323.7, weather.data.CDD65F, 0.1)
+    assert_in_delta(0.0, weather.data.HDD50F, 0.1)
+    assert_in_delta(0.0, weather.data.HDD65F, 0.1)
+    assert_equal(0.42, weather.data.WSF)
+    [72.5, 73.0, 73.7, 74.8, 77.4, 78.6, 80.4, 80.7, 80.4, 79.2, 76.6, 74.6].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDrybulbs[i], 0.1)
+    end
+    [80.0, 80.6, 81.7, 82.5, 85.4, 84.3, 87.8, 88.9, 87.0, 88.2, 83.6, 80.6].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyHighDrybulbs[i], 0.1)
+    end
+    [66.1, 65.9, 66.6, 68.8, 70.7, 73.7, 75.2, 74.5, 75.2, 71.9, 70.6, 69.1].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyLowDrybulbs[i], 0.1)
+    end
+    [75.6, 75.0, 74.9, 75.2, 76.4, 77.6, 78.7, 79.3, 79.4, 78.9, 77.8, 76.7].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.GroundMonthlyTemps[i], 0.1)
+    end
+
+    # Check design
+    assert_in_delta(63.3, weather.design.HeatingDrybulb, 0.1)
+    assert_in_delta(89.1, weather.design.CoolingDrybulb, 0.1)
+    assert_in_delta(73.6, weather.design.CoolingWetbulb, 0.1)
+    assert_in_delta(0.0141, weather.design.CoolingHumidityRatio, 0.0001)
+    assert_in_delta(12.8, weather.design.DailyTemperatureRange, 0.1)
+
+    # Check runner
+    assert_equal(0, runner.result.stepErrors.size)
+    assert_equal(0, runner.result.stepWarnings.size)
+  end
+
+  def test_cape_town
     runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
-    model = OpenStudio::Model::Model.new
+    weather = WeatherProcess.new(epw_path: File.join(weather_dir, 'ZAF_Cape.Town.688160_IWEC.epw'), runner: runner)
 
-    # get arguments
-    args_hash['output_dir'] = File.dirname(__FILE__)
-    arguments = measure.arguments(model)
-    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+    # Check header
+    assert_equal('CAPE TOWN', weather.header.City)
+    assert_equal('-', weather.header.State)
+    assert_equal('ZAF', weather.header.Country)
+    assert_equal('IWEC Data', weather.header.DataSource)
+    assert_equal('688160', weather.header.Station)
+    assert_equal(-33.98, weather.header.Latitude)
+    assert_equal(18.6, weather.header.Longitude)
+    assert_equal(2.0, weather.header.Timezone)
+    assert_in_delta(137.8, weather.header.Altitude, 0.1)
+    assert_in_delta(1.0, weather.header.LocalPressure, 0.01)
 
-    # populate argument with specified hash value if specified
-    arguments.each do |arg|
-      temp_arg_var = arg.clone
-      if args_hash.has_key?(arg.name)
-        assert(temp_arg_var.setValue(args_hash[arg.name]))
-      end
-      argument_map[arg.name] = temp_arg_var
+    # Check data
+    assert_equal(1, weather.header.RecordsPerHour)
+    assert_in_delta(61.7, weather.data.AnnualAvgDrybulb, 0.1)
+    assert_in_delta(4297.8, weather.data.CDD50F, 0.1)
+    assert_in_delta(503.0, weather.data.CDD65F, 0.1)
+    assert_in_delta(17.5, weather.data.HDD50F, 0.1)
+    assert_in_delta(1697.6, weather.data.HDD65F, 0.1)
+    assert_equal(0.56, weather.data.WSF)
+    [69.5, 69.5, 66.4, 61.7, 58.6, 55.1, 54.2, 55.2, 57.8, 60.7, 65.0, 67.6].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDrybulbs[i], 0.1)
+    end
+    [79.0, 78.5, 74.2, 70.0, 68.8, 64.6, 63.3, 64.2, 66.4, 70.6, 72.3, 76.0].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyHighDrybulbs[i], 0.1)
+    end
+    [61.0, 61.9, 59.7, 54.5, 50.8, 46.7, 45.3, 47.7, 50.1, 50.6, 57.9, 59.6].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyLowDrybulbs[i], 0.1)
+    end
+    [59.2, 58.0, 57.9, 58.5, 60.7, 62.9, 64.9, 66.1, 66.2, 65.2, 63.3, 61.1].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.GroundMonthlyTemps[i], 0.1)
     end
 
-    # run the measure
-    measure.run(model, runner, argument_map)
-    result = runner.result
+    # Check design
+    assert_in_delta(41.0, weather.design.HeatingDrybulb, 0.1)
+    assert_in_delta(84.4, weather.design.CoolingDrybulb, 0.1)
+    assert_in_delta(66.2, weather.design.CoolingWetbulb, 0.1)
+    assert_in_delta(0.0095, weather.design.CoolingHumidityRatio, 0.0001)
+    assert_in_delta(17.1, weather.design.DailyTemperatureRange, 0.1)
 
-    # show the output
-    show_output(result) unless result.value.valueName == 'Success'
+    # Check runner
+    assert_equal(0, runner.result.stepErrors.size)
+    assert_equal(0, runner.result.stepWarnings.size)
+  end
+
+  def test_boulder_amy_with_leap_day
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+    weather = WeatherProcess.new(epw_path: File.join(weather_dir, 'US_CO_Boulder_AMY_2012.epw'), runner: runner)
 
-    # assert that it ran correctly
-    assert_equal('Success', result.value.valueName)
+    # Check header
+    assert_equal('Boulder', weather.header.City)
+    assert_equal('CO', weather.header.State)
+    assert_equal('US', weather.header.Country)
+    assert_equal('NSRDB 2.0.1 2012 AMY', weather.header.DataSource)
+    assert_equal('724699', weather.header.Station)
+    assert_equal(40.13, weather.header.Latitude)
+    assert_equal(-105.22, weather.header.Longitude)
+    assert_equal(-7.0, weather.header.Timezone)
+    assert_in_delta(5300.2, weather.header.Altitude, 0.1)
+    assert_in_delta(0.82, weather.header.LocalPressure, 0.01)
 
-    hpxml = HPXML.new(hpxml_path: args_hash['hpxml_path'])
+    # Check data
+    assert_equal(1, weather.header.RecordsPerHour)
+    assert_in_delta(49.4, weather.data.AnnualAvgDrybulb, 0.1)
+    assert_in_delta(2633.8, weather.data.CDD50F, 0.1)
+    assert_in_delta(609.1, weather.data.CDD65F, 0.1)
+    assert_in_delta(2863.0, weather.data.HDD50F, 0.1)
+    assert_in_delta(6328.3, weather.data.HDD65F, 0.1)
+    assert_equal(0.58, weather.data.WSF)
+    [30.8, 26.4, 43.0, 49.4, 56.8, 71.1, 71.2, 70.4, 60.8, 45.3, 39.6, 27.0].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDrybulbs[i], 0.1)
+    end
+    [42.4, 37.8, 59.1, 66.2, 73.9, 89.2, 86.2, 87.5, 76.5, 61.2, 54.5, 38.2].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyHighDrybulbs[i], 0.1)
+    end
+    [22.1, 17.4, 30.4, 34.4, 40.8, 54.1, 57.5, 55.6, 48.1, 33.5, 30.0, 18.9].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.MonthlyAvgDailyLowDrybulbs[i], 0.1)
+    end
+    [41.3, 37.9, 37.6, 39.2, 45.7, 52.2, 57.9, 61.4, 61.8, 58.8, 53.4, 47.1].each_with_index do |monthly_temp, i|
+      assert_in_delta(monthly_temp, weather.data.GroundMonthlyTemps[i], 0.1)
+    end
 
-    File.delete(File.join(File.dirname(__FILE__), 'in.xml'))
+    # Check design
+    assert_in_delta(10.2, weather.design.HeatingDrybulb, 0.1)
+    assert_in_delta(91.4, weather.design.CoolingDrybulb, 0.1)
+    assert_in_delta(58.0, weather.design.CoolingWetbulb, 0.1)
+    assert_in_delta(0.0046, weather.design.CoolingHumidityRatio, 0.0001)
+    assert_in_delta(31.9, weather.design.DailyTemperatureRange, 0.1)
 
-    return model, hpxml
+    # Check runner
+    assert_equal(0, runner.result.stepErrors.size)
+    assert_equal(1, runner.result.stepWarnings.select { |w| w == 'No design condition info found; calculating design conditions from EPW weather data.' }.size)
   end
 end

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

@@ -5,7 +5,7 @@
 [![Documentation Status](https://readthedocs.org/projects/openstudio-hpxml/badge/?version=latest)](https://openstudio-hpxml.readthedocs.io/en/latest/?badge=latest)
 
 OpenStudio-HPXML allows running residential EnergyPlus simulations using an [HPXML file](https://hpxml.nrel.gov/) for the building description.
-A Schematron document (`HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml`) for the EnergyPlus use case is used to validate that the appropriate HPXML inputs are provided to run EnergyPlus.
+It is intended to be used by user interfaces or other automated software workflows that automatically produce the HPXML file. A [Schematron](http://schematron.com/) document for the EnergyPlus use case is used to validate that the appropriate HPXML inputs are provided to run EnergyPlus.
 
 OpenStudio-HPXML can accommodate a wide range of different building technologies and geometries.
 End-to-end simulations typically run in 3-10 seconds, depending on complexity, computer platform and speed, etc.
@@ -14,7 +14,7 @@ For more information on running simulations, generating HPXML files, etc., pleas
 
 ## Workflows
 
-A simple [run_simulation.rb script](https://github.com/NREL/OpenStudio-HPXML/blob/master/workflow/run_simulation.rb) is provided to run a residential EnergyPlus simulation from an HPXML file.
+A simple `run_simulation.rb` script is provided to run a residential EnergyPlus simulation from an HPXML file.
 See the [Usage Instructions](https://openstudio-hpxml.readthedocs.io/en/latest/usage_instructions.html) for documentation on running the workflow.
 
 Since [OpenStudio measures](http://nrel.github.io/OpenStudio-user-documentation/getting_started/about_measures/) are used for model generation, additional OpenStudio-based workflows and interfaces can instead be used if desired.
@@ -31,11 +31,11 @@ This repository contains several OpenStudio measures:
 ## Projects
 
 The OpenStudio-HPXML workflow is used by a number of other residential projects, including:
+- [BEopt](https://beopt.nrel.gov)
 - [Energy Rating Index (ERI)](https://github.com/NREL/OpenStudio-ERI)
 - [Home Energy Score](https://betterbuildingssolutioncenter.energy.gov/home-energy-score)
 - [ResStock](https://resstock.nrel.gov/)
 - [URBANopt](https://www.nrel.gov/buildings/urbanopt.html)
-- [BEopt](https://beopt.nrel.gov) (pending)
 - [Weatherization Assistant](https://weatherization.ornl.gov/softwaredescription/) (pending)
 
 ## License