ComStock
National scale modeling of the U.S. commercial building stock supported by U.S. DOE, LADWP, and others and maintained by NREL.
https://github.com/nrel/comstock
Category: Consumption
Sub Category: Buildings and Heating
Last synced: about 10 hours ago
JSON representation
Repository metadata
National scale modeling of the U.S. commercial building stock supported by U.S. DOE, LADWP, and others and maintained by NREL
- Host: GitHub
- URL: https://github.com/nrel/comstock
- Owner: NREL
- License: other
- Created: 2020-10-18T06:40:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T20:17:06.000Z (11 days ago)
- Last Synced: 2025-04-17T07:18:03.488Z (11 days ago)
- Language: Ruby
- Size: 384 MB
- Stars: 38
- Watchers: 15
- Forks: 26
- Open Issues: 62
- Releases: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
README.md
ComStock
ComStock is an NREL model of the U.S. commercial building stock. The model takes some building characteristics from the
U.S. Department of Energy's (DOE's) Commercial Prototype Building Models and Commercial Reference Building. However,
unlike many other building stock models, ComStock also combines these with a variety of additional public- and
private-sector data sets. Collectively, this information provides high-fidelity building stock representation with a
realistic diversity of building characteristics.
This repository contains the source code used to build and execute ComStock models, including upgrade scenarios. In
addition, the sampling of buildings characteristics used for the initial ComStock (V1.0) release is provided. The ComStock model is under active calibration and development, which is publicly visible on this repository.
Execution of the ComStock workflow is managed through the buildstockbatch repository, a shared asset of ResStock and ComStock,
specifically developed to scale to execution of tens of millions of simulations through multiple infrastructure
providers.
The dataset output from the initial ComStock (V1.0) release can be found at the accompanying
ComStock data viewer website and additional information about ComStock found on the
NREL Buildings Website. For more details about ongoing model development
please consult the End Use Load Profiles website.
ComStock is a direct result of the NREL residential stock modeling tool
ResStock (recipient of a
R&D100 award)
and was inspired by the high-fidelity solar & storage adoption model dGen.
Additionally, this tool would not be possible without the decades of work undertaken by the
OpenStudio and EnergyPlus visionaries and contributors,
significant funding, feedback and support from the Los Angeles Department of Water and Power,
and the Department of Energy's Building Technology Office
ongoing support of and investment in building energy modeling software.
Directories
/buildcontains instructions for building Singularity images for running ComStock on HPC systems./documentationcontains LaTeX documentation and instructions for building the documentation./measurescontains the high-level "meta" measures used to call other measures, and the reporting measures used to summarize outputs./nationalcontains seed directories necessary for a ComStock run using buildstockbatch./postprocessingcontains postprocessing scripts to create graphics for viewing results and comparing to other data sources./resourcescontains workflow and upgrade measures/samplescontains sample buildstock.csv files, which describe the set of models included in a run./samplingcontains instructions and code to generate buildstock.csv files./ymlscontains sample .yml files, which are the configuration files used to execture a ComStock run with buildstockbatch.
Usage
ComStock is under an open source license. See LICENSE.txt in this directory.
You are welcome to use this repository for your own use. However, we do not provide technical support. Please refer to our technical assistance documentation instead. We strongly suggest and support using the public datasets instead of attempting to run millions of building energy models yourself.
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: 17
- Create event: 99
- Commit comment event: 1
- Release event: 1
- Issues event: 42
- Watch event: 10
- Delete event: 69
- Member event: 3
- Issue comment event: 67
- Push event: 673
- Pull request review comment event: 117
- Pull request review event: 175
- Pull request event: 149
Last Year
- Fork event: 17
- Create event: 99
- Commit comment event: 1
- Release event: 1
- Issues event: 42
- Watch event: 10
- Delete event: 69
- Member event: 3
- Issue comment event: 67
- Push event: 673
- Pull request review comment event: 117
- Pull request review event: 175
- Pull request event: 149
Committers metadata
Last synced: 7 days ago
Total Commits: 863
Total Committers: 17
Avg Commits per committer: 50.765
Development Distribution Score (DDS): 0.841
Commits in past year: 501
Committers in past year: 15
Avg Commits per committer in past year: 33.4
Development Distribution Score (DDS) in past year: 0.752
| Name | Commits | |
|---|---|---|
| Matthew Dahlhausen | m****n@g****m | 137 |
| JanghyunJK | j****m@n****v | 104 |
| Xiong | j****g@n****v | 99 |
| Praprost | m****s@n****v | 97 |
| Andrew Parker | a****2@g****m | 88 |
| Eric Ringold | e****d@g****m | 75 |
| Wenyi Kuang | w****g@n****v | 68 |
| Ry Horsey | h****y@g****m | 50 |
| Landan Taylor | l****r@n****v | 48 |
| Chris CaraDonna | 5****a | 30 |
| CaraDonna | c****n@n****v | 27 |
| David Goldwasser | d****r@n****v | 13 |
| Amy Van Sant | 4****r | 12 |
| Allen | a****n@n****v | 7 |
| carlobianchi89 | c****i@u****u | 4 |
| Lauren Klun | 6****n | 2 |
| Marley Praprost | 4****t | 2 |
Committer domains:
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 133
Total pull requests: 265
Average time to close issues: 7 months
Average time to close pull requests: 20 days
Total issue authors: 18
Total pull request authors: 14
Average comments per issue: 0.6
Average comments per pull request: 0.56
Merged pull request: 199
Bot issues: 0
Bot pull requests: 0
Past year issues: 39
Past year pull requests: 147
Past year average time to close issues: 3 months
Past year average time to close pull requests: 23 days
Past year issue authors: 13
Past year pull request authors: 14
Past year average comments per issue: 0.67
Past year average comments per pull request: 0.48
Past year merged pull request: 103
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- mdahlhausen (37)
- asparke2 (34)
- eringold (21)
- wenyikuang (8)
- mpraprost (7)
- mcpigman (4)
- amylebar (3)
- ChristopherCaradonna (3)
- JieXiong9119 (3)
- laurenklun (2)
- natbprice (2)
- DavidGoldwasser (2)
- JanghyunJK (2)
- invisibleroads (1)
- jmarrec (1)
Top Pull Request Authors
- JanghyunJK (46)
- mpraprost (43)
- ChristopherCaradonna (33)
- mdahlhausen (29)
- wenyikuang (23)
- eringold (22)
- asparke2 (15)
- LandanT (13)
- JieXiong9119 (13)
- rHorsey (11)
- amylebar (7)
- amyeallen1 (6)
- laurenklun (3)
- ekpresent (1)
Top Issue Labels
- bug (25)
- postprocessing (21)
- enhancement (18)
- workflow measure (18)
- reporting measure (15)
- documentation (5)
- infrastructure (4)
- upgrade measure (3)
- sampling (3)
- wontfix (2)
Top Pull Request Labels
- Pull Request - Ready for CI (54)
- upgrade measure (52)
- postprocessing (42)
- reporting measure (28)
- workflow measure (26)
- infrastructure (24)
- documentation (21)
- bug (10)
- Do Not Merge (10)
- sampling (8)
- enhancement (5)
Dependencies
- boto3 *
- requests *
Score: 7.438383530044308