Tuto: Add ci tuto building.

.gitlab-ci.yml

@@ -151,6 +151,24 @@ build-users-doc:
       - doc/users/images/
   allow_failure: true
 
+
+build-td:
+  stage: build
+  tags:
+    - linux
+  needs:
+    - job: set-version
+      artifacts: true
+  script:
+    - cd ./doc/users/Tuto1/
+    - ./build.sh
+  artifacts:
+    paths:
+      - doc/users/Tuto1/step-by-step.pdf
+      - doc/users/Tuto1/pas-a-pas.pdf
+      - doc/users/Tuto1/data/
+  allow_failure: true
+
 build-developers-doc:
   stage: build
   tags:
@@ -199,6 +217,8 @@ build-linux:
       artifacts: true
     - job: build-users-doc
       artifacts: true
+    - job: build-td
+      artifacts: true
   script:
     - mkdir -p linux
     - cd linux
@@ -249,6 +269,12 @@ build-linux:
     #- cp ../doc/users/images/* pamhyr/doc/images
     - cp -r ../doc/dev/images/* pamhyr/doc/images
     - cp -r ../doc/images/* pamhyr/doc/images
+    # Copy Tuto
+    - mkdir -p pamhyr/doc/Tuto1/
+    - mkdir -p pamhyr/doc/Tuto1/data
+    - cp ../doc/users/Tuto1/step-by-step.pdf pamhyr/doc/Tuto1/Tuto1-en.pdf
+    - cp ../doc/users/Tuto1/pas-a-pas.pdf pamhyr/doc/Tuto1/Tuto1-fr.pdf
+    - cp ../doc/users/Tuto1/data/* pamhyr/doc/Tuto1/data/
     # Create running script
     - echo "#!/bin/sh" > pamhyr/Pamhyr2
     - echo "./pamhyr/pamhyr $@" >> pamhyr/Pamhyr2
@@ -274,6 +300,8 @@ build-windows:
       artifacts: true
     - job: build-users-doc
       artifacts: true
+    - job: build-td
+      artifacts: true
   script:
     - mkdir windows
     - cd windows

doc/users/Tuto1/build.sh

+#! /bin/sh
+
+pdflatex -no-shell-escape step-by-step.tex
+pdflatex -no-shell-escape pas-a-pas.tex

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}
+Tutorial for Pamhyr2
+
+January 2024
+\par\end{center}
+
+~
+
+~
+
+\begin{center}
+\textbf{\LARGE 1D Modeling of the Hogneau River (Nord, France)}
+
+using Pamhyr2
+\par\end{center}{\LARGE \par}
+
+~
+
+~
+
+\begin{center}
+{\large INRAE Lyon-Grenoble Auvergne-Rhône-Alpes}
+\par\end{center}{\large \par}
+
+\begin{center}
+Riverly, river hydraulics
+\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
+\end{tabular}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+\begin{center}
+\tableofcontents{}
+\par\end{center}
+
+~
+
+\pagebreak{}
+
+\section{Introduction}
+
+TODO
+
+\pagebreak{}
+
+\section{Install Pamhyr2}
+
+Pamhyr2 can be downloaded from \url{https://gitlab.irstea.fr/theophile.terraz/pamhyr}.
+\begin{center}
+\includegraphics[width=15cm]{dl.png}
+\par\end{center}
+
+Use the GNU Linux or the Windows download button depending on your system. On windows, launch the installer. On Linux, unpack the archive and launch Pamhyr2.
+
+
+\section{Create your first study}
+
+On the main windows, click on \texttt{[Files] => [New Study]} to create a new study.
+
+Click on \texttt{[River Network] => [Edit River Network]} to create the reaches of your river. In this window, you must define an oriented graph that represents the reaches of your river network: the edges are the reaches and the nodes are either upstream boundary conditions, downstream boundary conditions or junctions.
+Press the \includegraphics[width=0.5cm]{gtk_add.png} to enter the \textit{add} mode. Create two nodes by clicking in the grey zone of the window, and create a link by clicking again on each node. press \includegraphics[width=0.5cm]{gtk_add.png} again to exit the \textit{add} mode. You created your first reach, with an upstream node and a downstream node. In the lower part of the \textit{Edit River Network} window you can rename the nodes and the reaches. As the reach you created is automaticaly selected, all the next steps will apply to this reach. The window should look like that:
+
+\begin{center}
+\includegraphics[width=15cm]{network.png}
+\par\end{center}
+
+Close the \textit{Edit River Network} window.
+
+
+\section{Edit the river geometry}
+
+Click on \texttt{[Geometry] => [Edit Geometry]} to define the geometry of the selected bief. Click on the \texttt{[Import]} button and select the file \texttt{Data/Bief\_1.st}. You should see:
+
+\begin{center}
+\includegraphics[width=15cm]{Geo.png}
+\par\end{center}
+
+On the left panel is a list of all the cross sections with their name and longitudinal abscisa. In the top left plot you can see the top view of the river, on the top right panel the longitudinal cross-section of the river and in the bottom plot you can see the selected cross-section (blue) along with the next one (dashed purple) and previous one (dashed black). You can move in the section list using the slider at the very right of the window.
+
+You can edit the selected cross section by clicking on the \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} icon.
+
+select the cross section named \textit{PontRD101m} and open the edition window. You should see:
+
+\begin{center}
+\includegraphics[width=15cm]{editsect.png}
+\par\end{center}
+
+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.
+
+\section{Edit the boundary conditions}
+
+From the main window, click on \texttt{[Hydraulics] => [Boundary conditions and punctual contributions]}.You should see:
+
+\begin{center}
+\includegraphics[width=15cm]{boundary.png}
+\par\end{center}
+
+ Use the \textit{add} button on the top left of the window to add a liquid boundary condition.
+ On the new line, click to select the whole line, double click to select the cell.
+ Select the \textit{Type} cell to give a name to the boundary condition. here, we will define the flow discharge mesured during the february 2002 flood. You can name this boundary condition "flood2002".
+ Select the \textit{Type} cell and use the combo box to put a Q(t) law.
+ Select the \textit{Node} cell and atribute this condition to the upstream node.
+ Names of the nodes are recalled in network in the right panel.
+ Now select the whole line and click on the edit button \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}. You opened the \textit{Edit Boundary Conditions} window.
+ On a text editor, open the \texttt{Data/Fevrier\_2002.txt} file. Copy the content of the file (for example with \textit{ctrl+a ctrl+c}) and paste it in the left panel of the \textit{Edit Boundary Conditions} window with \textit{ctrl+v}. You can now see the flow discharge curve:
+
+\begin{center}
+\includegraphics[width=15cm]{fev2002.png}
+\par\end{center}
+
+Close this window. Go back on the \textit{Boundary Conditions} window. Add a new line, give it a name, give it the textit{Z(T)} type and associate it to the downstream node of the network. Open the \textit{Edit Boundary Conditions} window (\includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"}). Add two lines. In the first one, enter time: 0.00.00 and Z: 15.000.
+On the second one, time: 1.00.00 and Z: 15.000. It creates a constant downstream water elevation. For the computaion, Mage will extrapolate continuously the water elevation, that's why we only need to define one hour.
+You can close the the \textit{Edit Boundary Conditions} and the \textit{Boundary Conditions} window.
+
+\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:
+
+\begin{center}
+\includegraphics[width=15cm]{ic.png}
+\par\end{center}
+
+Close the \textit{Initial conditions} window.
+
+
+\section{Edit friction coefficients}
+
+From the main window, click on \texttt{[Hydraulics] => [Edit friction]}.
+You fist have to define sets of Strickler coefficients. Click on \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} to open the \textit{Strickler} window. Here you can create couples of Strickler coefficients, the first one for the minor bed, the second one for the medium bed. Click on \textit{add} four times to create four new couple. Give them the folowing values:
+
+\begin{center}
+\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:
+
+\begin{center}
+\includegraphics[width=15cm]{frictions.png}
+\par\end{center}
+
+The selected zone is highlighted in blue. Close the \textit{Edit friction} window.
+
+
+\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:
+
+\begin{center}
+\includegraphics[width=15cm]{hs.png}
+\par\end{center}
+
+Select the downstream weir and click on \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} to edit the laws of this structure. Hydraulic structures are composed of basic hydraulic structures. You can combine the laws of several basic hydraulic structures to setup your structure. For this weir, we only need a weir basic hydraulic structure. Click on \includegraphics[width=0.5cm]{gtk_add.png} to add a new basic hydraulic structure, give it the \textit{weir} type and set it up as folow:
+
+\begin{center}
+\includegraphics[width=15cm]{seuil.png}
+\par\end{center}
+
+Go back to the \textit{hydraulic structures} window.
+
+Select the RS101 bridge and click on \includegraphics[width=0.5cm]{"../../../src/View/ui/ressources/edit.png"} to edit the laws of this structure. A bridge can be modeled as a combination of an orifice for the flow under the bridge and a weir for the flow over the bridge. Create two basic hydraulic structures and set them as folow:
+
+\begin{center}
+\includegraphics[width=15cm]{seuilRS101.png}
+
+\includegraphics[width=15cm]{orificeRS101.png}
+\par\end{center}
+
+Go back to the \textit{hydraulic structures} window and aply the same procedure for the Thivencelle bridge:
+
+\begin{center}
+\includegraphics[width=15cm]{orificeThivencelle.png}
+
+\includegraphics[width=15cm]{seuilThivencelle.png}
+\par\end{center}
+
+You can now close the \textit{hydraulic structures} windows.
+
+\section{Solver parameters}
+
+From the main window, click on \texttt{[Execute] => [Numerical parameters for solvers]}.
+In the window \textit{solver parameters} select the \textit{Mage v8} tab. Set the solver parameters as follow:
+
+\begin{center}
+\includegraphics[width=15cm]{param.png}
+\par\end{center}
+
+Close the \textit{solver parameters} window.
+
+\section{Run the simulation}
+
+From the main window, click on \texttt{[Execute] => [Run solver]}.
+Select \textit{Defaut-Mage - (Mage8)} anc click on the \textit{Run} button.
+It will open two windows: the \textit{Check list} window and the \textit{Solver log} window.
+The \textit{Check list} window gives som hints about the validity of your model, and the \textit{Solver log} window displays the outputs of the solver.
+From the \textit{Solver log} window you can re-run the computation, and from the textit{Solver log} window you can click on the \textit{Results} button to open the \textit{Results} window.
+
+\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.
+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.
+
+
+\pagebreak{}
+\end{document}
+

packages/make-windows-dir.bat

@@ -60,3 +60,9 @@ copy /y ..\doc\dev\documentation.html pamhyr\doc\Pamhyr2-dev.html
 copy /y ..\doc\users\images\* pamhyr\doc\images
 copy /y ..\doc\dev\images\* pamhyr\doc\images
 copy /y ..\doc\images\* pamhyr\doc\images
+rem Tuto
+mkdir pamhyr/doc/Tuto1/
+mkdir pamhyr/doc/Tuto1/data
+copy /y ..\doc\users\Tuto1\step-by-step.pdf pamhyr\doc\Tuto1\Tuto1-en.pdf
+copy /y ..\doc\users\Tuto1\pas-a-pas.pdf pamhyr\doc\Tuto1\Tuto1-fr.pdf
+copy /y ..\doc\users\Tuto1\data\* pamhyr\doc\Tuto1\data\