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 11 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-20T14:33:12.000Z (9 days ago)
- Last Synced: 2025-06-20T15:37:28.395Z (9 days ago)
- Language: Ruby
- Homepage: https://resstock.nrel.gov
- Size: 5.82 GB
- Stars: 127
- 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_nationalrepresenting 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.rbcan 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: 102
- Commit comment event: 1
- Release event: 1
- Issues event: 38
- Watch event: 18
- Delete event: 115
- Member event: 3
- Issue comment event: 99
- Push event: 1240
- Pull request review comment event: 171
- Pull request review event: 191
- Pull request event: 170
Last Year
- Fork event: 27
- Create event: 102
- Commit comment event: 1
- Release event: 1
- Issues event: 38
- Watch event: 18
- Delete event: 115
- Member event: 3
- Issue comment event: 99
- Push event: 1240
- Pull request review comment event: 171
- Pull request review event: 191
- Pull request event: 170
Committers metadata
Last synced: about 2 months 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 | 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:
- nrel.gov: 17
- el1.ib0.cm.hpc.nrel.gov: 2
- mheaney-27690s.nrel.gov: 1
- ewilson-32949s.nrel.gov: 1
- login3.hpc.nrel.gov: 1
- login2.hpc.nrel.gov: 1
- kl3.head.cm.kestrel.hpc.nrel.gov: 1
- el3.ib0.cm.hpc.nrel.gov: 1
- utexas.edu: 1
- el2.ib0.cm.hpc.nrel.gov: 1
- mines.edu: 1
- andrew.cmu.edu: 1
- mymail.mines.edu: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 387
Total pull requests: 1,070
Average time to close issues: 8 months
Average time to close pull requests: about 1 month
Total issue authors: 42
Total pull request authors: 29
Average comments per issue: 2.17
Average comments per pull request: 1.0
Merged pull request: 817
Bot issues: 0
Bot pull requests: 0
Past year issues: 57
Past year pull requests: 134
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 17 days
Past year issue authors: 15
Past year pull request authors: 11
Past year average comments per issue: 1.35
Past year average comments per pull request: 0.69
Past year merged pull request: 96
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- joseph-robertson (143)
- shorowit (61)
- ejhw (34)
- afontani (27)
- ekpresent (22)
- lixiliu (14)
- jmaguire1 (9)
- aspeake (9)
- rajeee (7)
- whiphi92 (7)
- mcpigman (5)
- sudeepy (4)
- nmerket (4)
- priyada7 (4)
- jbrossman (3)
Top Pull Request Authors
- joseph-robertson (632)
- shorowit (113)
- afontani (84)
- rajeee (48)
- aspeake (42)
- lixiliu (29)
- ejhw (26)
- yingli-NREL (14)
- JLReyna (11)
- vtnate (10)
- mpathak24 (9)
- whiphi92 (8)
- ekpresent (7)
- jmaguire1 (6)
- TobiAdekanye (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 (76)
- 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
- actions/add-to-project v0.3.0 composite
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/upload-artifact v3 composite
- minitest ~> 5.9
- minitest-reporters >= 0
- msgpack >= 0
- nokogiri ~> 1.10
- oga >= 0
- parallel >= 0
- rake >= 0
- rubyzip >= 0
- simplecov >= 0
- simplecov-html >= 0
- 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
- minitest = 5.15
- minitest-reporters >= 0
- msgpack >= 0
- oga >= 0
- parallel >= 0
- rake >= 0
- rubyzip >= 0
- simplecov >= 0
- simplecov-html >= 0
- 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
- Sphinx *
- sphinx-autobuild *
- sphinx_paramlinks *
- sphinx_rtd_theme >=1.1.0
- sphinxcontrib-programoutput *
- Sphinx * development
- changelog * development
- sphinx-autobuild * development
- sphinx_paramlinks * development
- sphinx_rtd_theme >=1.1.0 development
- sphinxcontrib-programoutput * development
- buildstock_query @ git+https://github.com/NREL/buildstock-query@main
- fsspec *
- geopandas *
- kaleido ==0.2.1
- pandas *
- plotly *
- polars *
- pyarrow *
- s3fs *
- aiobotocore 2.22.0
- aiohappyeyeballs 2.6.1
- aiohttp 3.12.4
- aioitertools 0.12.0
- aiosignal 1.3.2
- appnope 0.1.4
- asttokens 3.0.0
- attrs 25.3.0
- autopep8 2.3.2
- black 25.1.0
- boto3 1.37.3
- botocore 1.37.3
- buildstock-query 2024.5.9
- certifi 2025.1.31
- cffi 1.17.1
- charset-normalizer 3.4.2
- click 8.2.1
- colorama 0.4.6
- comm 0.2.2
- debugpy 1.8.14
- decorator 5.2.1
- executing 2.2.0
- frozenlist 1.6.0
- fsspec 2025.5.1
- geopandas 1.0.1
- greenlet 3.2.2
- idna 3.10
- iniconfig 2.1.0
- inquirerpy 0.3.4
- ipykernel 6.29.5
- ipython 9.2.0
- ipython-pygments-lexers 1.1.1
- jedi 0.19.2
- jmespath 1.0.1
- jupyter-client 8.6.3
- jupyter-core 5.7.2
- kaleido 0.2.1
- matplotlib-inline 0.1.7
- multidict 6.4.4
- mypy-extensions 1.1.0
- narwhals 1.41.0
- nest-asyncio 1.6.0
- numpy 2.2.4
- packaging 24.2
- pandas 2.2.3
- pandas-stubs 2.2.3.250527
- parso 0.8.4
- pathspec 0.12.1
- pexpect 4.9.0
- pfzy 0.3.4
- platformdirs 4.3.7
- plotly 6.1.2
- pluggy 1.6.0
- polars 1.27.1
- prompt-toolkit 3.0.51
- propcache 0.3.1
- psutil 7.0.0
- ptyprocess 0.7.0
- pure-eval 0.2.3
- pyarrow 20.0.0
- pyathena 3.0.6
- pycodestyle 2.13.0
- pycparser 2.22
- pydantic 1.10.22
- pygments 2.19.1
- pyogrio 0.10.0
- pyproj 3.7.1
- pytest 8.3.5
- python-dateutil 2.9.0.post0
- pytz 2025.2
- pywin32 310
- pyyaml 6.0.2
- pyzmq 26.4.0
- requests 2.32.3
- resstockpostproc 0.1.0
- s3fs 2025.5.1
- s3transfer 0.11.3
- shapely 2.1.0
- six 1.17.0
- sqlalchemy 1.4.46
- sqlalchemy2-stubs 0.0.2a38
- stack-data 0.6.3
- tabulate 0.9.0
- tenacity 9.1.2
- toml 0.10.2
- tornado 6.4.2
- traitlets 5.14.3
- types-pytz 2025.2.0.20250516
- types-pyyaml 6.0.12.20250516
- typing-extensions 4.13.2
- tzdata 2025.2
- urllib3 2.4.0
- wcwidth 0.2.13
- wrapt 1.17.2
- yarl 1.20.0
Score: 9.022081222515475