Update english and create french version of tuto1

doc/users/Tuto1/pas-a-pas.tex

+%% LyX 2.0.2 created this file.  For more info, see http://www.lyx.org/.
+%% Do not edit unless you really know what you are doing.
+\documentclass[12pt,french]{article}
+\usepackage[T1]{fontenc}
+\usepackage[latin9]{inputenc}
+\usepackage{geometry}
+\geometry{verbose,tmargin=2cm,bmargin=2cm,lmargin=2cm,rmargin=2cm,headheight=2cm,headsep=2cm,footskip=2cm}
+\usepackage{textcomp}
+\usepackage{graphicx}
+\usepackage{hyperref}
+
+\makeatletter
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% LyX specific LaTeX commands.
+\newcommand{\noun}[1]{\textsc{#1}}
+%% Because html converters don't know tabularnewline
+\providecommand{\tabularnewline}{\\}
+
+\makeatother
+
+\usepackage{babel}
+\addto\extrasfrench{%
+   \providecommand{\og}{\leavevmode\flqq~}%
+   \providecommand{\fg}{\ifdim\lastskip>\z@\unskip\fi~\frqq}%
+}
+
+\begin{document}
+\includegraphics[width=5cm]{Logo-INRAE_Transparent.png}
+
+~
+
+~
+
+~
+
+\begin{center}
+Tutoriel pour Pamhyr2
+
+Janvier 2024
+\par\end{center}
+
+~
+
+~
+
+\begin{center}
+\textbf{\LARGE Modélisation 1D de la rivière  } \\
+\textbf{\LARGE Hogneau (Nord, France) avec Pamhyr2}
+\par\end{center}{\LARGE \par}
+
+~
+
+~
+
+\begin{center}
+{\large INRAE Lyon-Grenoble Auvergne-Rhône-Alpes}
+\par\end{center}{\large \par}
+
+\begin{center}
+RiverLy, Hydraulique des rivières
+\par\end{center}
+
+~
+
+~
+
+~
+
+~
+
+~
+
+~
+
+\begin{center}
+\begin{tabular}{lll}
+Autors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
+& Théophile TERRAZ & theophile.terraz@inrae.fr\tabularnewline
+& Lionel Pénard & lionel.penard@inrae.fr\tabularnewline
+\end{tabular}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+\begin{center}
+\tableofcontents{}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+\section{Introduction}
+
+TODO
+
+\pagebreak{}
+
+\section{Installer Pamhyr2}
+
+Pamhyr2 peut être téléchargé ici : \url{https://gitlab.irstea.fr/theophile.terraz/pamhyr}.
+\begin{center}
+\includegraphics[width=15cm]{dl.png}
+\par\end{center}
+
+Utilisez le bouton de téléchargement GNU Linux ou Windows en fonction de votre système. Sous Windows, lancez le programme d'installation. Sous Linux, décompressez l'archive et lancez Pamhyr2.
+
+
+\section{Créer une première étude}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Fichier] => [Nouvelle étude]} pour créer une nouvelle étude. Choisissez un nom, par exemple Hogneau, et validez
+
+Cliquez sur \texttt{[Réseau] => [Editer le réseau]} pour créer les biefs de votre rivière. Dans cette fenêtre, vous devez définir un graphe orienté qui représente les biefs de votre réseau fluvial : les arêtes sont les biefs et les n½uds sont soit des conditions limites amont, soit des conditions limites aval, soit des jonctions entre biefs.
+Appuyez sur le bouton \includegraphics[width=0.5cm]{gtk_add.png} pour entrer dans le mode \textit{Ajout}. Créez deux n½uds en cliquant dans la zone grise de la fenêtre, et créez un lien en cliquant à nouveau sur chaque n½ud. Appuyez à nouveau sur \includegraphics[width=0.5cm]{gtk_add.png} pour quitter le mode \textit{Ajout}. Vous avez créé votre premier bief, avec un n½ud amont et un n½ud aval. Dans la partie inférieure de la fenêtre \textit{Editer le réseau hydrographique}, vous pouvez renommer les n½uds et les biefs. Comme le bief que vous avez créé est automatiquement sélectionné, toutes les étapes suivantes s'appliqueront à ce bief. La fenêtre doit se présenter comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{network.png}
+\par\end{center}
+
+Fermer la fenêtre \textit{Editer le réseau}.
+
+
+\section{Editer la géometrie de la rivière}
+
+Cliquez sur \texttt{[Géometrie] => [Editer la géometrie]} pour définir la géométrie du bief sélectionné. Cliquez sur le bouton \texttt{[Importer]} et sélectionnez le fichier \texttt{Data/Bief\_1.st}. Vous devriez voir :
+
+\begin{center}
+\includegraphics[width=15cm]{Geo.png}
+\par\end{center}
+
+Le panneau de gauche contient une liste de toutes les sections en travers avec leur nom et leur abscisse longitudinale (PK). Dans le graphique en haut à gauche, vous pouvez voir la vue de dessus de la rivière, dans le panneau en haut à droite, la coupe longitudinale de la rivière et dans le graphique en bas, vous pouvez voir la section en travers sélectionnée (bleu) ainsi que la suivante (pointillés violets) et la précédente (pointillés noirs). Vous pouvez vous déplacer dans la liste des sections en cliquant dans le tableau ou à l'aide de l'ascenseur situé entre le tableau et les graphiques.
+
+Vous pouvez éditer la section en travers sélectionnée en cliquant sur l'icône \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}.
+
+Sélectionnez la section en travers nommée \textit{PontRD101m} et ouvrez la fenêtre d'édition. Vous devriez voir :
+\begin{center}
+\includegraphics[width=15cm]{editsect.png}
+\par\end{center}
+
+Sur le panneau de gauche se trouve la liste de tous les points de la section, avec leurs coordonnées, leur nom et leur abscisse transversale. La coordonnée Z du point le plus haut est inscrite en bleu et celle du point le plus bas en rouge. Les points peuvent avoir un nom. Si un point portant le même nom existe dans toutes les sections d'un bief, il forme une ligne longitudinale (ou ligne directrice). Par exemple, nous avons ici \textit{rg} et \textit{rd} qui représentent la rive gauche et la rive droite du lit mineur.
+
+Sur le graphique figure une projection de la section en travers. Vous pouvez utiliser \texttt{[ctrl + clic]} pour sélectionner un point dans le tracé et \texttt{[maj + clic]} pour sélectionner une ligne d'eau et visualiser des données géométriques utiles. Vous pouvez fermer la fenêtre d'édition de la section en travers et la fenêtre d'édition de la géométrie.
+
+\section{Editer les conditions aux limites}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Conditions aux limites et apports ponctuels]} :
+
+\begin{center}
+\includegraphics[width=15cm]{boundary.png}
+\par\end{center}
+
+ Utilisez le bouton \textit{ajouter} en haut à gauche de la fenêtre pour ajouter une condition limite pour le liquide.
+ Sur la nouvelle ligne, on peut cliquer pour sélectionner la ligne entière, et double-cliquer pour sélectionner la cellule.
+ Sélectionnez la cellule \textit{Type} pour donner un nom à la condition limite. Ici, nous définirons le débit mesuré lors de la crue de février 2002. Vous pouvez nommer cette condition limite "crue2002".
+ Sélectionner la cellule \textit{Type} et utiliser la combo box pour mettre une loi Q(t).
+ Sélectionnez la cellule \textit{Noeud} et attribuez cette condition au noeud amont.
+ Les noms des noeuds sont rappelés dans le réseau du panneau de droite.
+ Sélectionnez maintenant la ligne entière et cliquez sur le bouton d'édition \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}. Vous avez ouvert la fenêtre \textit{Éditer les conditions aux limites}.
+ Dans un éditeur de texte, ouvrez le fichier \texttt{Données/Fevrier\_2002.txt}. Copiez le contenu du fichier (par exemple avec \textit{ctrl+c}) et collez-le dans le panneau gauche de la fenêtre \textit{Éditer les conditions aux limites} avec \textit{ctrl+v}. Vous pouvez maintenant voir la courbe de débit :
+
+\begin{center}
+\includegraphics[width=15cm]{fev2002.png}
+\par\end{center}
+
+Fermer cette fenêtre. Revenir sur la fenêtre \textit{Conditions aux limites}. Ajouter une nouvelle ligne, lui donner un nom, lui donner le type textit{Z(T)} et l'associer au noeud aval du réseau. Ouvrez la fenêtre \textit{Éditer les conditions aux limites} (\includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}). Ajoutez deux lignes. Dans la première, entrez le temps : 0.00.00 et Z : 15.000.
+Dans la seconde, saisissez le temps : 1.00.00 et Z : 15.000. Cela crée une côte constante de l'eau en aval. Pour le calcul, Mage extrapolera continuellement l'élévation de l'eau.
+Vous pouvez fermer les fenêtres \textit{Éditer les conditions aux limites} et \textit{Conditions aux limites}.
+
+\section{Créer les conditions initiales}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Conditions initiales]}.
+Si vous ne connaissez pas les conditions initiales de la côte de l'eau et du débit de la rivière, vous pouvez utiliser les boutons \texttt{[Générer une hauteur minimale]} ou \texttt{[Générer un débit constant]} pour laisser Pamhyr2 estimer une condition initiale à l'aide de la formule de Manning-Strickler.
+Cliquez sur \texttt{[Générer à partir du débit]} et saisissez un débit de $4 m^2$ dans la fenêtre contextuelle pour générer une condition initiale de hauteur d'eau basée sur la formule de Manning-Strickler et un débit uniforme de $4 m^2$. Vous devriez voir :
+
+\begin{center}
+\includegraphics[width=15cm]{ic.png}
+\par\end{center}
+
+Fermer la fenêtre \textit{Conditions initiales}
+
+
+\section{Editer les coefficients de frottement}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Editer les frottements]}.
+Vous devez d'abord définir des jeux de coefficients de Strickler. Cliquez sur \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} pour ouvrir la fenêtre \textit{Strickler}. Vous pouvez y créer des couples de coefficients de Strickler, le premier pour le lit mineur, le second pour le lit moyen. Cliquez quatre fois sur \textit{add} pour créer quatre nouveaux couples. Donnez-leur les valeurs suivantes :
+
+\begin{center}
+\includegraphics[width=15cm]{K.png}
+\par\end{center}
+
+Fermez la fenêtre \textit{Strickler}. Dans la fenêtre \textit{Editer les frottements}, ajoutez quatre lignes avec le bouton \includegraphics[width=0.5cm]{gtk_add.png} pour créer quatre zones de frottement. Chaque zone est définie par un PK \textit{début} et de \textit{fin} PK et un couple \textit{begin} et \textit{end} couple de Strickler. Les couples de coefficients de Strickler à l'intérieur d'une zone sont interpolés à partir des couples \textit{begin} et \textit{end}. Dans notre cas, nous utiliserons des coefficients constants par zone. Définissez les zones comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{frictions.png}
+\par\end{center}
+
+La zone sélectionnée est surlignée en bleu. Fermez la fenêtre \textit{Editer les frottements}.
+
+
+\section{Modélisation des ouvrages hydrauliques}
+
+Parfois, il peut y avoir des sections en travers dans lesquelles les équations de Saint-Venant ne peuvent pas être utilisées pour modéliser l'écoulement de l'eau. Dans ce cas, nous devons définir une autre loi pour relier la côte de l'eau et le débit. C'est le cas, par exemple, au niveau des ponts lorsque la hauteur d'eau est trop élevée, ce qui entraîne un écoulement en charge. Pamhyr2 permet de définir différents ouvrages hydrauliques avec des lois paramétrables. Dans notre cas, on doit représenter un seuil et deux ponts comme ouvrages hydrauliques.
+Dans la fenêtre principale, cliquez sur \texttt{[Hydraulique] => [Ouvrages hydrauliques]} pour ouvrir la fenêtre des ouvrages hydrauliques. Cliquez trois fois sur le bouton \includegraphics[width=0.5cm]{gtk_add.png} pour créer trois ouvrages hydrauliques. Chaque structure peut avoir un nom et doit avoir une portée et un PK. Définissez-les comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{hs.png}
+\par\end{center}
+
+Sélectionnez le déversoir aval et cliquez sur \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} pour modifier les lois de cette ouvrage. Les ouvrages hydrauliques sont composés d'ouvrages hydrauliques élémentaires. Vous pouvez combiner les lois de plusieurs ouvrages hydrauliques élémentaires pour créer votre ouvrage. Pour ce déversoir, nous n'avons besoin que d'un ouvrage hydraulique élémentaire de type déversoir. Cliquez sur \includegraphics[width=0.5cm]{gtk_add.png} pour ajouter un nouvel ouvrage hydraulique élémentaire, donnez-lui le type \textit{seuil} et configurez-le comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{seuil.png}
+\par\end{center}
+
+Retournez à la fenêtre \textit{Ouvrages hydrauliques}.
+
+Sélectionnez le pont RS101 et cliquez sur \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} pour éditer les lois de cet ouvrage. Un pont peut être modélisé comme une combinaison d'un orifice pour l'écoulement sous le pont et d'un déversoir pour l'écoulement au-dessus du pont. Créez deux ouvrages hydrauliques élémentaires et définissez-les comme suit :
+\begin{center}
+\includegraphics[width=15cm]{seuilRS101.png}
+
+\includegraphics[width=15cm]{orificeRS101.png}
+\par\end{center}
+
+Revenez à la fenêtre \textit{Ouvrages hydrauliques} et appliquez la même procédure pour le pont de Thivencelle :
+
+\begin{center}
+\includegraphics[width=15cm]{orificeThivencelle.png}
+
+\includegraphics[width=15cm]{seuilThivencelle.png}
+\par\end{center}
+
+Vous pouvez maintenant fermer les fenêtres \textit{Ouvrages hydrauliques}.
+
+\section{Paramètres du solveur}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Exécuter] => [Parameters numériques fdes solveurs]}.
+Dans la fenêtre \textit{Paramètres du solveur}, sélectionnez l'onglet \textit{Mage v8}. Réglez les paramètres du solveur comme suit :
+
+\begin{center}
+\includegraphics[width=15cm]{param.png}
+\par\end{center}
+
+Fermer la fenêtre \textit{Paramètres du solveur}.
+
+\section{Lancer la simulation}
+
+Dans la fenêtre principale, cliquez sur \texttt{[Exécuter] => [Lancer le solveur]}.
+Sélectionnez \textit{Defaut-Mage - (Mage8)} et cliquez sur le bouton \textit{Exécuter}.
+Deux fenêtres s'ouvrent : la fenêtre \textit{check list} et la fenêtre \textit{Log du solveur}.
+La fenêtre \textit{Check list} donne quelques indications sur la validité de votre modèle, et la fenêtre \textit{Log du solveur} affiche les résultats du solveur.
+À partir de la fenêtre \textit{Log du solveur}, vous pouvez réexécuter le calcul, et vous pouvez cliquer sur le bouton \textit{Résultats} pour ouvrir la fenêtre \textit{Résultats}.
+
+\section{Visualiser les résultats}
+
+il est aussi possible d'ouvrir la fenêtre \textit{Résultats} si vous avez fermé la fenêtre textit{Log du solveur}, en cliquant sur \texttt{[Résultats] => [Visualiser les derniers résultats]} à partir de la fenêtre principale. Le panneau supérieur vous permet de sélectionner le bief, le panneau inférieur gauche vous permet de sélectionner une section en travers dans ce bief. Les trois diagrammes sur la droite montrent le bief et la section en travers de la même manière que dans la fenêtre \textit{Géométrie}. Vous pouvez utiliser le curseur du bas pour visualiser la côte de l'eau à différents pas de temps.
+Pour visualiser le débit, passez à l'onglet \textit{Hydrogramme}.
+Pour créer des tracés 2D personnalisés, cliquez sur le bouton \includegraphics[width=0.5cm]{gtk_add.png} en haut à gauche de la fenêtre. Sélectionnez les valeurs que vous voulez sur les axes $X$ et $Y$ et cliquez sur \textit{OK}.
+Vous pouvez maintenant voir un nouvel onglet avec le tracé 2D personnalisé dans le panneau droit de la fenêtre \textit{Results}.
+
+
+\pagebreak{}
+\end{document}
+

doc/users/Tuto1/step-by-step.tex

@@ -58,7 +58,7 @@ using Pamhyr2
 \par\end{center}{\large \par}
 
 \begin{center}
-Riverly, river hydraulics
+RiverLy, river hydraulics
 \par\end{center}
 
 ~
@@ -75,8 +75,9 @@ Riverly, river hydraulics
 
 \begin{center}
 \begin{tabular}{lll}
-Autors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
-& Théophile TERRAZ & theophile.terraz@inrae.fr\tabularnewline
+Authors : & Pierre-Antoine Rouby & pierre-antoine.rouby@inrae.fr\tabularnewline
+& Théophile Terraz & theophile.terraz@inrae.fr\tabularnewline
+& Lionel Pénard & lionel.penard@inrae.fr\tabularnewline
 \end{tabular}
 \par\end{center}
 
@@ -142,7 +143,7 @@ select the cross section named \textit{PontRD101m} and open the edition window.
 
 On the left panel is the list of all the points of the section, with their coordinates, their name and their transversal absisa. The Z coordinate of the highest point is written in blue and the lowest in red. Points can have a name. If a point with the same name exists in every section in a reach, it forms a longitudinal line. For example, here we have \textit{rg} and \textit{rd} which represent the left bank and the right bank of the main chanel.
 
-On the plot is a projection of the cross section. You can use \texttt{[ctrl + click]} to select a point in the plot and \texttt{[shift + click]} to select a water line and fisualize usefull geometric data. You can close the cross section edition window and the geometry edition window.
+On the plot is a projection of the cross section. You can use \texttt{[ctrl + click]} to select a point in the plot and \texttt{[shift + click]} to select a water line and visualize usefull geometric data. You can close the cross section edition window and the geometry edition window.
 
 \section{Edit the boundary conditions}
 
@@ -172,8 +173,8 @@ You can close the the \textit{Edit Boundary Conditions} and the \textit{Boundary
 \section{Create initial conditions}
 
 From the main window, click on \texttt{[Hydraulics] => [Initial conditions]}.
-If you don't know the initial conditions in water elevation and flow discharge of the river, you can use \texttt{[Generate minimal height]} or \texttt{[Generate constant discharge]} buttons to let Pamhyr2 estimate an initial condition using the Manning-Strickler formula.
-Click on \texttt{[Generate minimal height]} and enter a discharge of $4 m^2$ in the pop-up window to generate an initial water height condition based on the Manning-Strickler formula and a uniform discharge of $4 m^2$. You should see:
+If you don't know the initial conditions in water elevation and flow discharge of the river, you can use \texttt{[Generate minimal height]} or \texttt{[Generate from discharge]} buttons to let Pamhyr2 estimate an initial condition using the Manning-Strickler formula.
+Click on \texttt{[Generate from discharge]} and enter a discharge of $4 m^2$ in the pop-up window to generate an initial water height condition based on the Manning-Strickler formula and a uniform discharge of $4 m^2$. You should see:
 
 \begin{center}
 \includegraphics[width=15cm]{ic.png}
@@ -191,7 +192,7 @@ You fist have to define sets of Strickler coefficients. Click on \includegraphic
 \includegraphics[width=15cm]{K.png}
 \par\end{center}
 
-Close the \textit{Strickler} window. On the \textit{Edit friction} window, add four lines with the button \includegraphics[width=0.5cm]{gtk_add.png} to create four friction zones. Each zone is defined by a \textit{begin} and \textit{end} PK and a \textit{begin} and \textit{end} Strickler couple. The strickler coefficient couples inside a zone are interpolated from the \textit{begin} and \textit{end} couples. In our case, we will use constant coefficients per zone. Set the zones as follow:
+Close the \textit{Strickler} window. On the \textit{Edit friction} window, add four lines with the button \includegraphics[width=0.5cm]{gtk_add.png} to create four friction zones. Each zone is defined by a \textit{begin} and \textit{end} KP and a \textit{begin} and \textit{end} Strickler couple. The strickler coefficient couples inside a zone are interpolated from the \textit{begin} and \textit{end} couples. In our case, we will use constant coefficients per zone. Set the zones as follow:
 
 \begin{center}
 \includegraphics[width=15cm]{frictions.png}
@@ -203,7 +204,7 @@ The selected zone is highlighted in blue. Close the \textit{Edit friction} windo
 \section{Model hydraulic structures}
 
 Sometimes there can be cross-sections in which Shallow water equations can not be used to model the water flow. In that case, we have to define an other law to link the water elevation and the flow discharge. This is the case, for example, under bridges when the water elevation is too high, leading to a flow in charge. Pamhyr2 enables to define various hydraulic structures with laws that can be parametrized. In our case, a weir and two bridges have to be represented as hydraulic structures.
-From the main window, click on \texttt{[Hydraulics] => [Hydraulic structures]} to open the hydraulic structures window. Click tree times on the \includegraphics[width=0.5cm]{gtk_add.png} button to create three hydraulic structures. Each structure can have a name and must have a reach and a kp. Set them as follow:
+From the main window, click on \texttt{[Hydraulics] => [Hydraulic structures]} to open the hydraulic structures window. Click tree times on the \includegraphics[width=0.5cm]{gtk_add.png} button to create three hydraulic structures. Each structure can have a name and must have a reach and a KP. Set them as follow:
 
 \begin{center}
 \includegraphics[width=15cm]{hs.png}
@@ -256,7 +257,7 @@ From the \textit{Solver log} window you can re-run the computation, and from the
 
 \section{Visualize the results}
 
-If you closed the textit{Solver log} window, you can click on \texttt{[Results] => [Visualize last results]} from the main window to open the \textit{Results} window. The top lets panel let you select your reach, the bottom left panel lets you select a cross-section in that reach. the tree plots on the right show the reach and the cross-section the same way than in the \textit{Geometry} window. You can use the bottom slider to visualize the water elevation at different timesteps.
+If you closed the textit{Solver log} window, you can click on \texttt{[Results] => [Visualize last results]} from the main window to open the \textit{Results} window. The top lets panel let you select your reach, the bottom left panel lets you select a cross-section in that reach. the three plots on the right show the reach and the cross-section the same way than in the \textit{Geometry} window. You can use the bottom slider to visualize the water elevation at different timesteps.
 To visualize the flow discharge, switch to the \textit{Hydrograph} tab.
 To create custom 2D plots, click on the \includegraphics[width=0.5cm]{gtk_add.png} button on the top left of the window. Select the values you want on the $X$ and $Y$ axis and click on \textit{OK}.
 You can now see a new tab with the custom 2D plot in the right panel of the \textit{Results} window.