feat: training course for Hycar/Hydro 30 september 2021

Formation_airGRiwrm.Rproj

@@ -14,3 +14,5 @@ LaTeX: pdfLaTeX
 
 AutoAppendNewline: Yes
 StripTrailingWhitespace: Yes
+
+SpellingDictionary: fr_FR

README.md

+# Formation au package airGRiwrm
+
+## Installation des packages pour les apprenants
+
+L'installation a été testée pour les versions de R supérieures ou égales à 3.6.
+
+### Pour les utilisateurs sous Linux ou sous Windows avec Rtools
+
+Vous pouvez alors installer airGR en compilant les sources, il suffit de taper la commande suivante :
+
+```r
+install.packages("remotes")
+remotes::install_gitlab("in-wop/airGRiwrm", host = "gitlab.irstea.fr", dependencies = TRUE)
+```
+
+### Pour les utilisateurs sous Windows sans Rtools
+
+Installer les dépendances nécessaires à airGRiwrm pour la formation :
+
+```r
+install.packages(c("dplyr", "DiagrammeR"))
+```
+
+Télécharger les fichiers suivants :
+
+- https://stratus.irstea.fr/d/3e3e85e50ff8483d9d79/files/?p=/airGR_1.6.12.9000.zip&dl=1
+- https://stratus.irstea.fr/d/3e3e85e50ff8483d9d79/files/?p=/airGRiwrm_0.5.0.9000.zip&dl=1
+
+Installer les deux packages sous R avec les lignes de commande suivantes :
+
+```r
+install.packages("[Chemin du fichier téléchargé]/airGR_1.6.12.9000.zip")
+install.packages("[Chemin du fichier téléchargé]/airGRiwrm_0.5.0.9000.zip")
+```
+
+### Vérification de l'installation
+
+Taper les instructions dans la ligne de commande:
+
+```r
+library(airGRiwrm)
+example("RunModel.GRiwrmInputsModel")
+```
+
+L'exécution doit se dérouler sans erreur avec l'affichage de 3 graphiques. Seuls quelques warnings apparaîtront concernant la période de warm-up indéfinie et éventuellement la version de airGR compilée avec une version différente de votre version de R. Si l'exécution provoque une erreur, contactez-moi sur david.dorchies@inrae.fr.
+
+## Installation des packages pour le formateur
+
+Installer les dépendances de la présentation :
+
+```r
+install.packages("xaringan", "pagedown")
+remotes::install_github("gadenbuie/xaringanExtra")
+```
+
+## Génération de la présentation au formats HTML et PDF
+
+Le knit de la présentation sous Rstudio génère un document HTML et un PDF.
+
+Pour être utilisé à un autre emplacement, le fichier HTML doit être accompagné des dossiers Formation_airGRiwrm_files, img, libs, styles et du fichier macro.js.
+
+### Problèmes connus
+
+Les HTMLwidgets dans le PDF sont aléatoirement présents (ici les schémas de réseau). C'est un problème connus du package **pagedown** (Voir https://github.com/rstudio/pagedown/issues/58).