WSL/SLF GitLab Repository

Skip to content
Snippets Groups Projects
Commit 4420908a authored by Adrien Michel's avatar Adrien Michel
Browse files

Added online installation instruction and not for MacOS users, imporved formating

parent 9c3b7f27
No related branches found
No related tags found
No related merge requests found
......@@ -5,33 +5,64 @@ SnowQM is an `R` library for correcting snow water equivalent (SWE) grids, calle
For more details, see the package vignette and Michel, A., Aschauer, J., Jonas, T., Gubler, S., Kotlarski, S., and Marty, C.: SnowQM 1.0: A fast R Package for bias-correcting spatial fields of snow water equivalent using quantile mapping, Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2022-298, in review, 2023
# Installation
> Note for MacOS users:
> see instruction here about how to enable OpenMP https://github.com/Rdatatable/data.table/issues/5419
###Online installation:
If not already installed, install the `devtools` library:
```
install.packages("devtools")
```
Install SnowQM:
```
devtools::install_git("https://code.wsl.ch/snow-hydrology/snowqm", build_vignettes = TRUE)
```
###Locale installation:
Download the package, then navigate to the package from within `R`:
```
setwd(".../SnowQM")
setwd("[...]/SnowQM")
```
If not already installed, install the `devtools` library:
```
install.packages("devtools")
```
Install SnowQM:
```
devtools::install(build_vignettes = TRUE)
```
# Usage
After installation, restart your `R` environment. Then load snowQM using:
```
library(SnowQM)
```
Display the documentation summary using:
```
help(package = 'SnowQM')
```
Use the vignette for a step-by-step example:
```
vignette(package = "SnowQM","snowqm")
```
# Author
Adrien Michel, 2022 (WSL/SLF and MeteoSwiss)
Adrien Michel, 2023 (WSL/SLF and MeteoSwiss)
# Citation
Michel et al. (2022), SnowQM 1.0: A fast R Package for bias-correcting spatial fields of
Michel et al. (2023), SnowQM 1.0: A fast R Package for bias-correcting spatial fields of
snow water equivalent using quantile mapping, GMD, under review
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment