Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

helios

An R package to process heating and cooling degrees for the Global Change Analysis Model (GCAM) from various sources such as WRF and CMIP.
https://github.com/JGCRI/helios

Category: Climate Change
Sub Category: Earth and Climate Modeling

Keywords from Contributors

climate multi-scale multi-sector nexus hydrology gcam gcims

Last synced: about 20 hours ago
JSON representation

Repository metadata

Heating and Cooling Degree processing for GCAM from various sources such as WRF and CMIP

README.md

R-CMD-check
test_coverage
docs
codecov
DOI
DOI

Introduction

helios is an R package to process heating and cooling degrees for the Global Change Analysis Model (GCAM) from various sources such as WRF and CMIP.

Citation

Zhao, M., Khan, Z., Dorheim, K., Vernon, C., (2024). helios: An R package to process heating and cooling degrees for GCAM. Journal of Open Source Software, 9(94), 6033, https://doi.org/10.21105/joss.06033

Installation Guide

  1. Download and install:

  2. Open R studio:

install.packages("devtools")
devtools::install_github("JGCRI/helios")

or

install.packages("remotes")
remotes::install_github("JGCRI/helios")

Additional steps for UBUNTU from a terminal

sudo add-apt-repository ppa:ubuntugis/ppa
sudo apt-get update
sudo apt-get install libudunits2-dev libgdal-dev libgeos-dev libproj-dev libmagick++-dev

Additional steps for MACOSX from a terminal

brew install pkg-config
brew install gdal

Getting Started

helios is an R package that calculates heating and cooling degrees using high temporal and spatial resolution of climate data and population data. helios currently supports WRF data and ISIMIP-CMIP data, or same format with any of them. For more details:

  • GCAM-Regions Tutorial introduces how to use helios to calculate heating and cooling degree-days for 32 global regions in GCAM.
  • GCAM-USA Tutorial introduces how to use helios to calculate heating and cooling degree-hours for CONUS in GCAM-USA.

Related Publications

  • Khan, Z., Iyer, G., Patel, P., Kim, S., Hejazi, M., Burleyson, C. and Wise, M., 2021. Impacts of long-term temperature change and variability on electricity investments. Nature communications, 12(1), pp.1-12.

Contributing

Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make helios more robust, you are welcome to contribute! The contributing page will walk you through processes to contribute to helios.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 125
Total Committers: 6
Avg Commits per committer: 20.833
Development Distribution Score (DDS): 0.224

Commits in past year: 24
Committers in past year: 3
Avg Commits per committer in past year: 8.0
Development Distribution Score (DDS) in past year: 0.083

Name Email Commits
Mengqi Zhao m****z@u****u 97
Zarrar Khan z****n@p****v 23
zarrarkhan k****n@g****m 2
crvernon c****n@g****m 1
Sergio Ibarra Espinosa z****a@g****m 1
Hugo Ledoux h****x@t****l 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 5
Total pull requests: 15
Average time to close issues: 12 days
Average time to close pull requests: about 22 hours
Total issue authors: 1
Total pull request authors: 5
Average comments per issue: 2.8
Average comments per pull request: 0.13
Merged pull request: 15
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: about 14 hours
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 1.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/JGCRI/helios

Top Issue Authors

  • ibarraespinosa (5)

Top Pull Request Authors

  • mengqi-z (11)
  • ibarraespinosa (1)
  • crvernon (1)
  • hugoledoux (1)
  • zarrarkhan (1)

Top Issue Labels

Top Pull Request Labels

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • RColorBrewer * imports
  • data.table * imports
  • dplyr * imports
  • gcamdata * imports
  • ggplot2 * imports
  • knitr * imports
  • lubridate * imports
  • magrittr * imports
  • markdown * imports
  • ncdf4 * imports
  • raster * imports
  • tibble * imports
  • tidyr * imports
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/build.yml actions
  • actions/cache v1 composite
  • actions/checkout v1 composite
  • r-lib/actions/setup-pandoc v2-branch composite
  • r-lib/actions/setup-r v2-branch composite
  • r-lib/actions/setup-tinytex v2-branch composite
.github/workflows/docs.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/test_coverage.yml actions
  • actions/checkout v1 composite
  • r-lib/actions/setup-pandoc v2-branch composite
  • r-lib/actions/setup-r v2-branch composite
  • r-lib/actions/setup-tinytex v2-branch composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • openjournals/openjournals-draft-action master composite

Score: 2.8903717578961645