Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dhia-gharsallaoui/watervalues

Calculate water values for Antares simulator
https://github.com/dhia-gharsallaoui/watervalues

bellman dynamic-programming energy rpackage shiny-apps simulator

Last synced: about 3 hours ago
JSON representation

Calculate water values for Antares simulator

Awesome Lists containing this project

README

        

[![R](https://github.com/dhia-gharsallaoui/watervalues/actions/workflows/r.yaml/badge.svg)](https://github.com/dhia-gharsallaoui/watervalues/actions/workflows/r.yaml)
[![R Package Validation report](https://github.com/dhia-gharsallaoui/watervalues/actions/workflows/Validation_report.yml/badge.svg?branch=main)](https://github.com/dhia-gharsallaoui/watervalues/actions/workflows/Validation_report.yml)


# Watervalues

The R package watervalues allows to :
1. Prepare the Antares study by creating the fictive area,
2. Launch the simulations by updating the coupling constraints,
3. Read the results
4. Calculate the water values

## Install package

You can install the package from [GitHub](https://github.com/) with:

```r
# install.packages("devtools")
devtools::install_github("dhia-gharsallaoui/watervalues", build_vignettes = TRUE)
```

To install all the package dependencies you can run the script `inst/dependencies.R`

## Load the package
```{r Load the package, eval=TRUE}
library(watervalues)
```

Now we are ready to use our package.

```r
shiny_water_values()
```

![tutorial](https://github.com/dhia-gharsallaoui/watervalues/blob/main/vignettes/images/calculate%20water%20values.gif?raw=true)