eplusr
Provides a rich toolkit of using whole building energy simulation program EnergyPlus directly in R, which enables programmatic navigation, modification of EnergyPlus, conducts parametric simulations and retrieves outputs.
https://github.com/hongyuanjia/eplusr
Category: Consumption
Sub Category: Buildings and Heating
Keywords
energy-simulation energyplus energyplus-models eplus epw idd idf parametric-simulation r r6 simulation
Keywords from Contributors
climate-change cmip6 esgf psychrometrics
Last synced: about 13 hours ago
JSON representation
Repository metadata
A Toolkit for Using EnergyPlus in R.
- Host: GitHub
- URL: https://github.com/hongyuanjia/eplusr
- Owner: hongyuanjia
- License: other
- Created: 2017-04-26T15:16:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2026-11-05T01:21:05.000Z (11 days ago)
- Last Synced: 2026-11-15T17:31:19.028Z (about 13 hours ago)
- Topics: energy-simulation, energyplus, energyplus-models, eplus, epw, idd, idf, parametric-simulation, r, r6, simulation
- Language: R
- Homepage: https://hongyuanjia.github.io/eplusr
- Size: 36.7 MB
- Stars: 75
- Watchers: 8
- Forks: 15
- Open Issues: 35
- Releases: 26
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
README.md
eplusr
A Toolkit for Using EnergyPlus in R.
eplusr provides a rich toolkit of using whole building energy simulation
program EnergyPlus directly in R, which
enables programmatic navigation, modification of EnergyPlus, conducts
parametric simulations and retrieves outputs. More information about
EnergyPlus can be found at its website.
A comprehensive introduction to eplusr can be found using
vignette("eplusr").
There is also an online slides here (Interfacing EnergyPlus Using
R). You can learn more
about eplusr at https://hongyuanjia.github.io/eplusr/, along with full
package documentation.
How to cite
citation("eplusr")
#> To cite eplusr in publications use:
#>
#> Hongyuan Jia, Adrian Chong (2021). eplusr: A framework for
#> integrating building energy simulation and data-driven analytics.
#> Energy and Buildings 237: 110757.
#> https://doi.org/10.1016/j.enbuild.2021.110757
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Article{,
#> title = {eplusr: A framework for integrating building energy simulation and data-driven analytics},
#> author = {Hongyuan Jia and Adrian Chong},
#> year = {2020},
#> journal = {Energy and Buildings},
#> volume = {237},
#> url = {https://CRAN.R-project.org/package=eplusr},
#> doi = {10.1016/j.enbuild.2021.110757},
#> }
Installation
You can install the latest stable release of eplusr from CRAN.
install.packages("eplusr")
Alternatively, you can install the development version from GitHub.
install.packages("eplusr",
repos = c(
hongyuanjia = "https://hongyuanjia.r-universe.dev",
cran = "https://cran.r-project.org"
)
)
Since running the IDF files requires EnergyPlus
(https://energyplus.net), EnergyPlus has to be installed if you want
to run EnergyPlus models in R. There are helper functions in eplusr to
download and install it automatically on major operating systems
(Windows, macOS and Linux):
# install the latest version (currently v26.2.0)
eplusr::install_eplus("latest")
# OR download the latest version (currently v26.2.0) and run the installer
# manually by yourself
eplusr::download_eplus("latest", dir = tempdir())
Note that the installation process in install_eplus() requires
administrative privileges. You have to run R with administrator (or
with sudo if you are on macOS or Linux) to make it work if you are not
in interactive mode.
Features
- Download, install EnergyPlus in R
- Read, parse and modify EnergyPlus:
- Input Data File (IDF)
- Weather File (EPW)
- Report Data Dictionary (RDD) & Meter Data Dictionary (MDD)
- Error File (ERR)
- Modify multiple versions of IDFs and run corresponding EnergyPlus both
in the background and in the front - Rich-featured interfaces to query and modify IDFs
- Automatically handle referenced fields and validate input during
modification - Take fully advantage of most common used data structure for data
science in R – data.frame- Extract model, weather data into data.frames
- Modify multiple objects via data.frames input
- Query output via SQL in Tidy format which is much better for data
analysis and visualization
- Provide a simple yet extensible prototype of conducting parametric
simulations and collect all results in one go - A pure R-based version updater which is more than
20X
faster than VersionUpdater distributed with EnergyPlus - Fast 3D geometry visualization
View IDF geometry in 3D
Turn RStudio into a model editor via autocompletion
Query and modify weather file
Query output via SQL in Tidy format which is much better for data
analysis
Resources
Articles
- Hongyuan Jia, Adrian Chong (2020). eplusr: A framework for integrating
building energy simulation and data-driven analytics. doi:
10.13140/RG.2.2.34326.16966
Vignettes
Please see these vignettes and articles about {eplusr}
- Introduction to
eplusr - Run simulation and data
exploration - Parametric
simulations - Update IDF
version - Work with weather
files - Work with
Schedule:Compact
objects - Work with
geometries - Frequently asked
questions
Slides
Additional resources
- eplusr manual: https://hongyuanjia.github.io/eplusr/
- eplusr Docker image: https://github.com/hongyuanjia/eplusr-docker
- epwshiftr for creating
future EnergyPlus weather files using CMIP6 data - epluspar for conducting
parametric analysis on EnergyPlus models, including sensitivity
analysis, Bayesian calibration and optimization.
Acknowledgment
I would like to thank many open source projects who have heavily
inspired the development of eplusr package, especially these below:
- EnergyPlus: A whole building energy
simulation program. - OpenStudio: A cross-platform collection of
software tools to support whole building energy modeling using
EnergyPlus and advanced daylight analysis using Radiance. - eppy: Scripting language for
E+, EnergyPlus. - JEplus: An EnergyPlus simulation manager for
parametrics.
Author
Hongyuan Jia and Adrian Chong
License
The project is released under the terms of MIT License.
Copyright © 2016-2025 Hongyuan Jia and Adrian Chong
Please note that the ‘eplusr’ project is released with a Contributor
Code of
Conduct.
By contributing to this project, you agree to abide by its terms.
Owner metadata
- Name: Hongyuan Jia
- Login: hongyuanjia
- Email: hongyuanjia@cqust.edu.cn
- Kind: user
- Description: R & building energy simulations
- Website: hongyuanjia.net
- Location: Chongqing, China
- Twitter: hongyuanjia
- Company: Chongqing University of Science and Technology
- Icon url: https://avatars.githubusercontent.com/u/20545387?u=0e0bd45ee6aa5aed374cfe92fd5ef9f2d2595010&v=4
- Repositories: 72
- Last ynced at: 2026-11-10T15:09:47.578Z
- Profile URL: https://github.com/hongyuanjia
GitHub Events
Total
- Create event: 12
- Delete event: 7
- Issues event: 7
- Pull request event: 5
- Push event: 54
- Release event: 1
- Watch event: 4
Last Year
- Create event: 10
- Delete event: 6
- Issues event: 1
- Pull request event: 3
- Push event: 47
- Watch event: 1
Committers metadata
Last synced: 1 day ago
Total Commits: 1,823
Total Committers: 3
Avg Commits per committer: 607.667
Development Distribution Score (DDS): 0.331
Commits in past year: 40
Committers in past year: 1
Avg Commits per committer in past year: 40.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Hongyuan Jia | h****a@c****n | 1220 |
| Hongyuan Jia | h****a@b****g | 602 |
| dmurdoch | m****n@g****m | 1 |
Committer domains:
- bears-berkeley.sg: 1
- cqu.edu.cn: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 363
Total pull requests: 301
Average time to close issues: 5 months
Average time to close pull requests: 4 days
Total issue authors: 19
Total pull request authors: 3
Average comments per issue: 0.48
Average comments per pull request: 0.29
Merged pull request: 289
Bot issues: 0
Bot pull requests: 0
Past year issues: 32
Past year pull requests: 34
Past year average time to close issues: about 4 hours
Past year average time to close pull requests: about 4 hours
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 0.13
Past year average comments per pull request: 0.59
Past year merged pull request: 31
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- hongyuanjia (327)
- yatingchen (9)
- bdcoelho (5)
- yidan1214 (4)
- Enchufa2 (2)
- wch (2)
- jywang2016 (2)
- chenwei2017 (1)
- evelynsoong (1)
- divyanshusood (1)
- sckott (1)
- lukas-rokka (1)
- bjurban (1)
- JChyi98 (1)
- corymosiman12 (1)
Top Pull Request Authors
- hongyuanjia (299)
- roblourens (1)
- dmurdoch (1)
Top Issue Labels
- bug (138)
- feature (66)
- enhancement (40)
- idf (28)
- CRAN (20)
- documentation (20)
- EPW (18)
- EnergyPlus (13)
- SQL (13)
- parametric (13)
- ready-for-agent (12)
- geometry (10)
- CI (8)
- run (8)
- compatibility (8)
- question (7)
- refactor (6)
- idd (4)
- duplicate (4)
- validate (3)
- release (3)
- performance (3)
- transition (3)
- schedule (2)
- GUI (2)
- help wanted (1)
- viewer (1)
- dependency (1)
- invalid (1)
- autocomplete (1)
Top Pull Request Labels
- bug (121)
- feature (53)
- enhancement (32)
- EnergyPlus (21)
- idf (20)
- EPW (18)
- CI (16)
- documentation (15)
- SQL (12)
- parametric (10)
- run (9)
- CRAN (9)
- refactor (8)
- compatibility (7)
- geometry (7)
- transition (3)
- performance (2)
- schedule (2)
- idd (2)
- dependency (2)
- GUI (1)
- viewer (1)
- release (1)
- autocomplete (1)
Package metadata
- Total packages: 2
-
Total downloads:
- cran: 902 last-month
- Total dependent packages: 1 (may contain duplicates)
- Total dependent repositories: 2 (may contain duplicates)
- Total versions: 49
- Total maintainers: 1
proxy.golang.org: github.com/hongyuanjia/eplusr
- Homepage:
- Documentation: https://pkg.go.dev/github.com/hongyuanjia/eplusr#section-documentation
- Licenses: other
- Latest release: v0.18.0 (published about 1 month ago)
- Last Synced: 2026-11-14T17:02:21.890Z (1 day ago)
- Versions: 21
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
cran.r-project.org: eplusr
A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'
- Homepage: https://hongyuanjia.github.io/eplusr/
- Documentation: http://cran.r-project.org/web/packages/eplusr/eplusr.pdf
- Licenses: MIT + file LICENSE
- Latest release: 0.18.0 (published about 1 month ago)
- Last Synced: 2026-11-14T17:02:15.963Z (1 day ago)
- Versions: 28
- Dependent Packages: 1
- Dependent Repositories: 2
- Downloads: 902 Last month
-
Rankings:
- Stargazers count: 5.623%
- Forks count: 5.825%
- Average: 12.588%
- Downloads: 14.374%
- Dependent packages count: 17.575%
- Dependent repos count: 19.546%
- Maintainers (1)
Dependencies
- R >= 3.2.0 depends
- R6 * imports
- RSQLite * imports
- callr >= 2.0.4 imports
- checkmate * imports
- cli >= 1.1.0 imports
- crayon * imports
- data.table >= 1.12.4 imports
- hms * imports
- lubridate * imports
- methods * imports
- processx >= 3.2.0 imports
- progress >= 1.2.0 imports
- stringi * imports
- units * imports
- decido * suggests
- rgl >= 0.105.13 suggests
- testthat >= 2.1.0 suggests
- actions/checkout v2 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/checkout v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/checkout v2 composite
- r-lib/actions/pr-fetch v2 composite
- r-lib/actions/pr-push v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- actions/checkout v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- rocker/r-ver 4.1.0 build
- r-hub/actions/checkout v1 composite
- r-hub/actions/platform-info v1 composite
- r-hub/actions/run-check v1 composite
- r-hub/actions/setup v1 composite
- r-hub/actions/setup-deps v1 composite
- r-hub/actions/setup-r v1 composite
Score: 12.608131960503506