Skip to content

Latest commit

 

History

History
89 lines (69 loc) · 7.19 KB

README.md

File metadata and controls

89 lines (69 loc) · 7.19 KB
Raw

A simple example of reproducible building energy simulation

Launch RStudio Cloud Docker Build Status

This repository contains a simple example demonstrating the use of Docker containers to reproduce the calibration of a building energy simulation model.

More details can be found in Section 7.4 of our paper:

Adrian Chong, Yaonan Gu and Hongyuan Jia, (2021). Calibrating building energy simulation models: A review of the basics to guide future work. Energy and Buildings, 111533. doi: https://doi.org/10.1016/j.enbuild.2021.111533

Citation

Please cite this compendium as:

@article{chong2021calibrating,
  title={Calibrating building energy simulation models: A review of the basics to guide future work},
  author={Chong, Adrian and Gu, Yaonan and Jia, Hongyuan},
  journal={Energy and Buildings},
  pages={111533},
  year={2021},
  doi={https://doi.org/10.1016/j.enbuild.2021.111533},
  publisher={Elsevier}
}

How to access

There are several ways to try out this example:

  1. Using the Docker image.

  2. Using the RStudio Cloud instance.

  3. Clone or download this repository and install the required R packages by calling renv::restore().

File structure

The main files are:

.
├── renv.lock
├── R
│   └── functions.R
├── data-raw
│   ├── epw
│   │   └── ...
│   └── idf
│       └── ...
├── analysis
│   ├── workflow-synthetic.Rmd
│   └── workflow-calibrate.Rmd
├── data
│   ├── idf
│   │   └── ...
│   └── sim
│       └── ...
├── figures
│   └── ...
└── report
    ├── workflow-synthetic.html
    └── workflow-calibrate.html
File Purpose
renv.lock The renv lockfile, describing the state of libraries used in this projected.
R/*.R R scripts with helper functions for model modification, simulation output extraction, optimization and results visualization.
data-raw/idf/*.idf The uncalibrated example EnergyPlus model.
data-raw/epw/*/*.epw The TMY3 (Typical meteorological year) and AMY(Actual Meteorological Year) EnergyPlus weather file.
analysis/workflow-synthetic.Rmd The R Markdown file which documents the synthetic data creation workflow.
analysis/workflow-calibrate.Rmd The R Markdown file which documents the model calibration workflow.
data/idf/ The processed model generated during the calibration workflow.
data/sim/ The simulation result summary for each processed model.
figures/ Plots generated during the calibration process, including one line plot per simulation comparing the synthetic meter data and simulation data.
report/workfow-calibrate.html The rendered workflow-synthetic.Rmd in HTML format. You can preview it here.
report/workfow-calibrate.html The rendered workflow-calibrate.Rmd in HTML format. You can preview it here.

Licenses

Code : MIT license

Data : CC-0 attribution requested in reuse