To install the last development version:
devtools::install_github("rte-antares-rpackage/antaresAdequacyPatch")To display the help of the package and see all the functions it provides, use:
help(package="antaresAdequacyPatch")Attention, pour que ce package fonctionne vous devez au préalable installer AMPL et Xpress sur votre ordinateur.
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é)
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)