Skip to content

Commit

Permalink
Add draft paper (ideas-lab-nus#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
hongyuanjia authored Nov 21, 2021
1 parent 52dab1d commit 86f058a
Show file tree
Hide file tree
Showing 8 changed files with 351 additions and 20 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ jobs:
run: |
install.packages('remotes')
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
shell: Rscript {0}

- name: Cache R packages
uses: actions/cache@v1
with:
path: ${{ env.R_LIBS_USER }}
key: macOS-r-4.0-2-${{ hashFiles('.github/depends.Rds') }}
restore-keys: macOS-r-4.0-2-
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-

- name: Install dependencies
run: |
install.packages(c("remotes"))
remotes::install_deps(dependencies = TRUE)
remotes::install_cran("covr")
shell: Rscript {0}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
.Rproj.user
*.pdf
docs/
inst/doc
4 changes: 3 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Imports:
Suggests:
testthat,
pingr,
covr
knitr,
rmarkdown
License: MIT + file LICENSE
Encoding: UTF-8
URL: https://github.com/ideas-lab-nus/epwshiftr
Expand All @@ -49,3 +50,4 @@ Collate:
'esgf.R'
'morph.R'
'netcdf.R'
VignetteBuilder: knitr
2 changes: 0 additions & 2 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
comment: true

coverage:
status:
project:
Expand Down
4 changes: 4 additions & 0 deletions vignettes/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.html
*.R
*.log
*.pdf
86 changes: 77 additions & 9 deletions vignettes/paper.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ tags:
- R
- CMIP6
- EnergyPlus
- EPW
- Climate change
- Weather
authors:
Expand All @@ -23,22 +24,89 @@ citation_author: Jia and Chong
date: 20 November 2021
year: 2021
bibliography: paper.bib
output: rticles::joss_article
journal: JOSS
output:
rmarkdown::html_vignette:
keep_md: TRUE
vignette: >
%\VignetteEncoding{UTF-8}
%\VignetteIndexEntry{epwshiftr: Create future EnergyPlus Weather files using CMIP6 data}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
editor_options:
markdown:
wrap: 80
---

```{r, include = FALSE}
knitr::opts_chunk$set(collapse = TRUE, comment = "#>", width = 68)
options(width = 68, cli.unicode = FALSE, cli.width = 68)
```
# Summary

[![](logo.png "The epwshiftr package logo"){width="120px"}](https://cran.r-project.org/package=epwshiftr)

Building energy simulation (BES) has become increasingly applied to assess
building performance under climate changes and yield a more sustainable and
resilient design [@yassaghi2019]. Multiple morphing-based weather-file
modification tools have been developed to integrate climate change predictions
[@troup2016]. Most of the widely adopted weather generators, including
CCWorkdWeatherGen [@jentsch2008], Meteonorm [@remund2020], and WeatherShift
[@dickinson2016], use GCM (Global Climate Models) data from the CMIP (Coupled
Model Intercomparison Project) that covers worldwide locations.

Currently, the CMIP project is in its sixth phase (CMIP6) [@eyring2016], which
has developed new emission scenarios that have a similar range as its fifth
phase (CMIP5) but fill critical gaps for intermediate forcing levels
[@oneill2016]. It will be used in the Sixth IPCC (Intergovernmental Panel on
Climate Change) Climate Assessments Reports [@ipcc2021]. However, existing tools
based on the previous CMIP were unable to utilize the data from the latest
climate change research. Currently, there are no tools available that could
process user-defined climate simulations in an automated way and allow further
statistical analysis.

The epwshiftr package bridges these gaps. It is a free, open-source R package
for adapting a whole-building energy simulation EnergyPlus [@crawley2001]
Weather (EPW) files to incorporate climate change predictions using the morphing
statistical downscaling method [@belcher2005]. The primary goal is to
automatically process large amounts of climate change prediction outputs from
the CMIP6 (CMIP Phase 6) GCMs and create future climate data for BES across
worldwide locations in a user-friendly and flexible way.

# Epwshiftr R package

Epwshiftr is capable of processing multiple GCM outputs at various spatial and
temporal resolutions. Additionally, the package is designed in a modular manner
for flexibility and extensibility. There are five modules in total, and the
table below lists their corresponding names and functionalities.

+-------------------+----------------------------------------------------------+
| Module name | Description |
+===================+==========================================================+
| Query module | Query and store metadata of online CMIP6 GCM outputs via |
| | the ESGF (Earth System Grid Federation) Search RESTful |
| | API. Meta includes the name of GCM, the institution that |
| | developed the GCM, emission scenarios, output interval, |
| | nominal resolution, output variable, output unit, etc. |
+-------------------+----------------------------------------------------------+
| Database module | Create and manage a local database of GCM outputs using |
| | NetCDF files downloaded in the ESGF portal. |
+-------------------+----------------------------------------------------------+
| Data Extraction | Extract climate variable data of desired temporal domain |
| Module | and specified grid distances to the input baseline EPW |
| | file |
+-------------------+----------------------------------------------------------+
| Morphing Module | Calculate future weather data under the latest CMIP6 |
| | emission scenarios using the morphing method |
+-------------------+----------------------------------------------------------+
| EPW Generation | Create future EPW files using various data aggregation |
| Module | strategies using the eplusr package [@jia2021] |
+-------------------+----------------------------------------------------------+

: The modules designed in the epwshiftr package

# Introduction
Each module stores climate data in a consistent Tidy [@wickham2014] data format,
allowing exploring a considerably broad pool of ready-to-use methods available
in R for customized statistical analysis. Computational-intensive processes have
been designed to run in parallel for speed-up.

![](logo.png){ width=120px }
The epwshiftr is distributed via CRAN (The Comprehensive R Archive Network). The
source code is available on GitHub at
<https://github.com/ideas-lab-nus/epwshiftr> and released under the MIT license.

# Acknowledgements

Expand Down
180 changes: 180 additions & 0 deletions vignettes/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@

@article{yassaghi2019,
title = {An Overview of Climate Change and Building Energy: Performance, Responses and Uncertainties},
author = {Yassaghi, and Hoque, },
year = {2019},
month = {07},
date = {2019-07-08},
journal = {Buildings},
pages = {166},
volume = {9},
number = {7},
doi = {10.3390/buildings9070166},
url = {https://www.mdpi.com/2075-5309/9/7/166},
note = {00001
tex.ids= yassaghi2019overview},
langid = {en}
}

@inproceedings{troup2016,
title = {Building Performance Modeling Conference},
author = {Troup, Luke},
year = {2016},
month = {08},
date = {2016-08-08},
pages = {8},
note = {00000},
address = {Salt Lake City, UT, U.S.},
langid = {en}
}

@article{jentsch2008,
title = {Climate change future proofing of buildings{\textemdash}Generation and assessment of building simulation weather files},
author = {Jentsch, Mark F. and Bahaj, AbuBakr S. and James, Patrick A.B.},
year = {2008},
month = {01},
date = {2008-01},
journal = {Energy and Buildings},
pages = {2148--2168},
volume = {40},
number = {12},
doi = {10/b4n9qc},
url = {https://linkinghub.elsevier.com/retrieve/pii/S0378778808001400},
note = {00297},
langid = {en}
}

@inproceedings{dickinson2016,
title = {36 th International Conference on Passive and Low Energy Architecture},
author = {Dickinson, Robert and Brannon, Benjamin},
year = {2016},
month = {07},
date = {2016-07-11},
pages = {6},
note = {00000
tex.ids= dickinson2016a},
address = {Los Angeles, U.S.},
langid = {en}
}

@article{eyring2016,
title = {Overview of the Coupled Model Intercomparison Project Phase 6 (CMIP6) experimental design and organization},
author = {Eyring, Veronika and Bony, Sandrine and Meehl, Gerald A. and Senior, Catherine A. and Stevens, Bjorn and Stouffer, Ronald J. and Taylor, Karl E.},
year = {2016},
month = {05},
date = {2016-05-26},
journal = {Geoscientific Model Development},
pages = {1937--1958},
volume = {9},
number = {5},
doi = {10.5194/gmd-9-1937-2016},
url = {https://gmd.copernicus.org/articles/9/1937/2016/},
note = {01572
Publisher: Copernicus GmbH},
langid = {English}
}

@article{oneill2016,
title = {The Scenario Model Intercomparison Project (ScenarioMIP) for CMIP6},
author = {{O'Neill}, Brian C. and Tebaldi, Claudia and van Vuuren, Detlef P. and Eyring, Veronika and Friedlingstein, Pierre and Hurtt, George and Knutti, Reto and Kriegler, Elmar and Lamarque, Jean-Francois and Lowe, Jason and Meehl, Gerald A. and Moss, Richard and Riahi, Keywan and Sanderson, Benjamin M.},
year = {2016},
month = {09},
date = {2016-09-28},
journal = {Geoscientific Model Development},
pages = {3461--3482},
volume = {9},
number = {9},
doi = {10.5194/gmd-9-3461-2016},
url = {https://gmd.copernicus.org/articles/9/3461/2016/},
note = {00344
Publisher: Copernicus GmbH},
langid = {English}
}

@article{crawley2001,
title = {EnergyPlus: creating a new-generation building energy simulation program},
author = {Crawley, Drury B. and Lawrie, Linda K. and Winkelmann, Frederick C. and Buhl, W. F. and Huang, Y. Joe and Pedersen, Curtis O. and Strand, Richard K. and Liesen, Richard J. and Fisher, Daniel E. and Witte, Michael J. and Glazer, Jason},
year = {2001},
month = {04},
date = {2001-04},
journal = {Energy and Buildings},
pages = {319--331},
series = {Special Issue: BUILDING SIMULATION'99},
volume = {33},
number = {4},
doi = {10.1016/s0378-7788(00)00114-6},
url = {http://www.sciencedirect.com/science/article/pii/S0378778800001146},
note = {00000}
}

@article{belcher2005,
title = {Constructing design weather data for future climates},
author = {Belcher, Se and Hacker, Jn and Powell, Ds},
year = {2005},
month = {02},
date = {2005-02},
journal = {Building Services Engineering Research and Technology},
pages = {49--61},
volume = {26},
number = {1},
doi = {10/b4z2gp},
url = {http://journals.sagepub.com/doi/10.1191/0143624405bt112oa},
note = {00410},
langid = {en}
}

@article{wickham2014,
title = {Tidy Data},
author = {Wickham, Hadley},
year = {2014},
month = {09},
date = {2014-09-12},
journal = {Journal of Statistical Software},
pages = {1--23},
volume = {59},
number = {1},
doi = {10.18637/jss.v059.i10},
url = {https://www.jstatsoft.org/index.php/jss/article/view/v059i10},
note = {00558
tex.ids: wickhamTidyData2014
number: 1},
langid = {en}
}

@article{jia2021,
title = {eplusr: A framework for integrating building energy simulation and data-driven analytics},
author = {Jia, Hongyuan and Chong, Adrian},
year = {2021},
month = {04},
date = {2021-04},
journal = {Energy and Buildings},
pages = {110757},
volume = {237},
doi = {10.1016/j.enbuild.2021.110757},
url = {https://linkinghub.elsevier.com/retrieve/pii/S0378778821000414},
note = {00000
tex.ids= jia2021},
langid = {en}
}

@techreport{ipcc2021,
title = {Climate Change 2021: The Physical Science Basis. Contribution of Working Group I to the Sixth Assessment Report of the Intergovernmental Panel on Climate Change},
author = {IPCC, },
year = {2021},
date = {2021},
url = {https://www.ipcc.ch/report/ar6/wg1/},
note = {00000},
address = {U.K.},
langid = {English}
}

@inproceedings{remund2020,
title = {38th European Photovoltaic Solar Energy Conference and Exhibition},
author = {Remund, Jan and {Müller}, Stefan and Schmutz, Michael and Graf, Pascal},
year = {2020},
month = {09},
date = {2020-09-07},
url = {https://meteonorm.com/assets/publications/5BV.3.8_pvsec_2020_mn8.pdf},
note = {00000},
address = {Lisbon, Portugal}
}
Loading

0 comments on commit 86f058a

Please sign in to comment.