ResStock 2025 Release 1

This release of ResStock includes the code used to produce the ResStock 2025 Release 1 dataset on OEDI.

What's Changed

• Ll/test breaker space by @yingli-NREL in #1317
• Add new pool heater technology (Electric Heat Pump) by @JLReyna in #1324
• Add misc appliances to panel load calc by @lixiliu in #1323
• Well pump distr using AHS by @lixiliu in #1325
• Add ResStock Technical Reference Guide by @afontani in #1338
• Add Standard Data Release YAML to GitHub Actions by @afontani in #1329
• Latest OS-HPXML by @joseph-robertson in #1328
• break space update by @yingli-NREL in #1340
• TDG: repository development, including subtree by @joseph-robertson in #1330
• Add Hawaii to TSVs by @JLReyna in #1339
• break space csv update by @yingli-NREL in #1344
• Update Technical Reference Guide to Final Publication by @afontani in #1343
• Reference housing characteristics directly by @rajeee in #1342
• New ResStockArgumentsPostHPXML measure by @joseph-robertson in #929
• Latest OS-HPXML by @joseph-robertson in #1346
• Add TRG on panels by @lixiliu in #1348
• Update TRG instructions by @afontani in #1349
• Latest OS-HPXML by @joseph-robertson in #1347
• Electric Vehicles by @aspeake in #1299
• Load flexibility feb6 run branch by @rajeee in #1357
• Load flexibility yingli by @yingli-NREL in #1331
• Latest OS-HPXML by @joseph-robertson in #1353
• Update Technical Reference Guide from 3.3.0 to develop by @afontani in #1361
• Stop existing actions when new commits are pushed by @rajeee in #1363
• Latest OS-HPXML by @joseph-robertson in #1359
• Electric panel by @joseph-robertson in #1319
• Electric panel workflow outputs docs by @joseph-robertson in #1366
• Add PV in Hawaii by @yingli-NREL in #1358
• Remove end-use emissions from SDR YAML outputs by @afontani in #1371
• Add HVAC Load Flexibility measure by @rajeee in #1259
• Differentiate Hawaii in IECC Climate Zone 1A by @JLReyna in #1374
• Pull in VMT tsv fix by @aspeake in #1378
• Solar Hot Water by @lixiliu in #1356
• Update HVAC Cooling Partial Space Conditioning for Hawaii by @JLReyna in #1377
• Refrigeration correction factors by @lixiliu in #1379
• Update TDG README.md by @afontani in #1381
• Update results by @afontani in #1383
• EE + Adoption meaure upgrades for EV SDR by @whiphi92 in #1362
• Add Electric Vehicle Demand Flexibility Upgrades by @rajeee in #1369
• Hawaii Cooling Saturation by @JLReyna in #1380
• Secondary heating type depends on primary heating type by @lixiliu in #1386
• Lighting technology based on RECS2020 by @yingli-NREL in #1376
• Update Hawaii PV Saturation to EIA861 2023 by @JLReyna in #1385
• Electric panel, follow-up by @joseph-robertson in #1370
• Use HPXML class in ResStockArgumentsPostHPXML measure, Take 2 by @Sashadf1 in #1389
• Add SDR options analysis and minimal buildstock.csv through CI by @rajeee in #1384
• Trigger CI by @rajeee in #1395
• Latest OS-HPXML by @joseph-robertson in #1368
• Two Speed and Variable Speed Geothermal Heat Pumps by @joseph-robertson in #1372
• Clean up ASHP and MSHP options by @joseph-robertson in #1402
• Latest OS-HPXML by @joseph-robertson in #1401
• Add check for extra lookup arguments by @shorowit in #1405
• Clean up duct options by @shorowit in #1396
• Add publication version of annual results through CI by @rajeee in #1398
• connect EV charger to panel open slots prediction by @lixiliu in #1410
• Add documentation for resource files by @rajeee in #1409
• Clean up SDR yml files, jobs, tests by @joseph-robertson in #1412
• Refactor meta measures by @joseph-robertson in #1415
• Simplify options in sdr_upgrades_tmy3.yml by @joseph-robertson in #1414
• Add 550K sample to artifact by @rajeee in #1417
• Fix 1414 by @joseph-robertson in #1421
• Update package apply logic for GHPs by @joseph-robertson in #1420
• Failure Impossible by @rajeee in #1423
• Switch to pyproject.toml for for resstockpostproc by @rajeee in #1424
• Clean up the SDR yaml file by @afontani in #1429
• Clean up the SDR yaml file, follow-up by @joseph-robertson in #1434
• Catch failures even if no step_failure or eplustout_err by @rajeee in #1435
• Use Autosizing Limits and Maintain Duct System Curve by @joseph-robertson in #1408
• Simplify options in sdr_upgrades_tmy3.yml, follow-up by @joseph-robertson in #1428
• Use HVAC Detailed Performance Option for a Ducted ASHP by @whiphi92 in #1413
• Fix for BA seasons always enabled by @joseph-robertson in #1441
• Fixed charges for unused fuels by @joseph-robertson in #1442
• Fix applicability column_type by @rajeee in #1439
• Fix ground-to-air condenser loop fluid type by @joseph-robertson in #1450
• Fix electricity column header spellings in sdr_rates/State.tsv by @joseph-robertson in #1454
• Update detailed report doc after the bugfix by @rajeee in #1422
• Fix possible non deterministic surface area in InternalMass object by @joseph-robertson in #1458
• Cambium 2024 emissions factors by @asparke2 in #1452
• CI enhancement for debugging / diff viewing by @rajeee in #1449
• Fail CI on publication column mismatch by @rajeee in #1464
• Fixes many typos by @shorowit in #1465
• Update with new sdr rates by @jbrossman in #1459
• Add panel metrics to SDR workflow by @lixiliu in #1453
• Gracefully handle failures in upgrades by @rajeee in #1467
• Bugfixes by @shorowit in #1463
• Fix GHP options by @shorowit in #1471
• Add data dict test by @rajeee in #1472
• Improve ApplyUpgrade unit tests for heat pumps by @joseph-robertson in #1477
• Properly assign representative income by @rajeee in #1478
• update process_bsb_results by @lixiliu in #1480
• ResStock 2025 Release 1 Combined Measures by @asparke2 in #1474
• SDR HVAC upgrades by @joseph-robertson in #1436
• Sdr2025 furnaces by @katelynstenger in #1445
• SDR All Envelope Measures by @yingli-NREL in #1455

New Contributors

• @Sashadf1 made their first contribution in #1389
• @jbrossman made their first contribution in #1459
• @katelynstenger made their first contribution in #1445

Full Changelog: v3.4.0...2025_Release_1

ResStock v3.4.0

ResStock version 3.4.0 has been released.
Read the documentation for tutorials and workflow inputs/outputs.
See the changelog for new features and bugfixes in this release.

Software Stack:

OpenStudio v3.9.0
EnergyPlus v24.2
OpenStudio-HPXML v1.9.0
buildstockbatch v2024.11.0 (workflow generator v2024.07.20)

What's Changed

• Latest OS-HPXML by @joseph-robertson in #1268
• Break out Mobile Home in CI comparison plots by @joseph-robertson in #1286
• ResStockArguments: fix pv/battery present bool args by @joseph-robertson in #1292
• ApplyUpgrade: register ResStockArguments runner results to main runner by @joseph-robertson in #1294
• Air leakage type "unit total" by @joseph-robertson in #1257
• Fix README has a link to a non-existent changelog by @joseph-robertson in #1297
• Latest OS-HPXML by @joseph-robertson in #1282
• Fix RECS floor area bins by @afontani in #1301
• Update Hot Water Fixtures tsv by @lixiliu in #1265
• Latest OS-HPXML by @joseph-robertson in #1298
• Heating and Cooling Unavailable Days by @joseph-robertson in #1254
• Update PR template by @afontani in #1310
• Pin ubuntu runner version in CI for stability by @rajeee in #1311
• Heating and Cooling Unavailable Days, follow-up by @joseph-robertson in #1315
• Latest OS-HPXML by @joseph-robertson in #1308
• Assign above-grade height for apartment units by @joseph-robertson in #1304
• Latest OS-HPXML by @joseph-robertson in #1318
• Prep v3.4.0 release by @joseph-robertson in #1326
• v3.4.0 release by @joseph-robertson in #1327

Full Changelog: v3.3.0...v3.4.0

ResStock v3.3.0

ResStock version 3.3.0 has been released.
Read the documentation for tutorials and workflow inputs/outputs.
See the changelog for new features and bugfixes in this release.

Software Stack:

OpenStudio v3.8.0
EnergyPlus v24.1
OpenStudio-HPXML v1.8.1
buildstockbatch v2023.10.0 (workflow generator v2024.07.20)

What's Changed

• Latest OS-HPXML by @joseph-robertson in #1187
• Remove old HPWH options from options_lookup by @afontani in #1190
• Latest OS-HPXML by @joseph-robertson in #1188
• 2022 Cambium: add 25 year levelization scenarios by @joseph-robertson in #1194
• Reorganize emissions and utility bills data folders by @joseph-robertson in #1195
• Update CI config with OS env vars by @joseph-robertson in #1196
• Update characteristics using 2020 RECS v7 data by @afontani in #1199
• Latest OS-HPXML by @joseph-robertson in #1200
• Latest OS-HPXML by @joseph-robertson in #1203
• Remove old HPWHs part 2 by @jmaguire1 in #1205
• Updating hot water fixtures multipliers based on field data. by @afontani in #1210
• Latest OS-HPXML by @joseph-robertson in #1209
• Update water heater location by @lixiliu in #1201
• Add SMI, MSA, Metro Status by @lixiliu in #1212
• Latest OS-HPXML by @joseph-robertson in #1215
• HVAC Autosizing Factors by @joseph-robertson in #1217
• Integrate ARIS data by @rajeee in #1214
• Latest OS-HPXML by @joseph-robertson in #1220
• Add all software versions to run_analysis.rb by @joseph-robertson in #1227
• HVAC Autosizing Factors by @joseph-robertson in #1218
• Latest OS-HPXML by @joseph-robertson in #1229
• Latest OS-HPXML by @joseph-robertson in #1231
• Updates duct effective R-values; allows duct shape inputs by @joseph-robertson in #1234
• Latest OS-HPXML by @joseph-robertson in #1233
• OpenStudio 3.8/EnergyPlus 24.1 by @joseph-robertson in #1225
• Changelog fixes by @joseph-robertson in #1241
• Run run_analysis in parallel by @joseph-robertson in #1230
• Latest OS-HPXML by @joseph-robertson in #1240
• Latest OS-HPXML by @joseph-robertson in #1245
• Split out Other and TV plug loads by @joseph-robertson in #1213
• Updates default temperature capacitance multiplier to 7 by @joseph-robertson in #1247
• Adding options and option arguments to Read the Docs by @afontani in #1249
• Ensure consistent spelling between TSVs and options_lookup.tsv by @joseph-robertson in #1256
• RTD: detailed changelog by @joseph-robertson in #1244
• Remove references to older versions of the ResStock workflow by @afontani in #1252
• Reduce garage protrusion slightly for 0-499 Geometry Floor Area by @joseph-robertson in #1258
• Add changlog package to requirements.txt by @afontani in #1262
• Update threshold for when people are considered have weekday occupancy by @rajeee in #1260
• Map mobile homes to HPXML's "manufactured home" by @shorowit in #1270
• Speed up TSVFile class by @shorowit in #1272
• ResStockArguments: convert args to double, integer by @joseph-robertson in #1269
• Convert UpgradeCosts measure to ModelMeasure by @joseph-robertson in #1253
• Latest OS-HPXML, v1.8.1 by @joseph-robertson in #1246
• Specify upgrade_names for run_analysis.rb by @joseph-robertson in #1275
• ServerDirectoryCleanup: catch *schedules.csv, refactor by @joseph-robertson in #1277
• Prep v3.3.0 release by @joseph-robertson in #1279
• v3.3.0 release by @joseph-robertson in #1280

Full Changelog: v3.2.0...v3.3.0

ResStock v3.2.0

ResStock version 3.2.0 has been released.

See the changelog for new features and fixes.

Read the documentation.

ResStock v3.2.0 uses:

• OpenStudio v3.7.0
• EnergyPlus v23.2
• buildstockbatch v2023.10.0
• OpenStudio-HPXML v1.7.0

Full Changelog: v3.1.1...v3.2.0

ResStock v3.1.1

ResStock version 3.1.1 has been released.

See the changelog for new features and fixes.

Read the documentation.

ResStock v3.1.1 uses:

• OpenStudio v3.6.1
• EnergyPlus v23.1
• buildstockbatch v2023.05.0
• OpenStudio-HPXML v1.6.0

Full Changelog: v3.1.0...v3.1.1

ResStock v3.1.0

ResStock version 3.1.0 has been released.

See the changelog for new features and fixes.

Read the documentation.

ResStock v3.1.0 uses:

• OpenStudio v3.6.1
• EnergyPlus v23.1
• buildstockbatch v2023.05.0
• OpenStudio-HPXML v1.6.0

Full Changelog: v3.0.0...v3.1.0

ResStock v3.0.0

ResStock version 3.0.0 has been released. This version includes the transition to the OpenStudio-HPXML workflow.

See the changelog for new features and fixes.

Read the documentation.

ResStock v3.0.0 uses:

• OpenStudio v3.5.1
• EnergyPlus v22.2
• buildstockbatch v2023.01.0
• OpenStudio-HPXML v1.5.1 (fe7b5c637ab)

Full Changelog: v2.5.0...v3.0.0

ResStock v2.5.0

ResStock version 2.5.0 has been released. This version includes all changes made under the End-Use Load Profiles calibration/validation effort, as well as a few additional changes to prepare for transition to the OpenStudio-HPXML workflow (to be included in v3.0.0). The exact state of the repo aligned with the publicly released End-Use Load Profiles dataset is tagged as eulp_final.

See the changelog for new features and fixes.

Read the documentation.

ResStock v2.5.0 uses OpenStudio v3.3.0, EnergyPlus v9.6, and buildstockbatch v0.21.

ResStock v2.4.0

ResStock version 2.4.0 has been released.

See the changelog for new features and fixes.

Read the documentation.

ResStock v2.4.0 uses OpenStudio v2.9.0, EnergyPlus v9.2, and buildstockbatch v0.18.

ResStock v2.3.0

ResStock version 2.3.0 has been released.

See the changelog for new features and fixes.

Read the documentation.

ResStock v2.3.0 uses OpenStudio v2.9.0, EnergyPlus v9.2, and buildstockbatch v0.18.