resstock
Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.
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
4 of 38 committers (10.5%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary
Keywords from Contributors
energy-data
buildings
building-energy
carbon-emissions
demand-side-management
energy-consumption
energy-efficiency
energyplus
openstudio
openstudio-application
Last synced: 10 months ago
·
JSON representation
Repository
Highly granular modeling of residential building stocks at national, regional, and local scales using OpenStudio/EnergyPlus.
Basic Info
- Host: GitHub
- Owner: NREL
- License: other
- Language: Ruby
- Default Branch: develop
- Homepage: https://resstock.nrel.gov
- Size: 5.97 GB
Statistics
- Stars: 128
- Watchers: 27
- Forks: 80
- Open Issues: 99
- Releases: 19
Created over 10 years ago
· Last pushed 11 months ago
Metadata Files
Readme
License
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
- Name: National Renewable Energy Laboratory
- Login: NREL
- Kind: organization
- Location: Golden, CO
- Website: http://www.nrel.gov
- Repositories: 599
- Profile: https://github.com/NREL
GitHub Events
Total
- Create event: 131
- Commit comment event: 1
- Release event: 2
- Delete event: 126
- Member event: 3
- Pull request event: 212
- Fork event: 29
- Issues event: 41
- Watch event: 20
- Issue comment event: 115
- Push event: 1,676
- Gollum event: 4
- Pull request review comment event: 235
- Pull request review event: 264
Last Year
- Create event: 131
- Commit comment event: 1
- Release event: 2
- Delete event: 126
- Member event: 3
- Pull request event: 212
- Fork event: 29
- Issues event: 41
- Watch event: 20
- Issue comment event: 115
- Push event: 1,677
- Gollum event: 4
- Pull request review comment event: 235
- Pull request review event: 264
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Joe Robertson | j****n@n****v | 4,504 |
| GitHub Action | g****n | 1,218 |
| 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 376
- Total pull requests: 1,255
- Average time to close issues: 8 months
- Average time to close pull requests: about 1 month
- Total issue authors: 41
- Total pull request authors: 30
- Average comments per issue: 2.05
- Average comments per pull request: 0.93
- Merged pull requests: 925
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 34
- Pull requests: 250
- Average time to close issues: about 1 month
- Average time to close pull requests: 16 days
- Issue authors: 13
- Pull request authors: 13
- Average comments per issue: 0.53
- Average comments per pull request: 0.48
- Merged pull requests: 164
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- joseph-robertson (139)
- shorowit (61)
- ejhw (34)
- afontani (23)
- ekpresent (22)
- lixiliu (14)
- jmaguire1 (9)
- aspeake (9)
- rajeee (8)
- whiphi92 (7)
- sudeepy (4)
- mcpigman (4)
- nmerket (4)
- jmarrec (3)
- jbrossman (3)
Pull Request Authors
- joseph-robertson (694)
- shorowit (127)
- afontani (103)
- rajeee (88)
- aspeake (46)
- lixiliu (45)
- ejhw (26)
- yingli-NREL (24)
- JLReyna (14)
- vtnate (11)
- whiphi92 (10)
- mpathak24 (9)
- jmaguire1 (8)
- ekpresent (7)
- TobiAdekanye (6)
Top Labels
Issue Labels
enhancement (41)
bug (26)
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)
Pull Request Labels
DO NOT MERGE (102)
bug (63)
enhancement (18)
OS-HPXML Backport (16)
docs (13)
feature (7)
waiting on others (4)
priority high (3)
in progress (2)
priority low (2)
GEB (2)
refactor (2)
help wanted (1)
priority highest (1)
input data (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/pyproject.toml
pypi
- buildstock_query @ git+https://github.com/NREL/buildstock-query@main
- fsspec *
- geopandas *
- kaleido ==0.2.1
- pandas *
- plotly *
- polars *
- pyarrow *
- s3fs *
postprocessing/uv.lock
pypi
- 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
.github/workflows/post_run.yml
actions
- actions/checkout v4 composite
- astral-sh/setup-uv v6 composite