Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hongyuanjia/reprod-bes


https://github.com/hongyuanjia/reprod-bes

energy-simulation energyplus eplus parametric-simulation r reproducible-research research-compendium simulation

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Reproducing building energy simulations using R



[![guide](https://github.com/hongyuanjia/reprod-bes/actions/workflows/bookdown.yaml/badge.svg)](https://github.com/hongyuanjia/reprod-bes/actions/workflows/bookdown.yaml)



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](https://peerj.com/preprints/3192)

workflow. Participants gradually build up a research compendium through guided

hands-on R programming exercises.



There is a dedicated [guide](https://reprod-bes.hongyuanjia.me/) that should be

used along with this workshop.



## Prerequisites



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](https://reprod-bes.hongyuanjia.me/prerequisites.html)

chapter.



## Schedule



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](https://reprod-bes.hongyuanjia.me/intro.html)             |

| Q&A                               | discussion |       5 |  1:10 | 1:15 |                                                                                    |

| Understand package structure      | lecture    |      15 |  1:15 | 1:30 | [Chapter 2 Build up project](https://reprod-bes.hongyuanjia.me/project.html)       |

| Build up a project                | exercises  |      10 |  1:30 | 1:40 | [Chapter 2 Build up project](https://reprod-bes.hongyuanjia.me/project.html)       |

| Parametric simulations            | lecture    |      15 |  1:40 | 1:55 | [Chapter 3 Parametric simulations](https://reprod-bes.hongyuanjia.me/eplusr.html)  |

| Optimize performance              | exercises  |      25 |  1:55 | 2:20 | [Chapter 3 Parametric simulations](https://reprod-bes.hongyuanjia.me/eplusr.html)  |

| *Break*                           | break      |      10 |  2:20 | 2:30 |                                                                                    |

| Literate programming              | lecture    |      10 |  2:40 | 2:50 | [Chapter 4 Literate programming](https://reprod-bes.hongyuanjia.me/rmarkdown.html) |

| Write a manuscript                | exercises  |      20 |  2:50 | 3:10 | [Chapter 4 Literate programming](https://reprod-bes.hongyuanjia.me/rmarkdown.html) |

| Workflow automation               | lecture    |      10 |  3:10 | 3:20 | [Chapter 5 Workflow automation](https://reprod-bes.hongyuanjia.me/targets.html)    |

| Build up a pipeline               | exercises  |      20 |  3:20 | 3:40 | [Chapter 5 Workflow automation](https://reprod-bes.hongyuanjia.me/targets.html)    |

| *Break*                           | break      |      10 |  3:40 | 3:50 |                                                                                    |

| Capture computational environment | lecture    |      10 |  3:50 | 4:00 | [Chapter 6 Computational environment](https://reprod-bes.hongyuanjia.me/renv.html) |

| Build Docker containers           | exercises  |      25 |  4:00 | 4:25 | [Chapter 6 Computational environment](https://reprod-bes.hongyuanjia.me/renv.html) |

| Sharing research compendium       | lecture    |      10 |  4:25 | 4:35 | [Chapter 7 Sharing the compendium](https://reprod-bes.hongyuanjia.me/github.html)  |

| Create a GitHub repository        | exercises  |      15 |  4:35 | 4:50 | [Chapter 7 Sharing the compendium](https://reprod-bes.hongyuanjia.me/github.html)  |

| Closing Q&A                       | discussion |      10 |  4:50 | 5:00 |                                                                                    |



## Code of Conduct



Please note that the reprod-bes project is released with a [Contributor Code of

Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By

contributing to this project, you agree to abide by its terms.