Le paquet rvle. Utilisation d un simulateur VLE, sous R. Patrick Chabrier, Hélène Raynal, Ronan Trepos 1, Gauthier Quesnel 2

Transcription

1 Le paquet rvle Utilisation d un simulateur VLE, sous R. Patrick Chabrier, Hélène Raynal, Ronan Trepos 1, Gauthier Quesnel 2 1. Equipe RECORD, U-MIA-T, INRA Toulouse 2. Equipe MAD, U-MIA-T, INRA Toulouse () rvle 1 / 32

2 Plan 1 Introduction 2 Utilisation de rvle dans une session R 3 Récapitulatif des méthodes disponibles dans le paquet rvle 4 Conclusion () rvle 2 / 32

3 Plan 1 Introduction 2 Utilisation de rvle dans une session R 3 Récapitulatif des méthodes disponibles dans le paquet rvle 4 Conclusion () rvle 3 / 32

4 RVLE Définition RVLE est un paquet pour le logiciel R, comparable aux paquets disponibles sur le cran de R. Il permet la communication entre R et VLE. Il utilise une communication traditionnelle pour R, c-à-d, via une bibliothèque dynamique : portabilité, efficacité () rvle 4 / 32

5 RVLE Fonctionnalités Il permet depuis une session R de: lire des fichiers vpz (simulateurs développés sous VLE) modifier les conditions initiales et les paramètres des simulateurs et le cas échéant les sauvegarder dans le simulateur. modifier la durée de simulation, la valeur de la graine ( seed ) si le simulateur est de type stochastique lancer des simulations récupérer les résultats de la simulation sous forme d objet R : matrices ou dataframes Pour que le simulateur sous VLE puisse échanger avec R directement en mémoire, il faut travailler obligatoirement avec une vue de sortie de type Storage. La notion de vue est décrite dans l apprentissage de VLE. () rvle 5 / 32

6 RVLE Installation (après avoir installé le logiciel R) Installation sous Linux: wget sourceforge.net/projects/vle/files /1.0/1.0.3/ rvle_1 tar xvfz rvle_ tar.gz sudo R CMD INSTALL rvle () rvle 6 / 32

7 RVLE Installation (après avoir installé le logiciel R) Installation sous Windows: Ajouter aux variables d environnement de WINDOWS, la variable VLE HOME avec comme valeur c:\ documents and settings\user\vle (remplacer user par votre nom de login). Attention 1/ le répertoire doit exister. Attention 2/ VLE doit être dans la variable d environnement PATH. Attention 3/ Au moment de l installation de VLE, il faut avoir choisi add VLE to the system PATH for all users. Télécharger le paquet (attention il faut avoir aussi installé le paquet Runit disponible sur le CRAN de R) sourceforge.net/projects/vle/files /1.0/1.0.3/ rvle_1 installer le paquet dans une session R via le menu de l interface graphique R. () rvle 7 / 32

8 Plan 1 Introduction 2 Utilisation de rvle dans une session R 3 Récapitulatif des méthodes disponibles dans le paquet rvle 4 Conclusion () rvle 8 / 32

9 rvle Préalable Installer et compiler les paquets contenant les modèles (simulateurs) que vous souhaitez utiliser depuis R, en utilisant l interface graphique gvle. Confer cours 2.3 du module 2 disponible sur le site de elearning (authentification ldap nécessaire): record - elearning.inra.fr () rvle 9 / 32

10 rvle Une session R utilisant rvle Chargement de la bibliothèque rvle & accès à la documentation. > library(rvle) > help(rvle) # help(rvle) help("rvle-handle") > magarey <- new("rvle", pkg = "Magarey", "file = "magarey.vpz") > magarey <- rvle.open(pkg = "Magarey", "file = "magarey.vpz") > show(magarey)... Experimental Condition list and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotaniqu * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 7 <double> * cond_de_magarey.topt = 18 <double> * cond_de_magarey.wmax = 42 <double> * cond_de_magarey.wmin = 10 <double> > resmagarey <- run(magarey) () rvle 10 / 32

11 rvle Une session R utilisant rvle Chargement du simulateur dans la session R. (simulateur magarey.vpz dans le paquet Magarey) > library(rvle) > help(rvle) # help(rvle) help("rvle-handle") > magarey <- new("rvle", pkg = "Magarey", "file = "magarey.vpz") > magarey <- rvle.open(pkg = "Magarey", "file = "magarey.vpz") > show(magarey)... Experimental Condition list and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotaniqu * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 7 <double> * cond_de_magarey.topt = 18 <double> * cond_de_magarey.wmax = 42 <double> * cond_de_magarey.wmin = 10 <double> > resmagarey <- run(magarey) () rvle 10 / 32

12 rvle Une session R utilisant rvle Visualisation des caratéristiques du simulateur > library(rvle) > help(rvle) # help(rvle) help("rvle-handle") > magarey <- new("rvle", pkg = "Magarey", "file = "magarey.vpz") > magarey <- rvle.open(pkg = "Magarey", "file = "magarey.vpz") > show(magarey)... Experimental Condition list and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotaniqu * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 7 <double> * cond_de_magarey.topt = 18 <double> * cond_de_magarey.wmax = 42 <double> * cond_de_magarey.wmin = 10 <double> > resmagarey <- run(magarey) () rvle 10 / 32

13 rvle Une session R utilisant rvle Lancement du simulateur > library(rvle) > help(rvle) # help(rvle) help("rvle-handle") > magarey <- new("rvle", pkg = "Magarey", "file = "magarey.vpz") > magarey <- rvle.open(pkg = "Magarey", "file = "magarey.vpz") > show(magarey)... Experimental Condition list and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotaniqu * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 7 <double> * cond_de_magarey.topt = 18 <double> * cond_de_magarey.wmax = 42 <double> * cond_de_magarey.wmin = 10 <double> > resmagarey <- run(magarey) () rvle 10 / 32

14 rvle Une session R utilisant rvle Lancement du simulateur > resmagarey <- run(magarey) > results(resmagarey) [[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , , , ,3... > str(results(resmagarey)) List of 1..$ : data.frame : 361 obs. of 5 variables:..$ time : num [1:361] $ Top model:magarey.w : num [1:361] 0,0 29,7 39,2 29,7 20,3.....$ Top model:meteo.day : num [1:361] $ Top model:meteo.t : num [1:361] 11,5 8,8 8,3 8,8 9,9 7,8 7,2 8,3 6,8 6,..$ Top model:meteo.year: num [1:361] > plot(results(resmagarey)[[1]]$time, results(resmagarey)[[1]]$"top model:magarey.w", pch="+", xlab=c("time"),ylab=c("w") ) () rvle 11 / 32

15 rvle Une session R utilisant rvle Affichage des résultats de simulation > resmagarey <- run(magarey) > results(resmagarey) [[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , , , ,3... > str(results(resmagarey)) List of 1..$ : data.frame : 361 obs. of 5 variables:..$ time : num [1:361] $ Top model:magarey.w : num [1:361] 0,0 29,7 39,2 29,7 20,3.....$ Top model:meteo.day : num [1:361] $ Top model:meteo.t : num [1:361] 11,5 8,8 8,3 8,8 9,9 7,8 7,2 8,3 6,8 6,..$ Top model:meteo.year: num [1:361] > plot(results(resmagarey)[[1]]$time, results(resmagarey)[[1]]$"top model:magarey.w", pch="+", xlab=c("time"),ylab=c("w") ) () rvle 11 / 32

16 rvle Une session R utilisant rvle Affichage des résultats de simulation sous forme réduite > resmagarey <- run(magarey) > results(resmagarey) [[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , , , ,3... > str(results(resmagarey)) List of 1..$ : data.frame : 361 obs. of 5 variables:..$ time : num [1:361] $ Top model:magarey.w : num [1:361] 0,0 29,7 39,2 29,7 20,3.....$ Top model:meteo.day : num [1:361] $ Top model:meteo.t : num [1:361] 11,5 8,8 8,3 8,8 9,9 7,8 7,2 8,3 6,8 6,..$ Top model:meteo.year: num [1:361] > plot(results(resmagarey)[[1]]$time, results(resmagarey)[[1]]$"top model:magarey.w", pch="+", xlab=c("time"),ylab=c("w") ) () rvle 11 / 32

17 rvle Une session R utilisant rvle Exploitation des résultats > resmagarey <- run(magarey) > results(resmagarey) [[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , , , ,3... > str(results(resmagarey)) List of 1..$ : data.frame : 361 obs. of 5 variables:..$ time : num [1:361] $ Top model:magarey.w : num [1:361] 0,0 29,7 39,2 29,7 20,3.....$ Top model:meteo.day : num [1:361] $ Top model:meteo.t : num [1:361] 11,5 8,8 8,3 8,8 9,9 7,8 7,2 8,3 6,8 6,..$ Top model:meteo.year: num [1:361] > plot(results(resmagarey)[[1]]$time, results(resmagarey)[[1]]$"top model:magarey.w", pch="+", xlab=c("time"),ylab=c("w") ) () rvle 11 / 32

18 rvle Une session R utilisant rvle Truc: Renommer le nom des colonnes du dataframe resmagarey2 <- results(resmagarey)[[1]] names(resmagarey2) <- c("time","w","day","t","year") plot(resmagarey2$time,resmagarey2$w, pch="*", xlab=c("time"),ylab=c("w")) () rvle 12 / 32

19 rvle Une session R utilisant rvle Lancement du simulateur en changeant les conditions (données d entrée) > resmagarey3 <- run(magarey, cond_de_magarey.tmax = 25, cond_de_magarey.tmin =5) > par(new=true) > resmagarey4 <- results(resmagarey3)[[1]] > names(resmagarey4) <- c("time","w","day","t","year") > plot(resmagarey4$time, resmagarey4$w, xlab=c("time"),ylab=c("w"), col=c( blue ) ) () rvle 13 / 32

20 rvle Une session R utilisant rvle Exploitation des résultats- Superposition à la courbe précédente > resmagarey3 <- run(magarey, cond_de_magarey.tmax = 25, cond_de_magarey.tmin =5) > par(new=true) > resmagarey4 <- results(resmagarey3)[[1]] > names(resmagarey4) <- c("time","w","day","t","year") > plot(resmagarey4$time, resmagarey4$w, xlab=c("time"),ylab=c("w"), col=c( blue ) ) () rvle 13 / 32

21 rvle Une session R utilisant rvle Sauvegarder un simulateur dont on a modifié les données d entrée, des paramètres... > savevpz(resmagarey3, file = "magareyv2.vpz") > #dans le répertoire output du paquet Magarey () rvle 14 / 32

22 rvle Une session R utilisant rvle Le simulateur est sauvegardé dans le répertoire output du paquet projet VLE (Magarey) > savevpz(resmagarey3, file = "magareyv2.vpz") > #dans le répertoire output du paquet Magarey () rvle 14 / 32

23 Plan 1 Introduction 2 Utilisation de rvle dans une session R 3 Récapitulatif des méthodes disponibles dans le paquet rvle 4 Conclusion () rvle 15 / 32

24 RVLE Objet Récapitulatif des méthodes Charger un simulateur (ficier vpz) depuis un paquet projet VLE > monsim <- new("rvle", pkg = " monpaquet", file = "sim.vpz") > monsim <- new("rvle", file = "sim.vpz") > monsim <- rvle.open,pkg = " monpaquet", file = "sim.vpz") #ancienne syntaxe new Rvle est la classe objet qui va être utilisée pour instantier le simulateur. La commande permet soit de charger : un simulateur au sein d un paquet VLE, et le chemin du simulateur sera relatif a celui du répertoire exp du paquet. un simulateur global, et dans ce cas le chemin du simulateur devra être complet. () rvle 16 / 32

25 RVLE Objet Récapitulatif des méthodes Sauvegarder un simulateur > savevpz(monsim, file = " unautresim.vpz") savevpz La commande permet de sauvegarder les conditions expérimentales et la configuration de la dernière simulation dans le paquet VLE Si le chemin du fichier dans lequel le simulateur est à sauvegarder est incomplet, la sauvegarde a lieu dans le répertoire output. Remarque Travailler directement dans le répertoire output, permet d utiliser le système de persistance natif d une session R(.Rdata,.Rprofile). La session vle n est pas persistante, il est nécessaire de recharger le vpz. () rvle 17 / 32

26 RVLE Récapitulatif des méthodes Afficher les caractéristiques du simulateur > show(monsim) > show(magarey) #exemple de résultat obtenu pour le simulateur magarey VLE Model informations : ======================== Vpz location : file = magarey.vpz, pkg = Magarey Experiemental condition settings and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotanique.csv * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 30 <double> *... * cond_de_magarey.mode = port <character> * cond_de_magarey.time-step = 1 <double> show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique particulière () rvle 18 / 32

27 RVLE Récapitulatif des méthodes Les premières caractéristiques affichées: les conditions expérimentales (paramètres et données d entrée du modèle) > show(monsim) > show(magarey) #exemple de résultat obtenu pour le simulateur magarey VLE Model informations : ======================== Vpz location : file = magarey.vpz, pkg = Magarey Experiemental condition settings and default value : * COND_MeteoNomFichier.meteo_file = weather_montpellier_france_jardinbotanique.csv * cond_de_magarey.tmax = 30 <double> * cond_de_magarey.tmin = 30 <double> *... * cond_de_magarey.mode = port <character> * cond_de_magarey.time-step = 1 <double> show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique () particulière rvle 18 / 32

28 RVLE Récapitulatif des méthodes (suite) Les premières caractéristiques affichées: les conditions expérimentales (paramètres et données d entrée du modèle * zcondmeteo.begin = 16 <integer> * zcondmeteo.column_separator = <character> * zcondmeteo.columns = Experimental Condition not managed * zcondmeteo.mode = name <character> * zcondmeteo.time-step = Experimental Condition not managed * zcondmeteo.variables = Experimental Condition not managed show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique particulière () rvle 19 / 32

29 RVLE Récapitulatif des méthodes Afficher les caractéristiques concernant les vues (les sorties) * Output plugins settings: * vueall = storage * Experiment settings : * plan = single * proc = mono * restype = dataframe * thread = 1 * replicas = 1 * begin : 0 * duration : 360 * seed : show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique particulière () rvle 20 / 32

30 RVLE Récapitulatif des méthodes Afficher les caractéristiques concernant le plan d expérience * Output plugins settings: * vueall = storage * Experiment settings : * plan = single * proc = mono * restype = dataframe * thread = 1 * replicas = 1 * begin : 0 * duration : 360 * seed : show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique particulière () rvle 20 / 32

31 RVLE Récapitulatif des méthodes Afficher une seule caractéristique #afficher la valeur du paramètre param1 de la condition expérimentale Condit * getdefault(monsim, "Condition1.param1") * getdefault(monsim, "Condition2.param1") #afficher le type de la sortie * getdefault(monsim,"outputplugin") #afficher la durée de la simulation * getdefault(monsim, "duration") #afficher le type de plan d expérience * getdefault(monsim, "plan") show ou getdefault Afficher l ensemble des caractéristiques du simulateur ou une caractéristique particulière () rvle 21 / 32

32 RVLE Objet Récapitulatif des méthodes Lancer une simulation # avec les conditions expérimentales de la configuration d origine > monsim <- run(monsim) # en changeant les paramètres > monsim <- run(monsim,..., cond1.p1 = v1, cond2.p1 = v2,...) # en changeant la durée, la graine, et le début > monsim <- run(monsim, seed = L, duration = 20, begin = 111)) run La commande restitue le simulateur après simulation, et l affecter ( ) permet de le conserver, notamment de conserver les résultats et les paramètres. Un paramètre qui n est pas explicitement utilisé, l est implicitement avec les valeurs pas défaut, celles qui sont dans le fichier.vpz ou celles modifiées par setdefault. () rvle 22 / 32

33 RVLE Objet Récapitulatif des méthodes Configurer le simulateur avant de lancer la simulation # Exemple concernant "Experimental condition settings and default value" > monsim <- setdefault(monsim, cond1.param1 = value1 # Exemple concernant "Output plugins settings" # le type de sortie > monsim <- setdefault(monsim, outputplugin = c(myview = "storage")) # Exemple concernant "Experiment settings" # la duree de simulation > monsim <- setdefault(monsim, duration =10) setdefault L ensemble des conditions accessibles par la commande show(...) peut être modifié Remarque: La liste outputplugin permet de changer le type de sortie. storage est la sortie en mémoire exploitable directement par rvle. () rvle 23 / 32

34 RVLE Objet Récapitulatif des méthodes Configurer le simulateur # le type de machine dont dispose VLE > monsim <- setdefault(monsim, proc = "mono") > monsim <- setdefault(monsim, proc = "thread") # le nombre de processeurs dont dispose VLE > monsim <- setdefault(monsim, thread = n) setdefault mode thread : Si on dispose d une machine multi-processeurs, il faut explicitement spécifier le nombre de processeurs. L option cluster permet d exploiter une grille de calcul distante. () rvle 24 / 32

35 RVLE Objet Récapitulatif des méthodes Exploiter les résultats d une simulation (hors contexte d un plan d expérience) > results(monsim) # Retourne une liste - Chaque élèment de la liste est associé à une vue du simulateur results(monsim )[[1]] # retourne les résultats associés à la 1ère vue du simulateur > results(monsim)[[i]]$"rtop:model.var" # Cas restype=dataframe: Retourne les valeurs pour l ensemble de la simulation, de la variable var, stockées dans la vue i > results(monsim )[[1]][d, v] # Cas restype=matrix: Retourne pour la vue i, les valeurs pour l ensemble de la simulation de la variable v, à la date d () rvle 25 / 32

36 RVLE Objet Récapitulatif des méthodes Focus sur lancer des simulations en utilisant un plan d expérience # - Plan d expérience de type linéaire # (les simulations vont tourner suivant 3 combinaisons de paramètres # (v1,v4) puis (v2,v5) puis (v3,v6)) # - Chaque simulation sera répliquée n fois # - Les résultats de chaque simulation seront disponibles sous la forme dataframe > run(monsim, cond1.param1=c(v1,v2,v3), cond2.param2=c(v4,v5,v6), plan = "linear", replicas = n, restype = " dataframe") run(..., plan=..., replicas=..., restype=...) plan= linear (ou single si pas de plan). Simulations vont tourner suivant les combinaisons ordonnées des valeurs de paramètre. replicas=n. Pour reproduire n fois la même simulation. (Intérêt limité aux modèles stochastiques). restype= dataframe ou matrix. Avoir les résultats d une simulation sous forme dataframe ou matrix. Les noms des colonnes du dataframe = noms tels que dans les sorties VLE. ( Ex: Top model:magarey.w (variable W, du modèle Magarey)) () rvle 26 / 32

37 RVLE Objet Récapitulatif des méthodes Focus sur exploiter des résultats de simulation générés par un plan d expérience > resmonsim <- run(monsim, cond1.param1=c(v1,v2,v3), cond2.param2=c(v4,v5, plan = "linear", replicas = n, restype = " dataframe") Les résultats se présentent sous la forme d une matrice de dimension Nreplicas X Ncombinaisons avec Nreplicas le nb de réplicas spécifiés dans le plan, et Ncombinaisons le nombre de combinaisons du plan. Un élément de cette matrice est une liste d éléments de longueur égale au nombre de vues Un élément de cette liste correspond au dataframe (ou matrice si restype est de type matrix) Le dataframe contient les résultats d une simulation. En colonne, les variables de sortie, en ligne, leur valeur à chaque pas de temps de la simulation. () rvle 27 / 32

38 RVLE Objet Récapitulatif des méthodes Focus (suite) - Exemple d analyse de structure du résultat > resmagarey4 <- run(magarey, cond_de_magarey.tmax = c(24,25), cond_de_magarey.tmin =c(5,6), plan="linear", restype=" dat # 1er niveau: Matrice avec en col les combinaisons du plan, en lig les réplicats > results( resmagarey4) [,1] [,2] [1,] List,2 List,2 # 2ème niveau: L élèment [1,1] (item du plan (24,25, 1er réplicat) = Une liste - # Chaque élèment est associe à une vue (si plusieurs vues dans le simulateur) > results( resmagarey4 )[1,1][[1]] [[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , ,8... # 3ème niveau: Un élèment de la liste = dataframe associé à la vue > results(resmagarey4 )[1,1][[1]][[1]] time Top model:magarey.w Top model:meteo.day Top model:meteo.t 0 0 0, , , ,8... > results( resmagarey4 )[1,1][[1]][[1]]$"Top model:magarey.w" () rvle 28 / 32

39 RVLE Objet Récapitulatif des méthodes Exploiter les résultats # toutes les observations > mesres <- results(monsim) # en mode dataframe, les valeurs d une variable, pour l observation i > mesres[[i]][, "rtop:model.var"] # ou mesres$unevue[, "rtop:model.var"] # en mode matrix, les valeurs de la variable v, pour l observation i # à la date d > mesres[[i]][d, v] # pour le replica m et la comninaison n en mode plan > mesres[m, n][[i]][,"top:model.var"] # pour le replica m et la combinaison n en mode plan > mesres[m, n][[i]][d, v] results La commande retourne, en fonction de la configuration, des listes de matrices ou des listes de dataframes. + matrice en mode plan. la commande str est très utile pour visualiser la structure du résultat. () rvle 29 / 32

40 Plan 1 Introduction 2 Utilisation de rvle dans une session R 3 Récapitulatif des méthodes disponibles dans le paquet rvle 4 Conclusion () rvle 30 / 32

41 RVLE conclusion Le paquet RVLE constitue une application importante pour l analyse des modèles. beneficiera de nouvelles fonctions pour aider les manipulations de modèles. À vous aussi de les proposer :-) Une alternative pyvle, un paquet pour le langage de programmation python avec la même philosophie que RVLE. () rvle 31 / 32

42 RVLE conclusion Le paquet RVLE constitue une application importante pour l analyse des modèles. beneficiera de nouvelles fonctions pour aider les manipulations de modèles. À vous aussi de les proposer :-) Une alternative pyvle, un paquet pour le langage de programmation python avec la même philosophie que RVLE. () rvle 31 / 32

43 RVLE Objet Auteurs Gauthier Quesnel Patrick Chabrier Ronan Trepos Hélène Raynal Licence Copyright (C) INRA - LIL Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License. () rvle 32 / 32