EnergyPlus
A whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water usage in buildings.
https://github.com/NREL/EnergyPlus
Category: Consumption
Sub Category: Buildings and Heating
Keywords from Contributors
energyplus buildings measur control energy-efficiency qt foundation modelica openstudio openstudio-application
Last synced: about 8 hours ago
JSON representation
Repository metadata
EnergyPlus™ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.
- Host: GitHub
- URL: https://github.com/NREL/EnergyPlus
- Owner: NREL
- License: other
- Created: 2013-11-22T14:47:34.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-24T01:25:10.000Z (4 days ago)
- Last Synced: 2025-04-24T01:26:25.907Z (4 days ago)
- Language: C++
- Homepage: https://energyplus.net
- Size: 1.03 GB
- Stars: 1,235
- Watchers: 100
- Forks: 432
- Open Issues: 948
- Releases: 183
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE.txt
README.md
EnergyPlus 
This is the EnergyPlus Development Repository. EnergyPlus™ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.
Contact/Support
- The Department of Energy maintains a public website for EnergyPlus where you can find much more information about the program.
- For detailed developer information, consult the wiki.
- Many users (and developers) of EnergyPlus are active on Unmet Hours, so that's a great place to start if you have a question about EnergyPlus or building simulation.
- For more in-depth, developer-driven support, please utilize the EnergyPlus Helpdesk.
Testing
Every commit and every release of EnergyPlus undergoes rigorous testing.
The testing consists of building EnergyPlus, of course, then there are unit tests, integration tests, API tests, and regression tests.
Since 2014, most of the testing has been performed by our bots (Tik-Tok, Gort, and Marvin), using a fork of the Decent CI continuous integration system.
We are now adapting our efforts to use the Github Actions system to handle more of our testing processes.
In the meantime, while Decent CI is still handling the regression and bulkier testing, results from Decent CI are still available on the testing dashboard.
Releases
EnergyPlus is released twice annually, usually in March and September.
It is recommended all use of EnergyPlus in production workflows use these formal, public releases.
Iteration (pre-)releases may be created during a development cycle, however users should generally avoid these, as input syntax may change which won't be supported by the major release version transition tools, and could require manual intervention to remedy.
If an interim release is intended for active use by users, such as a bug-fix-only or performance-only re-release, it will be clearly specified on the release notes and a public announcement will accompany this type of release.
Our releases are now built by Github Actions.
Core Documentation
Program documentation is installed alongside the program, with the pdfs also available online.
Big Ladder also produces html based documentation online.
API Documentation
An API has been developed to allow access to internal EnergyPlus functionality and open up the possibility for new workflow opportunities around EnergyPlus.
A C API is developed to expose the C++ functions, then Python bindings are built on top of that to maximize the accessibility.
Documentation is being built and posted on ReadTheDocs and that documentation will continue to be expanded over time as the API grows.
The badges above here show the status, and link out to, the latest documentation (most recent commit to the develop branch) as well as the stable documentation (most recent release tag).
License & Contributing Development
EnergyPlus is available under a BSD-3-like license.
For more information, check out the license file.
The EnergyPlus team accepts contributions to EnergyPlus source, utilities, test files, documentation, and other materials distributed with the program.
The current EnergyPlus contribution policy is now available on the EnergyPlus contribution policy page.
If you are interested in contributing, please start there, but feel free to reach out to the team.
Building EnergyPlus
A detailed description of compiling EnergyPlus on multiple platforms is available on the wiki.
Also, as we are adapting to using Github Actions, the recipes for building EnergyPlus can be found in our workflow files.
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: 60
- Create event: 150
- Commit comment event: 1613
- Release event: 25
- Issues event: 179
- Watch event: 117
- Delete event: 112
- Member event: 1
- Issue comment event: 1447
- Push event: 509
- Pull request review event: 520
- Pull request review comment event: 745
- Pull request event: 248
Last Year
- Fork event: 60
- Create event: 150
- Commit comment event: 1613
- Release event: 25
- Issues event: 179
- Watch event: 117
- Delete event: 112
- Member event: 1
- Issue comment event: 1447
- Push event: 509
- Pull request review event: 520
- Pull request review comment event: 745
- Pull request event: 248
Committers metadata
Last synced: 4 days ago
Total Commits: 28,367
Total Committers: 118
Avg Commits per committer: 240.398
Development Distribution Score (DDS): 0.868
Commits in past year: 2,116
Committers in past year: 29
Avg Commits per committer in past year: 72.966
Development Distribution Score (DDS) in past year: 0.724
| Name | Commits | |
|---|---|---|
| Edwin Lee | l****1@g****m | 3745 |
| Richard Raustad | r****d@f****u | 2697 |
| mjwitte | m****e@g****m | 2680 |
| Julien Marrec | j****c@g****m | 1615 |
| Matt Mitchell | m****l@n****v | 1520 |
| jcyuan | j****n@g****m | 1305 |
| Jermy Thomas | j****v@g****m | 1243 |
| JasonGlazer | j****r@g****m | 1105 |
| Dareum Nam | i****m@g****m | 1097 |
| Nigusse | b****e@f****u | 994 |
| Yujie Xu | s****5@g****m | 700 |
| xuanluo113 | x****o@l****v | 624 |
| Rick Strand | r****d@i****u | 608 |
| Mark Adams | a****b@o****v | 600 |
| Lixing Gu | gu@f****u | 540 |
| Neal Kruis | n****s@b****m | 520 |
| Jason W. DeGraw | j****w@g****m | 454 |
| Jason Turner | j****n@e****m | 443 |
| Matt Mitchell | m****l@o****u | 435 |
| Noel Merket | n****t@n****v | 406 |
| Matthew Larson | m****n@b****m | 366 |
| nigusse | b****e@f****u | 359 |
| Brent Griffith | B****h@E****m | 343 |
| amirroth | r****r@g****m | 315 |
| Yujie Xu | y****x@5****s | 265 |
| brianlball | b****l@n****v | 258 |
| rongpengzhang | r****g@l****v | 257 |
| Lerond, Jeremy | j****d@p****v | 250 |
| Michael Patrick O'Keefe | m****e@b****m | 238 |
| Yueyue | Y****u@n****v | 176 |
| and 88 more... | ||
Committer domains:
- nrel.gov: 19
- bigladdersoftware.com: 8
- lbl.gov: 7
- ornl.gov: 5
- okstate.edu: 5
- pnnl.gov: 5
- d-alchemy.com: 4
- fsec.ucf.edu: 3
- gard.com: 3
- vols.utk.edu: 3
- ambient-e.com: 2
- nrcan-rncan.gc.ca: 1
- utoronto.ca: 1
- rgntgw1-1-84-dhcp.int.colorado.edu: 1
- archlinux.org: 1
- illinois.edu: 1
- mobile-192-17-205-154.near.uiuc.edu: 1
- mobile-192-17-193-140.near.uiuc.edu: 1
- emptycrate.com: 1
- loaner-26428s.nrel.gov: 1
- fsec.ucfedu: 1
- energyarchmage.com: 1
- 5c-e9-1e-83-4f-ff.dhcp.lbnl.us: 1
- mmitchel-34593s.nrel.gov: 1
- objexx.com: 1
- solaris-technical.com: 1
- a3.epfl.ch: 1
- glazer350.com: 1
- mccoyrothstrategies.lan: 1
- canada.ca: 1
- autodesk.com: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 7,571
Total pull requests: 3,605
Average time to close issues: 4 months
Average time to close pull requests: about 1 month
Total issue authors: 313
Total pull request authors: 103
Average comments per issue: 1.25
Average comments per pull request: 7.34
Merged pull request: 3,159
Bot issues: 0
Bot pull requests: 17
Past year issues: 300
Past year pull requests: 393
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 19 days
Past year issue authors: 55
Past year pull request authors: 25
Past year average comments per issue: 1.29
Past year average comments per pull request: 5.25
Past year merged pull request: 292
Past year bot issues: 0
Past year bot pull requests: 15
Top Issue Authors
- axelstudios (4,164)
- mjwitte (682)
- rraustad (238)
- jmarrec (199)
- Myoldmopar (190)
- aaron-boranian (167)
- JasonGlazer (166)
- BobHenninger (113)
- jcyuan2020 (102)
- shorowit (87)
- Nigusse (85)
- EnergyArchmage (73)
- lymereJ (62)
- lgu1234 (62)
- mitchute (48)
Top Pull Request Authors
- Myoldmopar (547)
- rraustad (356)
- jmarrec (316)
- mjwitte (285)
- mitchute (231)
- Nigusse (191)
- lgu1234 (160)
- RKStrand (155)
- JasonGlazer (154)
- jasondegraw (78)
- mbadams5 (74)
- jcyuan2020 (73)
- xuanluo113 (67)
- yujiex (59)
- EnergyArchmage (58)
Top Issue Labels
- Defect (3,860)
- SeverityMedium (3,396)
- PriorityLow (2,168)
- SeverityHigh (1,107)
- DoNotPublish (455)
- NewFeatureRequest (344)
- SeverityLow (275)
- Documentation (204)
- AuxiliaryTool (155)
- MigratedFromUserVoice (153)
- PriorityHigh (146)
- UnconfirmedDefect (142)
- NotIDDChange (104)
- WontFix (79)
- LowComplexityApproved (68)
- Developer Issue (48)
- Triage (46)
- Refactoring (41)
- IDDChange (39)
- Performance (34)
- AirflowNetwork (22)
- OutputChange (15)
- InProgress (15)
- NewFeature (11)
- HighComplexityApproved (11)
- LowComplexity (10)
- Weather (9)
- WebSite (7)
- MediumComplexityApproved (7)
- MediumComplexity (3)
Top Pull Request Labels
- Defect (1,778)
- DoNotPublish (824)
- NewFeature (431)
- Refactoring (412)
- IDDChange (321)
- NotIDDChange (201)
- Performance (101)
- OutputChange (72)
- Documentation (68)
- Developer Issue (62)
- AuxiliaryTool (32)
- AirflowNetwork (23)
- dependencies (17)
- APIChange (16)
- github_actions (13)
- LowComplexityApproved (8)
- PriorityHigh (7)
- SeverityLow (6)
- SeverityHigh (3)
- MergeAfterRelease (3)
- SeverityMedium (2)
- InProgress (2)
- DoNotMerge (2)
- Weather (1)
- NewFeatureRequest (1)
- UnconfirmedDefect (1)
- PriorityLow (1)
- HighComplexityApproved (1)
- python (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- actions/upload-artifact v3 composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/upload-artifact v4 composite
- jmarrec/setup-python v5 composite
- jmarrec/setup-qtifw v1 composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- jmarrec/setup-python v5 composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- jmarrec/setup-python v5 composite
- jmarrec/setup-qtifw v1 composite
- svenstaro/upload-release-action v2 composite
- actions/checkout v4 composite
- actions/upload-artifact v4 composite
- jidicula/clang-format-action v4.13.0 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/checkout v4 composite
- actions/github-script v7 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- mheap/github-action-required-labels v5 composite
- GitPython ==3.1.43
- rst2pdf ==0.102
- sphinx-rtd-theme ==2.0.0
- sphinx-sitemap ==2.6.0
- sphinxcontrib-moderncmakedomain ==3.29.0
Score: 12.459139981015609