Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

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 15 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

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

  • /build contains instructions for building Singularity images for running ComStock on HPC systems.
  • /documentation contains LaTeX documentation and instructions for building the documentation.
  • /measures contains the high-level "meta" measures used to call other measures, and the reporting measures used to summarize outputs.
  • /national contains seed directories necessary for a ComStock run using buildstockbatch.
  • /postprocessing contains postprocessing scripts to create graphics for viewing results and comparing to other data sources.
  • /resources contains workflow and upgrade measures
  • /samples contains sample buildstock.csv files, which describe the set of models included in a run.
  • /sampling contains instructions and code to generate buildstock.csv files.
  • /ymls contains 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

GitHub Events

Total
Last Year

Committers metadata

Last synced: 11 days ago

Total Commits: 884
Total Committers: 17
Avg Commits per committer: 52.0
Development Distribution Score (DDS): 0.845

Commits in past year: 479
Committers in past year: 13
Avg Commits per committer in past year: 36.846
Development Distribution Score (DDS) in past year: 0.76

Name Email 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 90
Wenyi Kuang w****g@n****v 85
Eric Ringold e****d@g****m 75
Ry Horsey h****y@g****m 50
Landan Taylor l****r@n****v 50
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: 142
Total pull requests: 284
Average time to close issues: 8 months
Average time to close pull requests: 19 days
Total issue authors: 18
Total pull request authors: 14
Average comments per issue: 0.61
Average comments per pull request: 0.55
Merged pull request: 213
Bot issues: 0
Bot pull requests: 0

Past year issues: 43
Past year pull requests: 145
Past year average time to close issues: 3 months
Past year average time to close pull requests: 20 days
Past year issue authors: 11
Past year pull request authors: 13
Past year average comments per issue: 0.63
Past year average comments per pull request: 0.52
Past year merged pull request: 100
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • mdahlhausen (42)
  • asparke2 (34)
  • eringold (21)
  • mpraprost (9)
  • wenyikuang (8)
  • ChristopherCaradonna (5)
  • mcpigman (4)
  • amylebar (3)
  • JieXiong9119 (3)
  • laurenklun (2)
  • natbprice (2)
  • DavidGoldwasser (2)
  • JanghyunJK (2)
  • invisibleroads (1)
  • jmarrec (1)

Top Pull Request Authors

  • JanghyunJK (49)
  • mpraprost (43)
  • ChristopherCaradonna (39)
  • mdahlhausen (29)
  • wenyikuang (23)
  • eringold (22)
  • LandanT (16)
  • asparke2 (16)
  • JieXiong9119 (14)
  • amyeallen1 (11)
  • rHorsey (11)
  • amylebar (7)
  • laurenklun (3)
  • ekpresent (1)

Top Issue Labels

  • bug (28)
  • enhancement (26)
  • postprocessing (23)
  • workflow measure (18)
  • reporting measure (16)
  • documentation (5)
  • wontfix (4)
  • infrastructure (4)
  • upgrade measure (3)
  • sampling (3)

Top Pull Request Labels

  • upgrade measure (55)
  • Pull Request - Ready for CI (54)
  • postprocessing (42)
  • reporting measure (28)
  • workflow measure (27)
  • infrastructure (24)
  • documentation (23)
  • bug (14)
  • Do Not Merge (11)
  • sampling (8)
  • enhancement (5)

Package metadata

proxy.golang.org: github.com/NREL/ComStock

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/NREL/ComStock#section-documentation
  • Licenses: other
  • Latest release: v1.0.0 (published over 4 years ago)
  • Last Synced: 2025-06-05T11:15:19.174Z (3 days ago)
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
proxy.golang.org: github.com/nrel/comstock

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/nrel/comstock#section-documentation
  • Licenses: other
  • Latest release: v1.0.0 (published over 4 years ago)
  • Last Synced: 2025-06-05T11:15:20.322Z (3 days ago)
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%

Dependencies

build/singularity/requirements.txt pypi
  • boto3 *
  • requests *

Score: -Infinity