Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 24 committers (4.2%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

National scale modeling of the U.S. commercial building stock supported by U.S. DOE, LADWP, and others and maintained by NREL

Basic Info
  • Host: GitHub
  • Owner: NREL
  • License: other
  • Language: Ruby
  • Default Branch: main
  • Size: 425 MB
Statistics
  • Stars: 42
  • Watchers: 16
  • Forks: 27
  • Open Issues: 63
  • Releases: 6
Created over 5 years ago · Last pushed 9 months ago
Metadata Files
Readme License

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

Developer Installation

This is needed if you are a developer making changes to openstudio-standards or openstudio-geb gems or are running simulations locally using BuildStock Batch.

  1. Install the latest version of OpenStudio. ComStock requires OpenStudio 3.8.0 or newer.

  2. Install the Ruby version that corresponds to your OpenStudio install. See the OpenStudio SDK Version Compatibility Matrix.

    1. On Mac:
    2. Install Ruby 3.2.2 using rbenv (ruby -v from command prompt to check installed version).
    3. On Windows:
    4. Install Ruby+Devkit 3.2.2 (ruby -v from command prompt to check installed version).

  3. Connect Ruby to OpenStudio:

    1. On Mac:
    2. Create a file called openstudio.rb
    3. Contents: require "/Applications/openstudio-3.8.0/Ruby/openstudio.rb" Modify 3.8.0 to the version you installed.
    4. Save it here: /usr/lib/ruby/site_ruby/openstudio.rb
    5. On Windows:
    6. Create a file called openstudio.rb
    7. Contents: require "C:/openstudio-3.8.0/Ruby/openstudio.rb" Modify 3.8.0 to the version you installed.
    8. Save it here: C:/Ruby32-x64/lib/ruby/site_ruby/openstudio.rb

  4. gem install bundler This installs the bundler ruby gem.

  5. Install Git.

  6. Install GitHub desktop or another GUI that makes Git easier to use.

  7. Clone the ComStock source code using GitHub desktop (easier) or Git (harder).

  8. Run all commands below from the top level /ComStock directory

  9. mkdir .custom_gems This makes a temp directory to install required gems inside.

  10. copy /Y .\resources\Gemfile .\.custom_gems\Gemfile This copies the Gemfile to the temp directory.

  11. gem install bundler:2.4.10 This installs the version of bundler needed by OpenStudio.

  12. bundle _2.4.10_ install --path "C:/GitRepos/ComStock/.custom_gems" --gemfile "C:/GitRepos/ComStock/.custom_gems/Gemfile" --without test This will install all ruby gems necessary to develop this code.

  13. If running simulations locally, install BuildStock Batch

  14. Add the following additional Python packages into your buildstockbatch environment: bash conda activate buildstockbatch pip install GHEDesigner==1.0 pip install NREL-PySAM==4.2.0

Measure Tests

  1. Follow the developer installation instructions above. In particular, GHEDesigner==1.0 must be installed with pip install GHEDesigner==1.0.
  2. Run the measure tests with the rake command:
    • bundle exec rake unit_tests:all_tests to run all measure tests.
    • bundle exec rake unit_tests:reporting_measure_tests to run all reporting measure tests.
    • bundle exec rake unit_tests:workflow_measure_tests to run all workflow measure tests.
    • bundle exec rake unit_tests:upgrade_measure_tests to run all upgrade_ measure tests.

Running Rubocop

  1. Follow the developer installation instructions above
  2. navigate to the .custom_gems directory
  3. run bundle exec rake rubocop:show in terminal
  4. review results by opening the rubocop-results.html in the .rubocop/ directory
  5. rubcop can automatically fix errors by running rubocop --autocorrect. This will fix some, but not all errors, so you still need to check and make manual fixes.

Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Fork event: 18
  • Create event: 137
  • Commit comment event: 2
  • Release event: 2
  • Issues event: 59
  • Watch event: 13
  • Delete event: 106
  • Member event: 3
  • Issue comment event: 86
  • Push event: 946
  • Pull request review comment event: 154
  • Pull request review event: 234
  • Pull request event: 215
Last Year
  • Fork event: 18
  • Create event: 137
  • Commit comment event: 2
  • Release event: 2
  • Issues event: 59
  • Watch event: 13
  • Delete event: 106
  • Member event: 3
  • Issue comment event: 86
  • Push event: 946
  • Pull request review comment event: 154
  • Pull request review event: 234
  • Pull request event: 215

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 1,403
  • Total Committers: 24
  • Avg Commits per committer: 58.458
  • Development Distribution Score (DDS): 0.811
Past Year
  • Commits: 879
  • Committers: 19
  • Avg Commits per committer: 46.263
  • Development Distribution Score (DDS): 0.768
Top Committers
Name Email Commits
JanghyunJK j****m@n****v 265
Praprost m****s@n****v 185
Matthew Dahlhausen m****n@g****m 174
Landan Taylor l****r@n****v 104
Eric Ringold e****d@g****m 96
Andrew Parker a****2@g****m 86
Wenyi Kuang w****g@n****v 80
Xiong j****g@n****v 74
JieXiong9119 6****9@u****m 68
Ry Horsey h****y@g****m 54
Chris CaraDonna 5****a@u****m 40
Andrew Parker A****r@n****v 38
CaraDonna c****n@n****v 37
christophercaradonna c****a@n****v 35
Allen a****n@n****v 15
David Goldwasser d****r@n****v 13
Amy Van Sant 4****r@u****m 13
Alex Swindler A****r@n****v 6
wenyikuang 1****g@u****m 5
asparke2 a****r@n****v 4
carlobianchi89 c****i@u****u 4
Marley Praprost 4****t@u****m 3
Landan Taylor 1****T@u****m 2
Lauren Klun 6****n@u****m 2
Committer Domains (Top 20 + Academic)
nrel.gov: 12 utah.edu: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 119
  • Total pull requests: 444
  • Average time to close issues: 8 months
  • Average time to close pull requests: 19 days
  • Total issue authors: 19
  • Total pull request authors: 15
  • Average comments per issue: 0.34
  • Average comments per pull request: 0.47
  • Merged pull requests: 308
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 47
  • Pull requests: 238
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 15 days
  • Issue authors: 13
  • Pull request authors: 14
  • Average comments per issue: 0.26
  • Average comments per pull request: 0.45
  • Merged pull requests: 152
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mdahlhausen (39)
  • asparke2 (19)
  • eringold (17)
  • mpraprost (7)
  • wenyikuang (7)
  • ChristopherCaradonna (5)
  • mcpigman (4)
  • JanghyunJK (4)
  • JieXiong9119 (3)
  • laurenklun (2)
  • amylebar (2)
  • natbprice (2)
  • DavidGoldwasser (2)
  • invisibleroads (1)
  • amyeallen1 (1)
Pull Request Authors
  • JanghyunJK (71)
  • ChristopherCaradonna (68)
  • mpraprost (59)
  • mdahlhausen (49)
  • wenyikuang (35)
  • eringold (32)
  • JieXiong9119 (30)
  • LandanT (28)
  • asparke2 (21)
  • rHorsey (17)
  • amyeallen1 (16)
  • amylebar (12)
  • laurenklun (3)
  • ekpresent (2)
  • kflemin (1)
Top Labels
Issue Labels
bug (20) enhancement (20) postprocessing (17) reporting measure (12) workflow measure (7) infrastructure (4) wontfix (4) upgrade measure (2) sampling (2) documentation (2)
Pull Request Labels
Pull Request - Ready for CI (94) upgrade measure (91) postprocessing (69) reporting measure (55) infrastructure (43) workflow measure (40) documentation (34) bug (26) Do Not Merge (16) sampling (14) enhancement (5)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 2
proxy.golang.org: github.com/NREL/ComStock
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 9 months ago
proxy.golang.org: github.com/nrel/comstock
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 9 months ago

Dependencies

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