The develop branch is under active development. Find the latest release here.

ResStock™, built on the OpenStudio platform, 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.

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 buildstockbatch YML files openable in any text editor for v2.3.0 and later
• Unit-level OpenStudio-HPXML Measures (v3.0.0 and later) for automatically constructing individual representative dwelling unit OpenStudio Models using OpenStudio-HPXML
• Higher-level OpenStudio Measures for controlling simulation inputs and outputs

Software for running ResStock simulations:

• 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.
• For large-scale production runs of ResStock, it is recommended that buildstockbatch is used. For smaller-scale tests, run_analysis.rb can be used. Information about the workflow can be found in ResStock's documentation.