EnergyPlus™ is a whole building energy simulation program that engineers, architects, and researchers use to model both energy consumption and water use in buildings.
C++ Fortran Visual Basic CMake REALbasic Python Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github I/O ref edits for ZoneCrossMixing and related objects Jul 20, 2016
bin Fix unitsBasedOnField issue with new Wavelength option. Update versio… Sep 7, 2017
cmake Add input/output rules files along with updated install cmake stuff Jul 13, 2018
datasets Increment version ids for test files, datasets, and unit tests Jul 13, 2018
design Coil sizing report - design document Feb 26, 2018
doc Merge branch 'develop' into #6763-Swimming-pool-flow-not-added-to-pla… Jul 5, 2018
idd Merge pull request #6823 from NREL/issue_6729 Jul 13, 2018
performance_tests Increment version ids for test files, datasets, and unit tests Jul 13, 2018
release Fixup readme for release Mar 23, 2018
scripts Merge pull request #6823 from NREL/issue_6729 Jul 13, 2018
src Merge branch 'develop' of https://github.com/NREL/EnergyPlus into #6842 Jul 21, 2018
testfiles Fix last two test files that showed version errors Jul 13, 2018
third_party Update re2 library to slightly older version for gcc 4.8.4 Jul 10, 2018
tst Addition of unit test Jul 18, 2018
weather Update geojson to energyplus net Oct 13, 2015
.decent_ci-Linux.yaml Disable platform for now, get the code in, and turn it back on next week Jul 11, 2018
.decent_ci-MacOS.yaml Add "build_tag" to uniquify zip / tar builds Sep 6, 2017
.decent_ci-Windows.yaml Update .decent_ci-Windows.yaml Jan 5, 2018
.decent_ci.yaml Put baseline back on develop for performance test inclusion May 20, 2016
.gitignore Add epJSON schema to gitignore Feb 21, 2018
.gitlab-ci.yml Added .gitlab-ci.yml Jan 18, 2018
CMakeLists.txt Merge pull request #6671 from NREL/update-libraries Jul 13, 2018
LICENSE.txt Update the license year to 2018 Jan 4, 2018
README.md Tidied up dashboard discussion May 18, 2018

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.

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.