resstock

Helping states, municipalities, utilities, and manufacturers identify which building stock improvements save the most energy and money.
https://github.com/NREL/resstock

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

energy-data building-energy carbon-emissions demand-side-management energy-consumption energy-efficiency buildings energyplus openstudio openstudio-application

Last synced: about 8 hours ago
JSON representation

Repository metadata

Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.

Host: GitHub
URL: https://github.com/NREL/resstock
Owner: NREL
License: other
Created: 2016-04-11T15:37:56.000Z (about 9 years ago)
Default Branch: develop
Last Pushed: 2025-06-05T05:21:46.000Z (3 days ago)
Last Synced: 2025-06-06T07:07:15.847Z (1 day ago)
Language: Ruby
Homepage: https://resstock.nrel.gov
Size: 5.82 GB
Stars: 125
Watchers: 29
Forks: 78
Open Issues: 91
Releases: 18
Metadata Files:
- Readme: README.md
- License: LICENSE.md

README.md

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 changelogs 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.

Owner metadata

Name: National Renewable Energy Laboratory
Login: NREL
Email:
Kind: organization
Description:
Website: http://www.nrel.gov
Location: Golden, CO
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
Repositories: 599
Last ynced at: 2024-12-18T09:41:07.898Z
Profile URL: https://github.com/NREL

GitHub Events

Total

Fork event: 27
Create event: 95
Commit comment event: 1
Release event: 1
Issues event: 37
Watch event: 18
Delete event: 111
Member event: 2
Issue comment event: 96
Push event: 1176
Pull request review comment event: 147
Pull request review event: 182
Pull request event: 159

Last Year

Fork event: 27
Create event: 95
Commit comment event: 1
Release event: 1
Issues event: 37
Watch event: 18
Delete event: 111
Member event: 2
Issue comment event: 96
Push event: 1176
Pull request review comment event: 147
Pull request review event: 182
Pull request event: 159

Committers metadata

Last synced: 28 days ago

Total Commits: 8,663
Total Committers: 38
Avg Commits per committer: 227.974
Development Distribution Score (DDS): 0.48

Commits in past year: 1,268
Committers in past year: 12
Avg Commits per committer in past year: 105.667
Development Distribution Score (DDS) in past year: 0.613

Name	Email	Commits
Joe Robertson	j**n@n**v	4504
GitHub Action	g****n	1218
aspeake1	a**e@n**v	692
Anthony Fontanini	a**i@n**v	607
Scott Horowitz	s**z@n**v	546
Rajendra Adhikari	r**e@g**m	272
lixiliu	3****u	208
Eric Wilson	e**n@n**v	124
Maharshi Pathak	M**k@n**v	84
JLReyna	j**a@n**v	84
Yingli	y**2@n**v	51
jmaguire1	J**e@n**v	45
John Alley	j**y@m**u	34
Noel Merket	n**t@n**v	32
TobiAdekanye	o**a@a**u	22
jalley71	j**y@m**u	20
Andrew Speake	a**e@e**v	20
ehale	e**e@n**v	13
Present	e**t@n**v	13
Present	4****t	12
Nathan Moore	n**e@n**v	9
mdahlhausen	m**n@g**m	8
Matt Leach	m**h@n**v	8
Andrew Speake	a**e@e**v	6
Adhikari	r**r@n**v	6
Philip R. White	p**e@u**u	5
Andrew Speake	a**e@e**v	4
Julien Marrec	j**c@g**m	3
rHorsey	h**y@g**m	2
Yingli Lou	y**2@e**v	2
and 8 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 386
Total pull requests: 1,061
Average time to close issues: 8 months
Average time to close pull requests: about 1 month
Total issue authors: 42
Total pull request authors: 28
Average comments per issue: 2.16
Average comments per pull request: 1.01
Merged pull request: 811
Bot issues: 0
Bot pull requests: 0

Past year issues: 61
Past year pull requests: 137
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 20 days
Past year issue authors: 15
Past year pull request authors: 10
Past year average comments per issue: 1.28
Past year average comments per pull request: 1.01
Past year merged pull request: 99
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NREL/resstock

Top Issue Authors

joseph-robertson (143)
shorowit (61)
ejhw (34)
afontani (27)
ekpresent (22)
lixiliu (14)
aspeake (9)
jmaguire1 (8)
whiphi92 (7)
rajeee (7)
mcpigman (5)
sudeepy (4)
priyada7 (4)
nmerket (4)
jmarrec (3)

Top Pull Request Authors

joseph-robertson (630)
shorowit (113)
afontani (83)
rajeee (46)
aspeake (42)
lixiliu (29)
ejhw (26)
yingli-NREL (11)
JLReyna (11)
vtnate (10)
mpathak24 (9)
whiphi92 (8)
ekpresent (7)
TobiAdekanye (6)
jmaguire1 (6)

Top Issue Labels

enhancement (41)
bug (28)
priority low (23)
priority high (22)
priority medium (19)
input data (10)
help wanted (9)
waiting on others (9)
docs (5)
question (4)
priority highest (2)
GEB (2)
priority lowest (2)
feature (2)
load modeling (1)

Top Pull Request Labels

DO NOT MERGE (73)
bug (41)
OS-HPXML Backport (16)
enhancement (15)
docs (11)
feature (5)
waiting on others (4)
in progress (2)
priority low (2)
GEB (2)
priority high (2)
help wanted (1)
priority highest (1)
input data (1)
refactor (1)

Dependencies

.github/workflows/add_to_project.yml actions

actions/add-to-project v0.3.0 composite

.github/workflows/config.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/upload-artifact v3 composite

Gemfile rubygems

minitest ~> 5.9
minitest-reporters >= 0
msgpack >= 0
nokogiri ~> 1.10
oga >= 0
parallel >= 0
rake >= 0
rubyzip >= 0
simplecov >= 0
simplecov-html >= 0

Gemfile.lock rubygems

ansi 1.5.0
ast 2.4.2
builder 3.2.4
docile 1.4.0
minitest 5.14.4
minitest-reporters 1.4.3
msgpack 1.5.1
nokogiri 1.12.5
oga 3.3
parallel 1.21.0
racc 1.6.0
rake 13.0.6
ruby-ll 2.1.2
ruby-progressbar 1.11.0
rubyzip 2.3.2
simplecov 0.21.2
simplecov-html 0.12.3
simplecov_json_formatter 0.1.3

resources/hpxml-measures/Gemfile rubygems

minitest = 5.15
minitest-reporters >= 0
msgpack >= 0
oga >= 0
parallel >= 0
rake >= 0
rubyzip >= 0
simplecov >= 0
simplecov-html >= 0

resources/hpxml-measures/Gemfile.lock rubygems

ansi 1.5.0
ast 2.4.2
builder 3.2.4
docile 1.4.0
minitest 5.15.0
minitest-reporters 1.5.0
msgpack 1.5.2
oga 3.3
parallel 1.22.1
rake 13.0.6
ruby-ll 2.1.2
ruby-progressbar 1.11.0
rubyzip 2.3.2
simplecov 0.21.2
simplecov-html 0.12.3
simplecov_json_formatter 0.1.4

resources/hpxml-measures/docs/requirements.txt pypi

Sphinx *
sphinx-autobuild *
sphinx_paramlinks *
sphinx_rtd_theme >=1.1.0
sphinxcontrib-programoutput *

docs/technical_development_guide/requirements.txt pypi

Sphinx * development
changelog * development
sphinx-autobuild * development
sphinx_paramlinks * development
sphinx_rtd_theme >=1.1.0 development
sphinxcontrib-programoutput * development

postprocessing/setup.py pypi

buildstock_query *
fsspec *
geopandas *
pandas *
plotly *
polars *
pyarrow *
s3fs *

Score: 9.012864567410551

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology