Data

Tools

Indexes

Applications

Experiments

Open Source Science

helios

helios: An R package to process heating and cooling degrees for GCAM - Published in JOSS (2024)

https://github.com/jgcri/helios

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    3 of 6 committers (50.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization jgcri has institutional domain (www.pnnl.gov)
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

gcam gcims

Scientific Fields

Engineering Computer Science - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 3
  • Watchers: 4
  • Forks: 2
  • Open Issues: 0
  • Releases: 3
Created over 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing License

README.md

R-CMD-check test_coverage docs codecov DOI DOI <!-- badges: end -->

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.


https://jgcri.github.io/helios/

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:

    • R (https://www.r-project.org/)
    • R studio (https://www.rstudio.com/)

  2. Open R studio:

r install.packages("devtools") devtools::install_github("JGCRI/helios") or r 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

  • Name: Joint Global Change Research Institute
  • Login: JGCRI
  • Kind: organization
  • Location: College Park, MD, USA

Advancing fundamental understanding of human and Earth systems

JOSS Publication

helios: An R package to process heating and cooling degrees for GCAM
Published
February 22, 2024
DOI
Volume 9, Issue 94, Page 6033
Authors
Mengqi Zhao ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Zarrar Khan ORCID
Joint Global Change Research Institute, Pacific Northwest National Laboratory, College Park, MD, USA
Kalyn Dorheim ORCID
Joint Global Change Research Institute, Pacific Northwest National Laboratory, College Park, MD, USA
Chris Vernon ORCID
Pacific Northwest National Laboratory, Richland, WA, USA
Editor
Hugo Ledoux ORCID
Tags
heating and cooling degree-hours and degree-days
View PDF Review Thread Software Archive

GitHub Events

Total
  • Release event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 5
  • Pull request event: 2
  • Create event: 2
Last Year
  • Release event: 1
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 5
  • Pull request event: 2
  • Create event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 125
  • Total Committers: 6
  • Avg Commits per committer: 20.833
  • Development Distribution Score (DDS): 0.224
Past Year
  • Commits: 24
  • Committers: 3
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.083
Top Committers
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 (Top 20 + Academic)
tudelft.nl: 1 pnnl.gov: 1 umd.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • 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: 4.67
  • Average comments per pull request: 0.13
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 14 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ibarraespinosa (3)
Pull Request Authors
  • mengqi-z (17)
  • ibarraespinosa (2)
  • hugoledoux (2)
  • zarrarkhan (1)
Top Labels
Issue Labels
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