Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

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/NatLabRockies/EnergyPlus

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

energyplus buildings qt openstudio-sdk openstudio-models openstudio-coalition openstudio-application openstudio energy-efficiency kiva

Last synced: about 5 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.

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

Read the Docs
Read the Docs

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

GitHub Events

Total
Last Year

Committers metadata

Last synced: 24 days ago

Issue and Pull Request metadata

Last synced: 8 days ago

Total issues: 6
Total pull requests: 16
Average time to close issues: about 1 month
Average time to close pull requests: 7 days
Total issue authors: 5
Total pull request authors: 6
Average comments per issue: 4.0
Average comments per pull request: 4.69
Merged pull request: 6
Bot issues: 0
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 16
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 7 days
Past year issue authors: 5
Past year pull request authors: 6
Past year average comments per issue: 4.0
Past year average comments per pull request: 4.69
Past year merged pull request: 6
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NatLabRockies/EnergyPlus

Top Issue Authors

  • shorowit (2)
  • joseph-robertson (1)
  • jmarrec (1)
  • jmaguire1 (1)
  • cmsavage (1)

Top Pull Request Authors

  • mitchute (6)
  • amirroth (3)
  • joseph-robertson (3)
  • dareumnam (2)
  • rraustad (1)
  • kbenne (1)

Top Issue Labels

  • Triage (3)
  • Defect (3)
  • NewFeatureRequest (2)
  • UnconfirmedDefect (1)

Top Pull Request Labels

  • Defect (7)
  • DoNotPublish (5)
  • Refactoring (5)
  • NotIDDChange (3)
  • Developer Issue (1)

Dependencies

.github/workflows/build_wheels.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v3 composite
.github/workflows/build_checksums.yml actions
  • svenstaro/upload-release-action v2 composite
.github/workflows/build_documentation.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/disabled_test_debug_builds.yml.txt actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/release_linux.yml actions
  • 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
.github/workflows/release_mac.yml actions
  • 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
.github/workflows/release_windows.yml actions
  • 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
.github/workflows/test_code_integrity.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • jidicula/clang-format-action v4.13.0 composite
.github/workflows/test_develop_commits.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/test_epjson.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/test_pull_requests.yml actions
  • actions/checkout v4 composite
  • actions/github-script v7 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/verify_pr_labels.yml actions
  • mheap/github-action-required-labels v5 composite
cmake/codesign_doc/requirements.txt pypi
  • GitPython ==3.1.43
  • rst2pdf ==0.102
  • sphinx-rtd-theme ==2.0.0
  • sphinx-sitemap ==2.6.0
  • sphinxcontrib-moderncmakedomain ==3.29.0
doc/readthedocs/requirements.txt pypi
  • Jinja2 <3.1
  • sphinx >3
  • sphinx-rtd-theme *
  • urllib3 ==1.26.19
third_party/fmt-8.0.1/support/build.gradle maven
requirements.txt pypi
  • wheel *
scripts/pytests/requirements.txt pypi
  • lxml * test
  • pytest * test
setup.py pypi
third_party/EP-Launch-Lite/setup.py pypi

Score: -Infinity