https://github.com/rte-antares-rpackage/antaresadequacypatch
https://github.com/rte-antares-rpackage/antaresadequacypatch
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rte-antares-rpackage/antaresadequacypatch
- Owner: rte-antares-rpackage
- License: gpl-3.0
- Created: 2021-01-25T10:07:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T11:55:51.000Z (almost 2 years ago)
- Last Synced: 2025-01-31T06:48:04.866Z (4 months ago)
- Language: R
- Size: 10.4 MB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# antaresAdequacyPatch
## Installation
To install the last development version:
```r
devtools::install_github("rte-antares-rpackage/antaresAdequacyPatch")
```
To display the help of the package and see all the functions it provides, use:
```r
help(package="antaresAdequacyPatch")
```
## Notice d'utilisation
Attention, pour que ce package fonctionne vous devez au préalable installer AMPL et Xpress sur votre ordinateur.
### L'utilisation de la fonction `run_adq`
La fonction principale est nommée `run_adq` et permet de lancer l'adequacy patch sur une étude Antares.
La fonction accepte 8 arguments :
* opts
* areas : Areas concernées par l'adquacy patch.
* virtual_areas : Plus utilisé aujourd'hui (à supprimer)
* mcYears : mcYears sur lesquelles appliquer le traitement.
* antaresfbzone : Nom de la zone flow-based
* ext : Nom de l'output pour la sortie après adequacy, si NULL, la sortie sera écrasée
* nbcl : Nombre de coeurs de calcul
* thresholdFilter : Filtre des résultats (seuil après lequel les modifications deviennent trop importantes pour un pas de temps donné)
```{r, eval=FALSE}
library(AdequacyPatch)
opts <- setSimulationPath("myoutputstudy")
areas <- c("fr", "at", "be", "de", "nl", "es", "ukgb", "ch", "ie", "itn", "model_description_fb")
virtual_areas = getAreas(select = "_", regexpSelect = TRUE,
exclude = c("model_description_fb"), regexpExclude = FALSE)
run_adq(opts = opts,
areas = areas,
virtual_areas = virtual_areas,
mcYears = "all",
antaresfbzone = "model_description_fb",
ext = 'adq',
nbcl = 8, thresholdFilter = 100)
```