As building energy simulation (BES) becomes more integral to many aspects of architecture design and decision-making processes, computational reproducibility has become increasingly important to researchers, designers and practitioners. Lack of credibility in BES results due to a lack of reproducibility is widely considered a problem by the energy modeling community.
This is a half-day hands-on workshop on reproducing building energy simulations using R using a research compendium workflow. Participants gradually build up a research compendium through guided hands-on R programming exercises.
There is a dedicated guide that should be used along with this workshop.
This workshop is meant to be hands-on and interactive. This means you have the option of installing the software and playing with it during the workshop. But it is still strongly preferred not to spend time getting everyone setup. Here list all software requirements expect for R package dependencies:
- R
- RStudio
- Git
- EnergyPlus
- LaTeX
- Docker
Instructions on the installation of all required software and R packages can be found in the guide's Prerequisites chapter.
This schedule budgets time for a 4-hour iteration of the workshop (1 PM to 5 PM).
| Topic | Format | Minutes | Start | End | Materials |
|---|---|---|---|---|---|
| Introduction | lecture | 10 | 1:00 | 1:10 | Chapter 1 Introduction |
| Q&A | discussion | 5 | 1:10 | 1:15 | |
| Understand package structure | lecture | 15 | 1:15 | 1:30 | Chapter 2 Build up project |
| Build up a project | exercises | 10 | 1:30 | 1:40 | Chapter 2 Build up project |
| Parametric simulations | lecture | 15 | 1:40 | 1:55 | Chapter 3 Parametric simulations |
| Optimize performance | exercises | 25 | 1:55 | 2:20 | Chapter 3 Parametric simulations |
| Break | break | 10 | 2:20 | 2:30 | |
| Literate programming | lecture | 10 | 2:40 | 2:50 | Chapter 4 Literate programming |
| Write a manuscript | exercises | 20 | 2:50 | 3:10 | Chapter 4 Literate programming |
| Workflow automation | lecture | 10 | 3:10 | 3:20 | Chapter 5 Workflow automation |
| Build up a pipeline | exercises | 20 | 3:20 | 3:40 | Chapter 5 Workflow automation |
| Break | break | 10 | 3:40 | 3:50 | |
| Capture computational environment | lecture | 10 | 3:50 | 4:00 | Chapter 6 Computational environment |
| Build Docker containers | exercises | 25 | 4:00 | 4:25 | Chapter 6 Computational environment |
| Sharing research compendium | lecture | 10 | 4:25 | 4:35 | Chapter 7 Sharing the compendium |
| Create a GitHub repository | exercises | 15 | 4:35 | 4:50 | Chapter 7 Sharing the compendium |
| Closing Q&A | discussion | 10 | 4:50 | 5:00 |
Please note that the reprod-bes project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.