Home

Awesome

<!-- badges: start -->

build test_coverage docs codecov Github All Releases DOI DOI

<!-- badges: end --> <!-- ------------------------> <!-- ------------------------>

<a name="Introduction"></a>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.

<br> <p align="center"> <a href="https://jgcri.github.io/helios/" target="_blank"><img src="https://github.com/JGCRI/jgcricolors/blob/main/vignettes/button_user_guide.PNG?raw=true" alt="https://jgcri.github.io/helios/" height="60"/></a> <img src="https://github.com/JGCRI/jgcricolors/blob/main/vignettes/button_divider.PNG?raw=true" height="40"/> </p> <!-- ------------------------> <!-- ------------------------>

<a name="Citation"></a>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

<!-- ------------------------> <!-- ------------------------>

<a name="InstallGuide"></a>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
<br> <!-- ------------------------> <!-- ------------------------>

<a name="GettingStarted"></a>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:

<!-- ------------------------> <!-- ------------------------>

<a name="Publications"></a>Related Publications

<!-- ------------------------> <!-- ------------------------> <!-- ------------------------> <!-- ------------------------>

<a name="Contributing"></a>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.