anchen1011/energyplus

EnergyPlus™ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.

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.

Releases

EnergyPlus is typically released twice annually, usually in March and September. It is recommended all use of EnergyPlus is 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.

Documentation

Program documentation is installed alongside the program, with the pdfs also available online. Big Ladder also produces html based documentation online.

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

Commits to EnergyPlus are built by our team of robots (Tik-Tok, Gort, and Marvin), using the Decent CI continuous integration system. The testing dashboard gives a continually updated view of the status of all active branches, pull requests, and tags. A detailed description of compiling EnergyPlus on multiple platforms is available on the wiki.