Abstract
The ResStock™ analysis tool was built on NREL's OpenStudio® platform, and is a project geared at modeling existing residential building stocks at national, regional, or local scales with a high-degree of granularity (e.g., one physics-based simulation model for every 200 dwelling units), using the EnergyPlus® simulation engine. Information about ComStock™, a sister tool for modeling the commercial building stock, can be found here: https://www.nrel.gov/buildings/comstock.html
This repository contains:
Housing characteristics of the U.S. residential building stock, in the form of conditional probability distributions stored as tab-separated value (.tsv) files. Comments at the bottom of each file document data sources and assumptions for each.
A library of housing characteristic "options" that translate high-level characteristic parameters into arguments for OpenStudio measures, and which are referenced by the housing characteristic .tsv files and building energy upgrades defined in project definition files
Project definition files:
v2.3.0 and later: buildstockbatch YML files openable in any text editor
v2.2.5 and prior: Project folder openable in PAT
Unit-level OpenStudio Measures for automatically constructing OpenStudio Models of each representative dwelling unit model:
v3.0.0 and later: OpenStudio-HPXML Measures
v2.5.0 and prior: OpenStudio Measures
Higher-level OpenStudio Measures for controlling simulation inputs and outputs
This repository does not contain software for running ResStock simulations, which can be found as follows:
Versions 2.3.0 and later
More>>
- Developers:
-
Horowitz, Scott [1] ; Pathak, Maharshi [1] ; Wilson, Eric [1] ; Merket, Noel [2] ; Christensen, Craig [1] ; Fontanini, Anthony [3] ; Horsey, Henry [1] ; Robertson, Joseph [1] ; Rager, David [1] ; Alley, John [1] ; Maguire, Jeffrey [1] ; Harris, Chioke [1] ; Speake, Andrew [3] ; Liu, Lixi [3] ; Adhikari, Rajendra [3] ; Adekanye, Tobi [3] ; Hale, Elaine [3] ; Present, Elaina [3] ; Moore, Nathan [3] ; Leach, Matt [3] ; Dahlhausen, Matthew [3] ; White, Philip [3] ; Parker, Andrew [3] ; Chen, Jianli [3]
- National Renewable Energy Lab. (NREL), Golden, CO (United States)
- National Renewable Energy Laboratory
- National Renewable Energy Laboratory (NREL), Golden, CO (United States)
- Release Date:
- 2023-12-19
- Project Type:
- Open Source, Publicly Available Repository
- Software Type:
- Scientific
- Programming Languages:
-
Python
Ruby
- Version:
- v3.2.0
- Licenses:
-
Other (Commercial or Open-Source): https://github.com/NREL/resstock/blob/develop/LICENSE.md
- Sponsoring Org.:
-
USDOE Office of Energy Efficiency and Renewable Energy (EERE), Building Technologies Office (EE-5B)Primary Award/Contract Number:AC36-08GO28308
- Code ID:
- 126474
- Site Accession Number:
- NREL SWR-19-15, SWR-20-07
- Research Org.:
- National Renewable Energy Laboratory (NREL), Golden, CO (United States)
- Country of Origin:
- United States
Citation Formats
Horowitz, Scott, Pathak, Maharshi, Wilson, Eric, Merket, Noel, Christensen, Craig, Fontanini, Anthony, Horsey, Henry, Robertson, Joseph, Rager, David, Alley, John, Maguire, Jeffrey, Harris, Chioke, Speake, Andrew, Liu, Lixi, Adhikari, Rajendra, Adekanye, Tobi, Hale, Elaine, Present, Elaina, Moore, Nathan, Leach, Matt, Dahlhausen, Matthew, White, Philip, Parker, Andrew, and Chen, Jianli.
ResStock™ v3.2.0 [SWR-19-15 and SWR-20-07].
Computer Software.
https://github.com/NREL/resstock.
USDOE Office of Energy Efficiency and Renewable Energy (EERE), Building Technologies Office (EE-5B).
19 Dec. 2023.
Web.
doi:10.11578/dc.20240426.3.
Horowitz, Scott, Pathak, Maharshi, Wilson, Eric, Merket, Noel, Christensen, Craig, Fontanini, Anthony, Horsey, Henry, Robertson, Joseph, Rager, David, Alley, John, Maguire, Jeffrey, Harris, Chioke, Speake, Andrew, Liu, Lixi, Adhikari, Rajendra, Adekanye, Tobi, Hale, Elaine, Present, Elaina, Moore, Nathan, Leach, Matt, Dahlhausen, Matthew, White, Philip, Parker, Andrew, & Chen, Jianli.
(2023, December 19).
ResStock™ v3.2.0 [SWR-19-15 and SWR-20-07].
[Computer software].
https://github.com/NREL/resstock.
https://doi.org/10.11578/dc.20240426.3.
Horowitz, Scott, Pathak, Maharshi, Wilson, Eric, Merket, Noel, Christensen, Craig, Fontanini, Anthony, Horsey, Henry, Robertson, Joseph, Rager, David, Alley, John, Maguire, Jeffrey, Harris, Chioke, Speake, Andrew, Liu, Lixi, Adhikari, Rajendra, Adekanye, Tobi, Hale, Elaine, Present, Elaina, Moore, Nathan, Leach, Matt, Dahlhausen, Matthew, White, Philip, Parker, Andrew, and Chen, Jianli.
"ResStock™ v3.2.0 [SWR-19-15 and SWR-20-07]." Computer software.
December 19, 2023.
https://github.com/NREL/resstock.
https://doi.org/10.11578/dc.20240426.3.
@misc{
doecode_126474,
title = {ResStock™ v3.2.0 [SWR-19-15 and SWR-20-07]},
author = {Horowitz, Scott and Pathak, Maharshi and Wilson, Eric and Merket, Noel and Christensen, Craig and Fontanini, Anthony and Horsey, Henry and Robertson, Joseph and Rager, David and Alley, John and Maguire, Jeffrey and Harris, Chioke and Speake, Andrew and Liu, Lixi and Adhikari, Rajendra and Adekanye, Tobi and Hale, Elaine and Present, Elaina and Moore, Nathan and Leach, Matt and Dahlhausen, Matthew and White, Philip and Parker, Andrew and Chen, Jianli},
abstractNote = {The ResStock™ analysis tool was built on NREL's OpenStudio® platform, and is a project geared at modeling existing residential building stocks at national, regional, or local scales with a high-degree of granularity (e.g., one physics-based simulation model for every 200 dwelling units), using the EnergyPlus® simulation engine. Information about ComStock™, a sister tool for modeling the commercial building stock, can be found here: https://www.nrel.gov/buildings/comstock.html
This repository contains:
Housing characteristics of the U.S. residential building stock, in the form of conditional probability distributions stored as tab-separated value (.tsv) files. Comments at the bottom of each file document data sources and assumptions for each.
A library of housing characteristic "options" that translate high-level characteristic parameters into arguments for OpenStudio measures, and which are referenced by the housing characteristic .tsv files and building energy upgrades defined in project definition files
Project definition files:
v2.3.0 and later: buildstockbatch YML files openable in any text editor
v2.2.5 and prior: Project folder openable in PAT
Unit-level OpenStudio Measures for automatically constructing OpenStudio Models of each representative dwelling unit model:
v3.0.0 and later: OpenStudio-HPXML Measures
v2.5.0 and prior: OpenStudio Measures
Higher-level OpenStudio Measures for controlling simulation inputs and outputs
This repository does not contain software for running ResStock simulations, which can be found as follows:
Versions 2.3.0 and later only support the use of buildstockbatch for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removed separate projects for single-family detached and multifamily buildings, in lieu of a combined project_national representing the U.S. residential building stock. See the changelog for more details.
Versions 2.2.5 and prior support the use of the publicly available OpenStudio-PAT software as an interface for deploying simulations on cloud computing. Read the documentation for v2.2.5.},
doi = {10.11578/dc.20240426.3},
url = {https://doi.org/10.11578/dc.20240426.3},
howpublished = {[Computer Software] \url{https://doi.org/10.11578/dc.20240426.3}},
year = {2023},
month = {dec}
}