add solver dirs in .gitignore

work on tuto1

.gitignore

@@ -19,6 +19,8 @@ tmp
 *.pdf
 *.odt
 
+!doc/**/*.pdf
+
 doc/dev/images/auto_*
 doc/dev/documentation.*
 !doc/dev/*.org
@@ -37,6 +39,9 @@ __old__
 
 *-venv
 
+mage8
+adists
+
 ### END CUSTOM ###
 
 # Created by https://www.toptal.com/developers/gitignore/api/python
@@ -268,6 +273,7 @@ flycheck_*.el
 
 
 # End of https://www.toptal.com/developers/gitignore/api/emacs
+
 # Created by https://www.toptal.com/developers/gitignore/api/qt
 # Edit at https://www.toptal.com/developers/gitignore?templates=qt
 
@@ -643,3 +649,233 @@ TSWLatexianTemp*
 *.glstex
 
 # End of https://www.toptal.com/developers/gitignore/api/latex
+
+# Created by https://www.toptal.com/developers/gitignore/api/intellij
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij
+
+### Intellij ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij
+
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode
+
+# Created by https://www.toptal.com/developers/gitignore/api/linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# End of https://www.toptal.com/developers/gitignore/api/linux
+
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos
+
+# Created by https://www.toptal.com/developers/gitignore/api/windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows

.gitlab-ci.yml

@@ -1,5 +1,5 @@
 # .gitlab-ci.yml -- Pamhyr gitlab-ci
-# Copyright (C) 2023  INRAE
+# Copyright (C) 2023-2024  INRAE
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,45 +20,68 @@ stages:
   - test
   - build
   - package
+  - hash
+  - antivirus
   - release
 
 #############
 # DOWNLOADS #
 #############
 
-dl-mage-linux:
-  stage: downloads
-  tags:
-    - linux
-  rules:
-    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
-  script:
-    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/Test6/downloads/packages/mage_linux.tgz
-    - mkdir -p mage-linux
-    - cd mage-linux
-    - tar xvf ../mage.tgz
-  artifacts:
-    paths:
-      - mage-linux/mage
-      - mage-linux/mage_extraire
-      - mage-linux/mailleurPF
+variables:
+  MAGE_8_VERSION: "v8.3.6"
 
-dl-mage-windows:
+dl-mage8-doc:
   stage: downloads
   tags:
     - linux
   rules:
     - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
   script:
-    - curl -L -o mage.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/Test6/downloads/packages/mage_windows.tgz
-    - mkdir -p mage-windows
-    - cd mage-windows
-    - tar xvf ../mage.tgz
+    - mkdir -p doc
+    - cd doc
+    - curl -L -o mage8.pdf https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_8_VERSION/downloads/documents/Mage-8_Documentation.pdf
   artifacts:
     paths:
-      - mage-windows/mage.exe
-      - mage-windows/mage_extraire.exe
-      - mage-windows/mailleurPF.exe
+      - doc/mage8.pdf
+
+dl-mage8-linux:
+  stage: downloads
+  tags:
+    - linux
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - curl -L -o mage8.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_8_VERSION/downloads/packages/mage_linux.tgz
+    - mkdir -p mage8-linux
+    - cd mage8-linux
+    - tar xvf ../mage8.tgz
+  artifacts:
+    paths:
+      - mage8-linux/mage
+      - mage8-linux/mage_as7
+      - mage8-linux/mage_extraire
+      - mage8-linux/mailleurTT
+      - mage8-linux/libbief.so
+
+dl-mage8-windows:
+  stage: downloads
+  tags:
+    - linux
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - curl -L -o mage8.tgz https://gitlab.irstea.fr/jean-baptiste.faure/mage/-/releases/$MAGE_8_VERSION/downloads/packages/mage_windows.tgz
+    - mkdir -p mage8-windows
+    - cd mage8-windows
+    - tar xvf ../mage8.tgz
+  artifacts:
+    paths:
+      - mage8-windows/mage.exe
+      - mage8-windows/mage_as7.exe
+      - mage8-windows/mage_extraire.exe
+      - mage8-windows/mailleurTT.exe
+      - mage8-windows/libbief.dll
 
 #############
 # CONFIGURE #
@@ -122,14 +145,31 @@ test-pep8:
     - pip3 install -r ./requirements.txt
     - pip3 install -U -r ./requirements.txt
     - pip3 install pycodestyle
-    - pycodestyle ./src
+    - pycodestyle --exclude="*_to_*.py" ./src
   allow_failure: true
 
 #########
 # BUILD #
 #########
 
-build-users-doc:
+# build-users-doc:
+#   stage: build
+#   tags:
+#     - linux
+#   needs:
+#     - job: set-version
+#       artifacts: true
+#   script:
+#     - cd ./doc/users/
+#     - ./build.sh
+#   artifacts:
+#     paths:
+#       - doc/users/documentation.pdf
+#       - doc/users/documentation.html
+#       - doc/users/images/
+#   allow_failure: true
+
+build-td:
   stage: build
   tags:
     - linux
@@ -137,13 +177,13 @@ build-users-doc:
     - job: set-version
       artifacts: true
   script:
-    - cd ./doc/users/
+    - cd ./doc/users/Tuto1/
     - ./build.sh
   artifacts:
     paths:
-      - doc/users/documentation.pdf
-      - doc/users/documentation.html
-      - doc/users/images/
+      - doc/users/Tuto1/step-by-step.pdf
+      - doc/users/Tuto1/pas-a-pas.pdf
+      - doc/users/Tuto1/data/
   allow_failure: true
 
 build-developers-doc:
@@ -184,7 +224,9 @@ build-linux:
   rules:
     - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
   needs:
-    - job: dl-mage-linux
+    - job: dl-mage8-linux
+      artifacts: true
+    - job: dl-mage8-doc
       artifacts: true
     - job: set-version
       artifacts: true
@@ -192,7 +234,9 @@ build-linux:
       artifacts: true
     - job: build-developers-doc
       artifacts: true
-    - job: build-users-doc
+    # - job: build-users-doc
+    #   artifacts: true
+    - job: build-td
       artifacts: true
   script:
     - mkdir -p linux
@@ -207,28 +251,32 @@ build-linux:
     - pyinstaller -y --paths linux-venv/lib/python3.8/site-packages ../src/pamhyr.py
     # Create directory
     - mkdir -p pamhyr
-    - mkdir -p pamhyr/pamhyr
-    - mkdir -p pamhyr/pamhyr/_internal
+    - mkdir -p pamhyr/_internal
     # Copy Pamhyr info
-    - cp -v ../VERSION pamhyr/pamhyr/_internal/
-    - cp -v ../AUTHORS pamhyr/pamhyr/_internal/
-    - cp -v ../LICENSE pamhyr/pamhyr/_internal/
-    - cp -v ../src/motd.txt pamhyr/pamhyr/_internal/
+    - cp -v ../VERSION pamhyr/_internal/
+    - cp -v ../AUTHORS pamhyr/_internal/
+    - cp -v ../LICENSE pamhyr/_internal/
+    - cp -v ../src/motd.txt pamhyr/_internal/
     # Copy mage
-    - mkdir -p pamhyr/mage
-    - cp -v ../mage-linux/* pamhyr/mage/
+    - mkdir -p pamhyr/mage8
+    - cp -v ../mage8-linux/* pamhyr/mage8/
     # Copy Pamhyr
-    - cp -r dist/pamhyr pamhyr/
+    - cp -r dist/pamhyr/* pamhyr/
+    # Pamhyr script to force x11
+    - echo '#!/usr/bin/env bash' > pamhyr/pamhyr-x11
+    - echo "" >> pamhyr/pamhyr-x11
+    - echo "GDK_BACKEND=x11 ./pamhyr $@" >> pamhyr/pamhyr-x11
+    - chmod +x pamhyr/pamhyr-x11
     # Copy Pamhyr resources
-    - mkdir -p pamhyr/pamhyr/_internal/View
-    - mkdir -p pamhyr/pamhyr/_internal/View/ui
-    - mkdir -p pamhyr/pamhyr/_internal/View/ui/Widgets
-    - cp -r ../src/View/ui/*.ui pamhyr/pamhyr/_internal/View/ui/
-    - cp -r ../src/View/ui/ressources/ pamhyr/pamhyr/_internal/View/ui
-    - cp -r ../src/View/ui/Widgets/*.ui pamhyr/pamhyr/_internal/View/ui/Widgets
+    - mkdir -p pamhyr/_internal/View
+    - mkdir -p pamhyr/_internal/View/ui
+    - mkdir -p pamhyr/_internal/View/ui/Widgets
+    - cp -r ../src/View/ui/*.ui pamhyr/_internal/View/ui/
+    - cp -r ../src/View/ui/ressources/ pamhyr/_internal/View/ui
+    - cp -r ../src/View/ui/Widgets/*.ui pamhyr/_internal/View/ui/Widgets
     # Copy lang
-    - mkdir -p pamhyr/pamhyr/_internal/lang
-    - cp -r ../src/lang/*.qm pamhyr/pamhyr/_internal/lang
+    - mkdir -p pamhyr/_internal/lang
+    - cp -r ../src/lang/*.qm pamhyr/_internal/lang
     # Copy tests cases
     - mkdir -p pamhyr/tests_cases/
     - mkdir -p pamhyr/tests_cases/Saar
@@ -237,17 +285,25 @@ build-linux:
     - mkdir -p pamhyr/doc/
     - mkdir -p pamhyr/doc/images/
     - mkdir -p pamhyr/doc/html/
-    - cp ../doc/users/documentation.pdf pamhyr/doc/Pamhyr2-users.pdf
-    - cp ../doc/users/documentation.html pamhyr/doc/Pamhyr2-users.html
+    # - cp ../doc/users/documentation.pdf pamhyr/doc/Pamhyr2-users.pdf
+    # - cp ../doc/users/documentation.html pamhyr/doc/Pamhyr2-users.html
+    - cp ../doc/mage8.pdf pamhyr/doc/mage8.pdf
     - cp ../doc/dev/documentation.pdf pamhyr/doc/Pamhyr2-dev.pdf
     - cp ../doc/dev/documentation.html pamhyr/doc/Pamhyr2-dev.html
     #- cp ../doc/users/images/* pamhyr/doc/images
-    - cp ../doc/dev/images/* pamhyr/doc/images
-    - cp ../doc/images/* pamhyr/doc/images
-    # Create running script
-    - echo "#!/bin/sh" > pamhyr/Pamhyr2
-    - echo "./pamhyr/pamhyr $@" >> pamhyr/Pamhyr2
-    - chmod u+x pamhyr/Pamhyr2
+    - 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/Hogneau_Engees2022.pdf pamhyr/doc/Tuto1/Hogneau_Engees2022.pdf
+    - 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/*.pamhyr pamhyr/doc/Tuto1/
+    - cp ../doc/users/Tuto1/data/* pamhyr/doc/Tuto1/data/
+    # Copy TP charriage
+    - mkdir -p pamhyr/doc/TP_charriage/
+    - cp ../doc/users/TP_charriage/* pamhyr/doc/TP_charriage
   artifacts:
     paths:
       - linux/pamhyr
@@ -259,7 +315,9 @@ build-windows:
   rules:
     - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
   needs:
-    - job: dl-mage-windows
+    - job: dl-mage8-windows
+      artifacts: true
+    - job: dl-mage8-doc
       artifacts: true
     - job: set-version
       artifacts: true
@@ -267,16 +325,20 @@ build-windows:
       artifacts: true
     - job: build-developers-doc
       artifacts: true
-    - job: build-users-doc
+    # - job: build-users-doc
+    #   artifacts: true
+    - job: build-td
       artifacts: true
   script:
     - mkdir windows
     - cd windows
     # Setup env
+    - python -m pip install -U pip
     - python -m pip install -r ..\requirements.txt
     - python -m pip install -U -r ..\requirements.txt
     # Run Pyinstaller
-    - pyinstaller -y ..\src\pamhyr.py
+    # - pyinstaller --noconsole -y ..\src\pamhyr.py
+    - pyinstaller -i ../src/View/ui/ressources/icon.ico --hide-console hide-early -y ..\src\pamhyr.py
     # Create directory
     - mkdir pamhyr
     - dir
@@ -346,6 +408,111 @@ windows-package-exe:
     - copy ..\packages\pamhyr.nsi pamhyr.nsi
     - .\make-windows-exe.bat
 
+########
+# HASH #
+########
+
+linux-build-hash:
+  stage: hash
+  tags:
+    - release
+    - linux
+  needs:
+    - job: build-linux
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - cd linux
+    - sha256sum -b pamhyr/pamhyr > pamhyr/pamhyr.sha256
+  artifacts:
+    paths:
+      - linux/pamhyr/pamhyr.sha256
+
+windows-build-hash:
+  stage: hash
+  tags:
+    - release
+    - linux
+  needs:
+    - job: build-windows
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - cd windows
+    - sha256sum -b pamhyr/pamhyr.exe > pamhyr/pamhyr.exe.sha256
+  artifacts:
+    paths:
+      - windows/pamhyr/pamhyr.exe.sha256
+
+pkg-hash:
+  stage: hash
+  tags:
+    - release
+    - linux
+  needs:
+    - job: linux-package-tar
+      artifacts: true
+    - job: windows-package-zip
+      artifacts: true
+    - job: windows-package-exe
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_TAG
+  script:
+    - cd windows
+    - sha256sum -b pamhyr-windows.exe > pamhyr-windows.exe.sha256
+    - sha256sum -b pamhyr-windows.zip > pamhyr-windows.zip.sha256
+    - cd ..
+    - cd linux
+    - sha256sum -b pamhyr-gnulinux.tar.xz > pamhyr-gnulinux.tar.xz.sha256
+  artifacts:
+    paths:
+    - windows/pamhyr-windows.exe.sha256
+    - windows/pamhyr-windows.zip.sha256
+    - linux/pamhyr-gnulinux.tar.xz.sha256
+
+#############
+# ANTIVIRUS #
+#############
+
+build-check-clamav:
+  stage: antivirus
+  tags:
+    - release
+    - linux
+  needs:
+    - job: build-linux
+      artifacts: true
+    - job: build-windows
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_BRANCH == 'master' || $CI_COMMIT_TAG
+  script:
+    - cd packages
+    - ./clamav-scan.sh builds
+  allow_failure: true
+
+pkg-check-clamav:
+  stage: antivirus
+  tags:
+    - release
+    - linux
+  needs:
+    - job: linux-package-tar
+      artifacts: true
+    - job: windows-package-zip
+      artifacts: true
+    - job: windows-package-exe
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == 'ci-test' || $CI_COMMIT_TAG
+  script:
+    - cd packages
+    - ./clamav-scan.sh packages
+  allow_failure: true
+
 ###########
 # RELEASE #
 ###########
@@ -362,10 +529,12 @@ tag-release:
       artifacts: true
     - job: windows-package-exe
       artifacts: true
-    - job: build-users-doc
-      artifacts: true
+    # - job: build-users-doc
+    #   artifacts: true
     - job: build-developers-doc
       artifacts: true
+    - job: pkg-hash
+      artifacts: true
   rules:
     - if: $CI_COMMIT_TAG
   artifacts:
@@ -373,33 +542,44 @@ tag-release:
       - linux/pamhyr-gnulinux.tar.xz
       - windows/pamhyr-windows.zip
       - windows/pamhyr-windows.exe
+      - linux/pamhyr-gnulinux.tar.xz.sha256
+      - windows/pamhyr-windows.zip.sha256
+      - windows/pamhyr-windows.exe.sha256
       - doc/dev/documentation.pdf
-      - doc/users/documentation.pdf
+      # - doc/users/documentation.pdf
   script:
     - cd packages
   release:
     name: '$CI_COMMIT_TAG'
-    description: 'Automatic release from tag $CI_COMMIT_TAG'
+    description: '$CI_COMMIT_TAG_MESSAGE'
     tag_name: '$CI_COMMIT_TAG'
     ref: '$CI_COMMIT_SHA'
     assets:
       links:
+        - name: 'GNU/Linux CHECKSUM SHA256 (tar.xz)'
+          url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/linux/pamhyr-gnulinux.tar.xz.sha256'
+          filepath: '/linux/pamhyr-gnulinux.tar.xz.sha256'
+          link_type: 'package'
         - name: 'GNU/Linux (tar.xz)'
           url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/linux/pamhyr-gnulinux.tar.xz'
           filepath: '/linux/pamhyr-gnulinux.tar.xz'
           link_type: 'package'
+        - name: 'Windows CHECKSUM SHA256 (exe)'
+          url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/windows/pamhyr-windows.exe.sha256'
+          filepath: '/windows/pamhyr-windows.exe.sha256'
+          link_type: 'package'
         - name: 'Windows (exe)'
           url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/windows/pamhyr-windows.exe'
           filepath: '/windows/pamhyr-windows.exe'
           link_type: 'package'
+        - name: 'Windows CHECKSUM SHA256 (zip)'
+          url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/windows/pamhyr-windows.zip.sha256'
+          filepath: '/windows/pamhyr-windows.zip.sha256'
+          link_type: 'package'
         - name: 'Windows (zip)'
           url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/windows/pamhyr-windows.zip'
           filepath: '/windows/pamhyr-windows.zip'
           link_type: 'package'
-        - name: 'User documentations (pdf)'
-          url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/doc/users/documentation.pdf'
-          filepath: '/doc/users/documentation.pdf'
-          link_type: 'other'
         - name: 'Dev documentations (pdf)'
           url: '${CI_PROJECT_URL}/-/jobs/${CI_JOB_ID}/artifacts/raw/doc/dev/documentation.pdf'
           filepath: '/doc/dev/documentation.pdf'

AUTHORS

@@ -1,3 +1,3 @@
 Sylvain COULIBALY, INRAE, 2020 - 2022
-Théophile TERRAZ, INRAE, 2022 - 2023
-Pierre-Antoine ROUBY, INRAE, 2023
+Théophile TERRAZ, INRAE, 2022 - 2024
+Pierre-Antoine ROUBY, INRAE, 2023 - 2024

README.md

@@ -3,48 +3,38 @@
 Pamhyr is a free and open source graphical user interface for 1D hydro-sedimentary
 modelling of rivers.
 
+![logo](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/raw/master/src/View/ui/ressources/Pamhyr2_logo.png)
+
 ## Features
 
-+ Edit a complex river hydraulics network
++ Define a complex river hydraulics network
 + Define the river geometry
 + Define boundary conditions
 + Define lateral contribution
-+ Edit river friction
-+ Generate initial conditions
-+ Edit river sedimentary layers
++ Define river friction
++ Define reservoirs
++ Define hydraulic structures
++ Define or generate initial conditions
++ Define river sedimentary layers
 + Save the study in a unique file
 + Run Mage 8 on a study and visualize results
 
+Let see the
+[documentation](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home)
+([:fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home-fr),
+[:gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home-en))
+for more details.
+
 ## Install
 
 ### GNU/Linux
 
-Downloads [last
-realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
-GNU/Linux binary archive.
-
-```shell
-tar xf pamhyr-gnulinux-amd64.tar.xz
-cd pamhyr
-./pamhyr
-```
+See documentation:
+- [French :fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/fr/Install%20on%20GNULinux)
+- [English :gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/en/Install%20on%20GNULinux)
 
 ### Windows
 
-Downloads [last
-realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
-Windows installer.
-
-### From source code
-
-```shell
-# Get source code
-git clone https://gitlab.irstea.fr/theophile.terraz/pamhyr/
-cd pamhyr
-
-# Install dependencies
-pip3 install -r requirements.txt
-
-# Run pamhyr
-./src/pamhyr.py
-```
+See documentation:
+- [French :fr:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/fr/Install%20on%20Windows)
+- [English :gb:](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/wikis/home/en/Install%20on%20Windows)

doc/dev/documentation.org

@@ -1,5 +1,5 @@
 # documentation.org -- Pamhyr developers documentation
-# Copyright (C) 2023  INRAE
+# Copyright (C) 2023-2024  INRAE
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -28,20 +28,6 @@
 #+OPTIONS: toc:t
 #+LANGUAGE: UKenglish
 
-#+NAME: attr_wrap
-#+HEADER: :var width="\\textwidth"
-#+HEADER: :var caption=""
-#+HEADER: :var smallcaption=""
-#+HEADER: :var name=""
-#+HEADER: :var data=""
-#+HEADER: :var float="nil"
-#+BEGIN_SRC sh :results output :exports none
-  echo "#+CAPTION[$smallcaption]: $caption"
-  echo "#+NAME: $name"
-  echo "#+ATTR_LATEX: :width $width :float $float"
-  echo "$data"
-#+END_SRC
-
 #+BEGIN_abstract
 This document is for the use of developers. It describes the project
 architecture, the tools available to assist development and
@@ -54,13 +40,13 @@ documentation, translations or code.
 
 * Introduction
 
-Pamhyr2 is free and open source software (FOSS) graphical user
+{{{pamhyr2}}} is free and open source software (FOSS) graphical user
 interface (GUI) for 1D hydro-sedimentary modelling of rivers developed
 in Python (with version 3.8). It use PyQt at version 5 and matplotlib
 in version 3.4.1 or later for the user insterface (see
 {{{file(/requirements.txt)}}} for details). The architecture of
 project code follow the Qt Model/View architecture [fn:qt-arch] (see
-details in section [[Architecture]]). Pamhyr2 packages can be build
+details in section [[Architecture]]). {{{pamhyr2}}} packages can be build
 manually (see section [[Building packages]]), but there are automatically
 build with the gitlab-ci (see the section [[Setup the CI
 environment]]). Documentation files are written with org-mode[fn:org],
@@ -75,7 +61,7 @@ https://doc.qt.io/qt-5/model-view-programming.html (last access
 
 * Architecture
 
-Pamhyr2's architecture is based on Qt Model/View, see Figure
+{{{pamhyr2}}}'s architecture is based on Qt Model/View, see Figure
 [[graph-architecture]]. It is made up of several different components: the
 model (in blue), the graphical components (in red), the
 actions/delegates (in green), the commands (in purple), the solvers
@@ -178,7 +164,7 @@ https://doc.qt.io/qt-5/model-view-programming.html
 
 ** Model
 
-The model is a set of Python classes. In Pamhyr2, this classes must
+The model is a set of Python classes. In {{{pamhyr2}}}, this classes must
 respect some constraint. Each model class must inherits
 =Model.Tools.SQLSubModel= abstract class, except the =Model.Study=
 class who inherits =Model.Tools.SQLModel= (see [[SQL]]).
@@ -369,6 +355,7 @@ of Bar (Listing [[sql-bar]] and [[sql-foo]]).
             CREATE TABLE bar (
               id INTEGER NOT NULL PRIMARY KEY,
               x INTEGER NOT NULL,
+              y INTEGER NOT NULL,
               foo_id INTEGER NOT NULL,
               FOREIGN KEY(foo_id) REFERENCES foo(id),
             )""")
@@ -455,6 +442,15 @@ of Bar (Listing [[sql-bar]] and [[sql-foo]]).
               bar._sql_save(execute, data=data)
 #+end_src
 
+Let see the results database scheme for {{{pamhyr2}}} at version v0.0.7 in
+Figure [[sql_schema]].
+
+#+NAME: sql_schema
+#+ATTR_LATEX: :width 16cm
+#+CAPTION: SQLite database scheme at {{{pamhyr2}}} version v0.0.7 (generate with [[https://gitlab.com/Screwtapello/sqlite-schema-diagram]])
+[[./images/schema_v0.0.7.png]]
+
+
 [fn:sqlite] The SQLite web site: https://www.sqlite.org/index.html
 (last access 2023-09-20)
 
@@ -476,7 +472,7 @@ PamhyrModelList but use a dictionary instead of list.
 
 ** View
 
-Pamhyr2 use Qt as graphical user interface library with the
+{{{pamhyr2}}} use Qt as graphical user interface library with the
 application "Qt designer" for windows or widget creation (see [[UI file]])
 and "Qt linguist" for interface translate (see [[Translate]]). In
 addition, we use matplotlib as ploting library (see [[Plot]]).
@@ -491,11 +487,11 @@ componant translate, and possible other files or sub-directories.
 
 *** UI file
 
-We define as possible all Pamhyr2 windows and custom widgets with "Qt
-designer". This application generate UI file who describes interface
-organisation with table, layout, button, etc. This method is faster
-than hand made windows and widget creation, and saves us some purely
-descriptive code. The UI files are saved into =src/View/ui= for
+We define as possible all {{{pamhyr2}}} windows and custom widgets
+with "Qt designer". This application generate UI file who describes
+interface organisation with table, layout, button, etc. This method is
+faster than hand made windows and widget creation, and saves us some
+purely descriptive code. The UI files are saved into =src/View/ui= for
 window, and =/src/View/ui/Widgets= for custom widget.
 
 *** Translate
@@ -523,10 +519,11 @@ window, and =/src/View/ui/Widgets= for custom widget.
 
 *** Window
 
-The abstract class PamhyrWindow and PamhyrDialog are used for most of
-Pamhyr2 window. These class allow to create an window for Pamhyr2 GUI
-and implemente some useful methods. The super class method difine some
-generic value from optional parameters, for examples:
+The abstract class =PamhyrWindow= and =PamhyrDialog= are used for most
+of {{{pamhyr2}}} window. These class allow to create an window for
+{{{pamhyr2}}} GUI and implemente some useful methods. The super class
+method difine some generic value from optional parameters, for
+examples:
 - =self._study=: The study giving in constructor parameters =study=
   (typically a =Model.Study= class object)
 - =self._config=: The configuration giving in constructor parameters
@@ -536,46 +533,46 @@ generic value from optional parameters, for examples:
   object)
 
 #+NAME: window
-#+CAPTION: Example of Pamhyr2 window
+#+CAPTION: Example of {{{pamhyr2}}} window
 #+begin_src python :python python3 :results output :noweb yes
-    from View.Tools.PamhyrWindow import PamhyrWindow
-    from View.My.Translate import MyTranslate
-    from View.My.Table import MyTableModel
+  from View.Tools.PamhyrWindow import PamhyrWindow
+  from View.My.Translate import MyTranslate
+  from View.My.Table import MyTableModel
 
-    class MyWindow(PamhyrWindow):
-        _pamhyr_ui = "MyUI"
-        _pamhyr_name = "My window"
+  class MyWindow(PamhyrWindow):
+      _pamhyr_ui = "MyUI"
+      _pamhyr_name = "My window"
 
-        def __init__(self, my_data=None,
-                     study=None, config=None,
-                     parent=None):
-            self._my_data = my_data
+      def __init__(self, study=None, config=None,
+                   my_data=None,
+                   parent=None):
+          self._my_data = my_data
 
-            super(MyWindow, self).__init__(
-                # Window title
-                title = self._pamhyr_name + " - " + study.name,
-                # Window standard data
-                study = study, config = config,
-                trad = MyTranslate(),
-                parent = parent,
-                # Activate undo/redo and copy/paste shortcut
-                options = ["undo", "copy"]
-            )
+          super(MyWindow, self).__init__(
+              # Window title
+              title = self._pamhyr_name + " - " + study.name,
+              # Window standard data
+              study = study, config = config,
+              trad = MyTranslate(),
+              parent = parent,
+              # Activate undo/redo and copy/paste shortcut
+              options = ["undo", "copy"]
+          )
 
-            # Add custom data to hash window computation
-            self._hash_data.append(self._my_data)
+          # Add custom data to hash window computation
+          self._hash_data.append(self._my_data)
 
-            # Setup custom window components
-            self.setup_table()
-            self.setup_connections()
+          # Setup custom window components
+          self.setup_table()
+          self.setup_connections()
 
-        def setup_table(self):
-            # Init table(s)...
+      def setup_table(self):
+          # Init table(s)...
 
-        def setup_connections(self):
-            # Init action connection(s)...
+      def setup_connections(self):
+          # Init action connection(s)...
 
-        # ...
+      # ...
 #+end_src
 
 Typically we called method =setup_*=, the method to initialize some
@@ -583,7 +580,7 @@ window componants or connections.
 
 *** Table
 
-An abstract class PamhyrTableModel is available to define a simple
+An abstract class =PamhyrTableModel= is available to define a simple
 QAbstractTableModel shortly. In simple cases, there are only =data=
 and =setData= methode to implement, but the constructor needs more
 information than a classic QAbstractTableModel class.
@@ -636,7 +633,7 @@ class AddNodeCommand(QUndoCommand):
         self._node = node
 
     def undo(self):
-        self._graph.remove_node(self._node.name)
+        self._graph.remove_node(self._node)
 
     def redo(self):
         self._graph.insert_node(self._node)
@@ -644,7 +641,7 @@ class AddNodeCommand(QUndoCommand):
 
 All undo command must be push into a =QUndoStack= (see Listing
 [[undo-cmd-push]]) to perform the action and allow user undo and redo this
-action. In PamhyrWindow (and PamhyrDialog) the undo stack is
+action. In =PamhyrWindow= (and =PamhyrDialog=) the undo stack is
 automatically create if the option ="undo"= is activate at window
 creation, this stack is accessible at =self._undo_stack=.
 
@@ -661,11 +658,13 @@ creation, this stack is accessible at =self._undo_stack=.
 
 *** Plot
 
-To define a new plot you can create a class who inherit to APlot. The
-creator need threee argument:
+To define a new plot you can create a class who inherit to
+=PamhyrPlot=. The creator need at leaste five argument:
  - A =canvas= of type =MplCanvas=
+ - A (optional) =trad= of type =PamhyrTranslate=
  - A =data= used in =draw= and =update= to create and update the plot
  - A optional =toolbar= of type =PamhyrToolbar=
+ - A =parent= window
 This class must implement two method =draw= and =update=, the first
 method to draw the plot from scratch, the second to update the plot if
 data has changed.
@@ -673,25 +672,42 @@ data has changed.
 #+begin_src python :python python3 :results output :noweb yes
   from View.Tools.PamhyrPlot import PamhyrPlot
 
-  class MyPlot(APlot):
-      def __init__(self, canvas=None, data=None, toolbar=None):
+  class MyPlot(PamhyrPlot):
+      def __init__(self, canvas=None, trad=None, toolbar=None
+                   data=None, parent=None):
           super(MyPlot, self).__init__(
               canvas=canvas,
+              trad=trad,
               data=data,
-              toolbar=toolbar
+              toolbar=toolbar,
+              parent=parent
           )
 
+        self.label_x = self._trad["x"]
+        self.label_y = self._trad["y"]
+
+        # Optional configuration
+        self._isometric_axis = False
+
+        self._auto_relim_update = True
+        self._autoscale_update = True
+
       def draw(self):
           # Draw function code...
 
-      def update(self, ind = None):
+      def update(self):
           # Update function code...
+
+      def clear(self):
+          # Clear plot values...
+
+      # ...
 #+end_src
 
 ** Solver
 
-The Pamhyr2 architecture allow to define multiple solver. A solver is
-define by a:
+The {{{pamhyr2}}} architecture allow to define multiple solver. A
+solver is define by a:
  - type
  - name
  - description,
@@ -707,11 +723,11 @@ different solver type, this solver type implement the code for export
 study to solver input format, and read the solver output to study
 results. There exists a generic solver with a generic input and output
 format, the type could be use to use a solver not implemented in
-Pamhyr2, but this solver must can read/write input and output generic
-format or use external script. There is possible to define different
-solver with the same type, for example two differents version of the
-same solver. Finaly, with input and output formater is possible to
-execute a code on distant computer, for example, over ssh.
+{{{pamhyr2}}}, but this solver must can read/write input and output
+generic format or use external script. There is possible to define
+different solver with the same type, for example two differents
+version of the same solver. Finaly, with input and output formater is
+possible to execute a code on distant computer, for example, over ssh.
 
 #+name: graph-multi-solver
 #+header: :results drawer
@@ -745,7 +761,7 @@ execute a code on distant computer, for example, over ssh.
                   style=dashed;
                   subgraph cluster021 {
                       label="Solver Classes";
-                      classSolverM7[label="Mage7", fillcolor=6];
+                      //classSolverM7[label="Mage7", fillcolor=6];
                       classSolverM8[label="Mage8", fillcolor=6];
                       classSolverR[label="RubarBE", fillcolor=6];
                   }
@@ -828,8 +844,8 @@ solver and get results:
  - (2.1) The solver read the input file(s)
  - (2.2) The solver compute results and write it to solver output
    file(s)
- - (3) Pamhyr2 create a Reuslts
- - (3.1) The Pamhyr2 solver class read solver output file(s) and
+ - (3) {{{pamhyr2}}} create a =Results= object
+ - (3.1) The {{{pamhyr2}}} solver class read solver output file(s) and
    complete Results with readed data
 
 #+name: graph-pipeline
@@ -947,7 +963,7 @@ the temporal order of action is prensented in Figure
   }
 #+end_src
 
-To implement a Solver in Pamhyr2, there exists a abstract class
+To implement a Solver in {{{pamhyr2}}}, there exists a abstract class
 =Solver.AbstractSolver=. A class who herits this class, must implement
 different methods:
  - =export=: Export the study to solver input file(s)
@@ -958,27 +974,35 @@ different methods:
 
 ** Unit tests
 
-The unit tests is actually not implemented in Pamhyr2, it is a *work
-in progress*.
+A very small part of {{{pamhyr2}}} has unit test. This part is limited to the Model.
+
+#+begin_src shell
+  python3 -m venv test
+  . test test/bin/activate
+  pip3 install -U -r ./full-requirements.txt
+
+  cd src/
+  python3 -Walways -m unittest discovert -v -t .
+#+end_src
 
 ** The debug mode
 
-To activate an deactivate the Pamhyr2 debug mode you can open the
-configuration window and type "Ctrl+G" or run Pamhyr2 with command
-line:
+To activate an deactivate the {{{pamhyr2}}} debug mode you can open
+the configuration window and type "Ctrl+G" or run {{{pamhyr2}}} with
+command line:
 #+begin_src shell
 ./Pamhyr2 debug
 #+end_src
 
-This mode add some log and add two action in main window menu:
-"About/Debug" open a window with Python Repl in current Python
-environement, and "About/Debug SQLite" who open the application
+This mode add some log and add two action in main window menu: "About
+> Debug" open a window with Python Repl in current Python
+environement, and "About > Debug SQLite" who open the application
 SQLiteBrowser (if installed) on current Study to explore the study
 data base file.
 
 #+NAME: debug-repl
-#+ATTR_LATEX: :width 12cm
-#+CAPTION: Pamhyr2 debug Python REPL
+#+ATTR_LATEX: :width 14cm
+#+CAPTION: {{{pamhyr2}}} debug Python REPL
 [[./images/python-debug-repl.png]]
 
 * Build the project
@@ -991,7 +1015,7 @@ to build packages manually.
 If you need an hand made package, you can script available in
 {{{file(packages)}}} directory.
 
-*** GNU/Linux
+*** GNU/Linux {{{linux}}}
 
 On GNU/Linux building GNU/Linux packages is easy, you just need python
 in version 3.8 must be installed with venv and pyinstaller packages
@@ -1013,7 +1037,7 @@ cd packages
 ./linux.sh
 #+end_src
 
-*** Windows
+*** Windows {{{windows}}}
 
 To make the Windows packages you have two choice: If you use Windows
 you can use the script {{{file(packages/windows.bat)}}}, other else
@@ -1028,10 +1052,10 @@ winetricks installed.
 
 ** Setup the CI environment
 
-Pamhyr2 need a Linux ci-runner and a Windows ci-runner for building
+{{{pamhyr2}}} need a Linux ci-runner and a Windows ci-runner for building
 package. The windows ci-runner could run on a Wine environement.
 
-*** Linux
+*** Linux {{{linux}}}
 
 The Linux ci-runner need some software and dependencies in addtion of
 gitlab-ci.
@@ -1041,10 +1065,11 @@ gitlab-ci.
        emacs emacs-goodies-el                     \
        texlive-full                               \
        python3.8 python3.8-venv
+
   sudo python3 -m pip install pyinstaller
 #+end_src
 
-*** Windows (Wine)
+*** Windows (Wine) {{{windows}}}
 
 The ci-runner environment for Wine need at least wine version 8, let
 [[https://www.numetopia.fr/comment-installer-wine-sur-ubuntu-ou-linux-mint/][see who to add wine official depot to your linux distribution]].
@@ -1053,18 +1078,77 @@ The ci-runner environment for Wine need at least wine version 8, let
 sudo apt install wine-stable winetricks
 #+end_src
 
-In addition, the environment need windows version of:
- - [[https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe][Python 3.8.10]]
- - Git
- - PowerShell
- - Gitlab-ci
+**** Setup environment
+
+Export Wine environment variable to set wine as 64 bits architecture
+and set the correct path for wine environment.
+
+#+begin_src shell
+  export WINARCH=win64
+  export WINEPREFIX=$PWD/my-wine-runner-prefix
+#+end_src
+
+Setup Wine environment to Windows 10 and install the minimal fonts
+with =winetricks=.
+
+#+begin_src shell
+  winetricks corefonts win10
+#+end_src
+
+**** Install dependencies
+
+First install 7zip with help of =winetricks=.
+
+#+begin_src shell
+  winetricks 7zip
+#+end_src
+
+In addition, install in the environment the Windows version of:
+ - [[https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe][Python 3.8.10]] (ensure the python path is set and Pip is enable)
+ - [[https://git-scm.com/downloads][Git]]
+ - [[https://github.com/PowerShell/PowerShell/releases/download/v7.0.1/PowerShell-7.0.1-win-x64.msi][PowerShell]]
  - [[https://freefr.dl.sourceforge.net/project/nsis/NSIS%203/3.08/nsis-3.08-setup.exe][Nsis]]
 
+To run a Windows executable into wine environement, use =wine64= command:
+
+#+begin_src shell
+  wine64 <the-exe-file>
+#+end_src
+
 Now, we can install =pyinstaller= on this windows environment:
 #+begin_src shell
 wine python -m pip install pyinstaller
 #+end_src
 
+Now, we can download [[https://docs.gitlab.com/runner/install/windows.html][Gitlab-ci]] runner for Windows an put it in the
+current path.
+
+**** Setup runner
+
+You can configure the runner with command:
+
+#+begin_src shell
+  wine64 gitlab-runner-windows-amd64.exe register
+#+end_src
+
+**** Run the runner
+
+Create a new executable shell script =runner.sh= with following lines:
+
+#+begin_src shell
+  #! /bin/sh
+
+  export WINARCH=win64
+  export WINEPREFIX=$PWD/my-wine-runner-prefix
+
+  wine64 gitlab-runner-windows-amd64.exe run
+#+end_src
+
+Now you can run the runner with command =./runner.sh=.
+
+{{{bulb}}} You can run this command into a =screen= terminal, detach
+the terminal and disconnect from runner machine to keep runner alive.
+
 * Documentation files
 
 This document and the user documentation are org files. This text file
@@ -1247,23 +1331,23 @@ Some org-mode configuration used in documentations files are define in
 
 * How to contribute?
 
-Pamhyr2 is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License[fn:license], either
-version 3 of the License, or any later version.
+{{{pamhyr2}}} is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License[fn:license],
+either version 3 of the License, or any later version.
 
 [fn:license] The GPLv3 web page:
 https://www.gnu.org/licenses/gpl-3.0.en.html
 
 ** Guidelines
 
-To contribute to Pamhyr2, we expect a minimum of respect between
+To contribute to {{{pamhyr2}}}, we expect a minimum of respect between
 contributors. We therefore ask you to respect the following rules
 regarding communication and contribution content:
 + No gender, racial, religious or social discrimination
 + No insults, personal attacks or potentially offensive remarks
-+ Pamhyr2 is free software, and intended to remain so, so take care
-  with the licensing of libraries and external content you want to add
-  to the project
++ {{{pamhyr2}}} is free software, and intended to remain so, so take
+  care with the licensing of libraries and external content you want
+  to add to the project
 + Humour or hidden easter eggs are welcome if they respect the
   previous rules
 
@@ -1274,11 +1358,12 @@ an issue on the project's gitlab page[fn:p2-gitlab], or you can create
 a merge request on the same page with the changes you have made to the
 code, translation or documentation.
 
-The Pamhyr2 copyright is owned by INRAE[fn:inrae], but we keep a
-record of each contributors. If you made a modification to pamhyr2
-software, please add your name at the end of {{{file(AUTHORS)}}} file
-and respect the Listing [[auth-format]] format. You can update this file
-information for following contribution.
+The {{{pamhyr2}}} copyright is owned by INRAE[fn:inrae], but we keep a
+record of each contributors. If you made a modification to
+{{{pamhyr2}}} software, please add your name at the end of
+{{{file(AUTHORS)}}} file and respect the Listing [[auth-format]]
+format. You can update this file information for following
+contribution.
 
 #+NAME: auth-format
 #+CAPTION: =AUTHORS= file format
@@ -1289,16 +1374,17 @@ information for following contribution.
 #+CAPTION: Current =AUTHORS= file
 #+INCLUDE: "../../AUTHORS" src text
 
-[fn:p2-gitlab] The Pamhyr2 Gitlab project page:
+[fn:p2-gitlab] The {{{pamhyr2}}} Gitlab project page:
 https://gitlab.irstea.fr/theophile.terraz/pamhyr
 [fn:inrae] The INRAE web site: https://www.inrae.fr/
 
 ** Translate
 
 You can improve or add translation for the project. To contribute to
-Pamhyr2 translate, you need to use Qt Linguist[fn:qt-linguist]. Open
-Qt-linguist and edite the translation ({{{file(.ts)}}}) file, finally,
-commit the new version of file and make a merge request.
+{{{pamhyr2}}} translate, you need to use Qt
+Linguist[fn:qt-linguist]. Open Qt-linguist and edit the translation
+({{{file(.ts)}}}) file, finally, commit the new version of file and
+make a merge request.
 
 If you want add a new language, edit the script
 {{{file(src/lang/create_ts.sh)}}} like Listing [[ts-it]]. Run the script
@@ -1307,7 +1393,7 @@ and open the new file with Qt-linguist, setup target language (Figure
 file and make a merge request.
 
 #+NAME: ts-it
-#+CAPTION: Example of modified {{{file(src/lang/create_ts.sh)}}} to add italian (it) translate for Pamhyr2
+#+CAPTION: Example of modified {{{file(src/lang/create_ts.sh)}}} to add italian (it) translate for {{{pamhyr2}}}
 #+begin_src shell
   ...
   LANG="fr it"
@@ -1325,7 +1411,7 @@ https://doc.qt.io/qt-5/qtlinguist-index.html (last access 2023-09-18)
 ** Code contribution
 
 If you are developper you can improve and/or add features to
-Pamhyr2. Please, follow the architecture described in section
+{{{pamhyr2}}}. Please, follow the architecture described in section
 [[Architecture]] as closely as possible. Keep the code simple, clear and
 efficient as possible. The master branch is reserved for the project
 maintainer; you can create a new branch or fork the project before the

doc/paper/2023/simhydro/presentation/presentation.org

@@ -0,0 +1,487 @@
+# presentation.org -- Pamhyr
+# Copyright (C) 2023  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+#+STARTUP: indent hideblocks content beamer
+
+#+TITLE: SimHydro 2023
+#+SUBTITLE: \textbf{Pamhyr2}: a graphical user interface for 1D hydro-sedimentary modelling of rivers
+
+# #+AUTHOR: Pierre-Antoine Rouby
+#+LATEX_HEADER: \author[Pierre-Antoine Rouby]{\textbf{Pierre-Antoine Rouby$^{*}$}, Benoît Camenen, Lionel Pénard, Léa Kieffer, Théophile Terraz\\\texttt{<pierre-antoine.rouby@inrae.fr>}^{*}}
+#+EMAIL: pierre-antoine.rouby@inrae.fr
+#+INSTITUTE: INRAE Lyon-Villerbanne, teams River Hydraulics
+#+LATEX_HEADER: \institute{INRAE Lyon-Villerbanne, River Hydraulics team}
+#+DATE: 9th November
+
+#+KEYWORDS: g ui, hydraulics, sedimentary, hydro-sedimentary, 1D modelling, freesoftware, foss
+
+#+OPTIONS: H:2 toc:t num:t author:nil
+#+LATEX_CLASS: beamer
+#+LATEX_CLASS_OPTIONS: [slideopt,A4,showboxes,svgnames,aspectratio=169]
+# #+LATEX_CLASS_OPTIONS: [presentation]
+#+BEAMER_THEME: default
+#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col)
+
+#+LANGUAGE: fr
+#+LATEX_HEADER: \usepackage[frenchb]{babel}
+
+#+BEGIN_SRC emacs-lisp :results silent :exports none
+  (setq org-latex-pdf-process (list
+    "latexmk -pdflatex='lualatex -shell-escape -interaction nonstopmode' -pdf -f  %f"))
+
+  (add-to-list 'org-latex-packages-alist '("" "minted"))
+  (setq org-latex-listings 'minted)
+  (setq org-src-fontify-natively t)
+
+  (org-add-link-type
+   "cite" 'ebib
+   (lambda (path desc format)
+     (cond
+      ((eq format 'html)
+       (format "(<cite>%s</cite>)" path))
+      ((eq format 'text)
+       (format "[%s]" path))
+      ((eq format 'latex)
+       (if (or (not desc) (equal 0 (search "cite:" desc)))
+           (format "\\cite{%s}" path)
+         (format "\\cite[%s][%s]{%s}"
+                 (cadr (split-string desc ";"))
+                 (car (split-string desc ";"))  path))))))
+#+END_SRC
+
+#+LATEX_HEADER: \setbeamertemplate{footline}[frame number]
+#+LATEX_HEADER: \setbeamertemplate{headline}{}
+#+LATEX_HEADER: \usepackage{multirow}
+#+LATEX_HEADER: \usepackage{fontawesome5}
+#+LATEX_HEADER: \usepackage{tcolorbox}
+#+LATEX_HEADER: \usepackage{tikz}
+
+#+LATEX_HEADER: \logo{\includegraphics[width=.1\textwidth]{../../../../../src/View/ui/ressources/Logo-INRAE.png}}
+
+#+LATEX_HEADER: \newcommand{\R}[1]{\rotatebox[origin=c]{90}{#1}}
+
+# Beamer colors
+#+LATEX_HEADER: \setbeamersize{text margin left=0.5cm,text margin right=0.5cm}
+#+LATEX_HEADER: \setbeamerfont{alerted text}{series=\bfseries}
+#+LATEX_HEADER: \setbeamerfont{example text}{series=\bfseries}
+
+#+LATEX_HEADER: \definecolor{inrae_1}{RGB}{102,193,191}
+#+LATEX_HEADER: \definecolor{inrae_2}{RGB}{0,150,152}
+#+LATEX_HEADER: \definecolor{inrae_3}{RGB}{39,86,98}
+
+#+LATEX_HEADER: \setbeamercolor{alerted text}{fg=inrae_1}
+#+LATEX_HEADER: \setbeamercolor{structure}{fg=inrae_2}
+#+LATEX_HEADER: \setbeamercolor{normal text}{fg=inrae_3}
+#+LATEX_HEADER: \setbeamercolor*{author}{fg=inrae_3}
+
+#+LATEX_HEADER: \usepackage[absolute,showboxes,overlay]{textpos}
+
+#+LATEX_HEADER: \TPshowboxesfalse
+#+LATEX_HEADER: \textblockorigin{5mm}{0mm}
+
+# Biblio
+#+LATEX_HEADER: \usepackage{natbib}
+# #+LATEX_HEADER: \bibliographystyle{apalike}
+#+LATEX_HEADER: \setbeamertemplate{bibliography item}{}
+#+LATEX_HEADER: \renewcommand\bibfont{\scriptsize}
+#+LATEX_HEADER: \setbeamertemplate{frametitle continuation}[from second]
+#+LATEX_HEADER: \setbeamercolor*{bibliography entry title}{fg=inrae_3}
+#+LATEX_HEADER: \setbeamercolor*{bibliography entry author}{fg=inrae_3}
+#+LATEX_HEADER: \setbeamercolor*{bibliography entry location}{fg=inrae_3}
+
+#+LATEX_HEADER: \usepackage{bbding}
+#+LATEX_HEADER: \usepackage{pdfpages}
+
+# Renew title page
+#+LATEX_HEADER: \defbeamertemplate*{title page}{customized}[1][]
+#+LATEX_HEADER: {
+# #+LATEX_HEADER:   {
+# #+LATEX_HEADER:     \usebeamerfont{date}\usebeamercolor[fg]{date}
+# #+LATEX_HEADER:     \tikz[overlay,remember picture]
+# #+LATEX_HEADER:     \node[xshift=-1cm,yshift=-1cm,text width=10cm] at (current page.north east) {
+# #+LATEX_HEADER:        7$^{th}$ International Conference\\
+# #+LATEX_HEADER:        8TH-10TH November\\
+# #+LATEX_HEADER:        EDF Lab - CHATOU, FRANCE
+# #+LATEX_HEADER:     }
+# #+LATEX_HEADER:   }
+#+LATEX_HEADER:   {
+#+LATEX_HEADER:     \usebeamerfont{title}\inserttitle\par
+#+LATEX_HEADER:     \usebeamerfont{title}\usebeamercolor[fg]{title}
+#+LATEX_HEADER:     \large New modeling paradigms for water issues?\par
+#+LATEX_HEADER:   }
+#+LATEX_HEADER:   \bigskip
+#+LATEX_HEADER:   \begin{center}
+#+LATEX_HEADER:     \usebeamerfont{subtitle}\usebeamercolor[fg]{subtitle}
+#+LATEX_HEADER:     {
+#+LATEX_HEADER:       \LARGE\insertsubtitle\par
+#+LATEX_HEADER:     }
+#+LATEX_HEADER:     \bigskip
+#+LATEX_HEADER:     \usebeamerfont{author}\usebeamercolor[fg]{author}\insertauthor\par
+#+LATEX_HEADER:     \bigskip
+#+LATEX_HEADER:     \usebeamerfont{institute}\usebeamercolor[fg]{institute}\insertinstitute\par
+#+LATEX_HEADER:     \bigskip
+#+LATEX_HEADER:     \usebeamerfont{date}\usebeamercolor[fg]{date}\insertdate\par
+#+LATEX_HEADER:     \usebeamercolor[fg]{titlegraphic}\inserttitlegraphic
+#+LATEX_HEADER:   \end{center}
+#+LATEX_HEADER: }
+
+# #+LATEX_HEADER: \newcommand{\tred}[1]{\textcolor{rouge_inrae}{#1}}
+
+#+TODO: TODO WIP TOREVIEW | DONE
+
+#+MACRO: pamhyr \textsc{PAMHyR}
+#+MACRO: pamhyr2 \textsc{Pamhyr2}
+
+#+MACRO: pause \pause
+#+MACRO: framebreak \framebreak
+#+MACRO: no
+# #+MACRO: OK  \checkmark
+#+MACRO: OK  \faIcon{check}
+#+MACRO: bf \textbf{$1}
+
+# #+latex: \frame{\tocpage}
+
+* 1D hydro-sedimentary simulation at INRAE
+** COMMENT 1D river flow simulation
+*** INRAE (Lyon-Villerbanne)
+
+- Mage [fn:: Mage: https://gitlab.irstea.fr/jean-baptiste.faure/mage]
+- RubarBE [fn:: RubarBE:
+  https://gitlab.irstea.fr/theophile.terraz/rubarbe]
+
+*** Other project
+
+- Mascaret [fn:: OpenTeleMac: http://www.opentelemac.org]
+- HEC-RAS [fn:: HEC-RAS:
+  https://www.hec.usace.army.mil/software/hec-ras]
+- Mike 11 [fn:: Mike11:
+  https://www.mikepoweredbydhi.com/products/mike-11]
+
+** {{{pamhyr}}}
+#+BEGIN_EXPORT latex
+\tikz[overlay,remember picture]
+\node[xshift=-4cm,yshift=4cm] at (current page.south east) {
+  \includegraphics[width=7cm]{../images/PAMHyR.png}
+};
+#+END_EXPORT
+
+{{{pamhyr}}} developed at INRAE in Java since the end of 90s
+
+*** Features
+- Graphical user interface
+- Define and edit complexe 1D river models
+- Run a solver
+- Visualize simulation results
+
+*** Compatibility
+- 2 solvers *Mage and RubarBE*
+# - Multi-reaches (Only for Mage)
+- Multi-platform (Linux / Windows)
+
+** {{{pamhyr}}}
+#+BEGIN_EXPORT latex
+\tikz[overlay,remember picture]
+\node[xshift=-4cm,yshift=4cm] at (current page.south east) {
+  \includegraphics[width=7cm]{../images/PAMHyR.png}
+};
+#+END_EXPORT
+
+*** Conception issues
+- Monolingual French
+- Interface too different for each solver
+- Impossible to undo an action
+
+*** Huge technical debts
+- Out dated technologies (UML $\to$ Java)
+- Unmaintained library
+- Unstable development process
+
+Hard to maintain or add features to the interface
+
+(No modification since 2016)
+
+* Presentation of {{{pamhyr2}}}
+** {{{Pamhyr2}}} - Needs - General constraints
+
+Create a new version of {{{pamhyr}}} called {{{pamhyr2}}}
+
+{{{pause}}}
+
+*** Constraints for users experience
+:PROPERTIES:
+:BEAMER_COL: 0.5
+:BEAMER_ENV: block
+:END:
++ *User friendly*
++ *Multi platform* (at least Linux and Windows)
++ *Multi language* (at least English and French)
++ *Multi solver* (as much as possible, at least Mage and
+  RubarBE)
++ *Single save file* per study
+
+{{{pause}}}
+
+*** Constraints for developers experience
+:PROPERTIES:
+:BEAMER_COL: 0.5
+:BEAMER_ENV: block
+:END:
+- *Common used* code library and tools
+# - *Modular* and *flexible* code
+- *Clear* architecture
+- *Free and open sources software* (FOSS)
+
+** {{{Pamhyr2}}} - Needs - Features
+# #+BEGIN_EXPORT latex
+# \tikz[overlay,remember picture]
+# \node[xshift=-5cm,yshift=-2cm] at (current page.north east) {
+#   \includegraphics[width=6cm]{../images/geometry_saar.png}
+# };
+# #+END_EXPORT
+
+**** {{{no}}}
+:PROPERTIES:
+:BEAMER_COL: 0.30
+:BEAMER_ENV: block
+:END:
+- Define and edit data
+  + River network
+  + Geometry
+  + Boundary conditions
+  + Friction
+  + Initial conditions
+  + *Sedimentary layers*
+- User meshed geometry
+- Run a solver
+- Display results
+  + Default visualisation
+  + *Customized visualisation*
+
+**** {{{no}}}
+:PROPERTIES:
+:BEAMER_COL: 0.70
+:BEAMER_ENV: block
+:END:
+[[../images/geometry_saar.png]]
+
+** {{{pamhyr2}}} - Technical choices
+#+BEGIN_EXPORT latex
+\tikz[overlay,remember picture]
+\node[xshift=-9.3cm,yshift=-4cm] at (current page.north east) {
+  \includegraphics[width=6.3cm]{../images/BC.png}
+};
+#+END_EXPORT
+
+*** Technologies
+:PROPERTIES:
+:BEAMER_COL: 0.60
+:BEAMER_ENV: block
+:END:
+- *Python*
+- *PyQt*
+- Qt Designer
+- Qt Linguist
+- *Matplotlib*
+- SQLite (as =*.pamhyr=)
+- *GPLv3* license (strong copyleft)
+
+*** Architecture
+:PROPERTIES:
+:BEAMER_COL: 0.35
+:BEAMER_ENV: block
+:END:
+- Qt Model/View
+- Multiple solvers configuration
+- *Unified interface*, as much as possible
+
+** {{{pamhyr2}}} - State of the project
+#+BEGIN_EXPORT latex
+\tikz[overlay,remember picture]
+\node[xshift=-4.5cm,yshift=-2.5cm] at (current page.north east) {
+  \includegraphics[width=8cm]{../images/apply_sedi.png}
+};
+#+END_EXPORT
+
+*** {{{no}}}
+:PROPERTIES:
+:BEAMER_COL: 0.40
+:BEAMER_ENV: block
+:END:
+
+\vspace{-1.5cm}
+
+\begin{center}
+\emph{Last version:} \texttt{v0.0.3}
+\end{center}
+
+{{{pause}}}
+
+#+latex: \begin{center}
+#+latex: \resizebox{0.9\columnwidth}{!}{
+# #+caption: Tools by methods
+#+name: tab:current-state
+#+attr_latex: :align |l|c|
+|---------------------------------+-----------------|
+| {{{bf(Features)}}}              | {{{bf(State)}}} |
+|---------------------------------+-----------------|
+| Create save and load study      | {{{OK}}}        |
+| *Undo/Redo actions*             | {{{OK}}}        |
+| Edit river network              | {{{OK}}}        |
+| Edit geometry                   | {{{OK}}}        |
+| Edit boundary conditions        | {{{OK}}}        |
+| Edit lateral contributions      | {{{OK}}}        |
+| Edit frictions (Stricklers)     | {{{OK}}}        |
+| Edit initial conditions         | {{{OK}}}        |
+| *Edit sedimentary layers*       | {{{OK}}}        |
+| Edit hydraulics structures      |                 |
+| Edit suspended sediment         |                 |
+| Edit polluant                   |                 |
+| Use meshing tool                | WIP             |
+| Run a solver                    | {{{OK}}}        |
+| Read and display results        | {{{OK}}}        |
+| Customize results visualisation | WIP             |
+| Generic solver input/output     |                 |
+|---------------------------------+-----------------|
+#+latex: }
+#+latex: \end{center}
+
+{{{pause}}}
+
+*** {{{no}}}
+:PROPERTIES:
+:BEAMER_COL: 0.60
+:BEAMER_ENV: block
+:END:
+
+\vspace{2.5cm}
+
+#+latex: \begin{center}
+#+latex: \resizebox{0.8\columnwidth}{!}{
+# #+caption: Tools by methods
+#+name: tab:current-state-solver
+#+attr_latex: :align |l|c|c|c|
+|----------------------------+----------------+-------------------+--------------------|
+| {{{bf(Usage)}}}            | {{{bf(Mage)}}} | {{{bf(RubarBE)}}} | {{{bf(Mascaret)}}} |
+|----------------------------+----------------+-------------------+--------------------|
+| *Hydraulics* (mono reach)  | {{{OK}}}       |                   | {{{OK}}}           |
+| *Hydraulics* (multi reach) | {{{OK}}}       |                   |                    |
+| *Bed load evolution*       | {{{OK}}}       |                   |                    |
+|----------------------------+----------------+-------------------+--------------------|
+#+latex: }
+#+latex: \end{center}
+
+# #+LaTeX: \vspace{0.3cm}
+
+#+latex: \begin{center}
+#+latex: \resizebox{0.6\columnwidth}{!}{
+# #+caption: Tools by methods
+#+name: tab:current-state-package
+#+attr_latex: :align |l|c|c|
+|--------------------+---------------------+-------------------|
+| {{{bf(Packages)}}} | {{{bf(GNU/Linux)}}} | {{{bf(Windows)}}} |
+|--------------------+---------------------+-------------------|
+| Archive (tar/zip)  | {{{OK}}}            | {{{OK}}}          |
+| Installer          |                     | {{{OK}}}          |
+|--------------------+---------------------+-------------------|
+#+latex: }
+#+latex: \end{center}
+
+* Future work and perspective
+** Future work
+#+BEGIN_EXPORT latex
+\tikz[overlay,remember picture]
+\node[xshift=-4.8cm,yshift=-3.8cm] at (current page.north east) {
+  \includegraphics[width=8.7cm]{../images/results_hydro.png}
+};
+#+END_EXPORT
+
+*** Next step
+- *Meshing tools integration*
+- *Custom results visualisation*
+  + Python + matplotlib script
+- RubarBE integration
+- Hydraulics structures
+- Unified graphics theme
+
+*** Open questions
+- Generic solver input/output (HDF5? CGNS? SQLite?)
+- GNU/Linux packages (Pip? Conda? Guix? Deb?)
+
+** Contribution
+#+LaTeX: \begin{center}
+\faIcon{gitlab} https://gitlab.irstea.fr/theophile.terraz/pamhyr/
+#+LaTeX: \end{center}
+
+*** For users
+:PROPERTIES:
+:BEAMER_COL: 0.45
+:BEAMER_ENV: block
+:END:
+- Try {{{pamhyr2}}}
+- Report bug
+- Propose improvement
+- Improve translation
+- Improve user documentation
+- Improve tests cases examples
+- /Find better project name/
+
+*** For developers
+:PROPERTIES:
+:BEAMER_COL: 0.45
+:BEAMER_ENV: block
+:END:
+- Add new solver / features
+- Improve sources code
+- Improve developers documentation
+- Improve unit tests
+
+# * Conclusion
+** Thanks for listening
+# #+BEGIN_EXPORT latex
+# \tikz[overlay,remember picture]
+# \node[xshift=-6cm,yshift=-1.5cm,text width=10cm] at (current page.north east) {
+#    {\small\emph{\alert{Journées de la modélisation 1D hydro-sédimentaire} (in french) -}
+#    \emph{30 \& 31 janvier 2024, INRAE Villeurbanne - }
+#    \emph{Information and inscription: }\texttt{<benoit.camenen@inrae.fr>}}
+# };
+# #+END_EXPORT
+
+#+LaTeX: \begin{center}
+\faIcon{gitlab} https://gitlab.irstea.fr/theophile.terraz/pamhyr/
+#+LaTeX: \end{center}
+
+#+LaTeX: \begin{center}
+/*Journées de la modélisation 1D hydro-sédimentaire*/ (in French)
+#+LaTeX: \\
+/30 & 31 janvier 2024/, INRAE Villeurbanne
+#+LaTeX: \\
+Information and registration: =<benoit.camenen@inrae.fr>=
+#+LaTeX: \end{center}
+
+- {{{pamhyr2}}} developers:
+  + =<pierre-antoine.rouby@inrae.fr>=,
+  + =<theophile.terraz@inrae.fr>=
+- Mage/RubarBE developer:
+  + =<theophile.terraz@inrae.fr>=
+
+# #+LaTeX: \vspace{0.5cm}
+# #+LaTeX: \begin{center}
+# #+LaTeX: {\Large
+# *Thanks for listening*
+# #+LaTeX: }
+# #+LaTeX: \end{center}

doc/tools/PamhyrDoc.cls

@@ -11,7 +11,8 @@
 \usepackage[absolute]{textpos}
 \usepackage{titlesec}
 \usepackage{amssymb}
-\usepackage{tcolorbox}
+\usepackage[minted,xparse,breakable]{tcolorbox}
+\usepackage{pmboxdraw}
 
 \usepackage{enumitem}
 \setlist[enumerate]{itemsep=-0.5em}
@@ -133,6 +134,7 @@
 \setminted[c]{fontsize=\footnotesize,encoding=utf8,linenos}
 \setminted[c++]{breaklines,fontsize=\footnotesize,encoding=utf8,linenos}
 \setminted[python]{breaklines,fontsize=\footnotesize,encoding=utf8,linenos}
+\setminted[sql]{breaklines,fontsize=\footnotesize,encoding=utf8,linenos}
 \setminted[shell]{breaklines,fontsize=\footnotesize,encoding=utf8}
 \setminted[scheme]{breaklines,fontsize=\footnotesize,encoding=utf8}
 \setminted[commun-lisp]{breaklines,fontsize=\footnotesize,encoding=utf8}
@@ -140,7 +142,7 @@
 \setminted[llvm]{breaklines,fontsize=\footnotesize,encoding=utf8}
 
 %% Add box arrond of minted
-\BeforeBeginEnvironment{minted}{\begin{tcolorbox}[boxsep=0pt, left=0.1cm, right=0.1cm, arc=0pt, boxrule=0.5pt, colback=white]}%
+\BeforeBeginEnvironment{minted}{\begin{tcolorbox}[breakable, boxsep=0pt, left=0.1cm, right=0.1cm, arc=0pt, boxrule=0.5pt, colback=white]}%
 \AfterEndEnvironment{minted}{\end{tcolorbox}}%
 
 \makeatletter
@@ -161,3 +163,7 @@
 \SetWatermarkScale{3}
 \SetWatermarkFontSize{1cm}
 \SetWatermarkText{Work in progress}
+
+%% Icons
+
+\usepackage{fontawesome5}

doc/tools/macro.org

@@ -17,11 +17,15 @@
 # -*- coding: utf-8 -*-
 
 # Constant name
-#+MACRO: oldPamhyr     PAMHyR
-#+MACRO: Pamhyr        Pamhyr2
-#+MACRO: Mage          Mage
-#+MACRO: Rubarbe       RubarBE
-#+MACRO: Inrae         INRAE
+#+MACRO: pamhyr        \textsc{PAMHyR}
+#+MACRO: pamhyr2       \textsc{Pamhyr2}
+#+MACRO: mage          \textsc{Mage}
+#+MACRO: mage7         \textsc{Mage7}
+#+MACRO: mage8         \textsc{Mage8}
+#+MACRO: rubarbe       \textsc{RubarBE}
+#+MACRO: adists        \textsc{AdisTS}
+#+MACRO: mascaret      \textsc{Mascaret}
+#+MACRO: inrae         INRAE
 #+MACRO: latex         \LaTeX
 
 # Information
@@ -35,6 +39,16 @@
 #+MACRO: cite          [cite:$1]
 #+MACRO: biblio        \bibliography{documentation}
 
+# Icons
+#+MACRO: bulb \faIcon{lightbulb}
+#+MACRO: OK  \faIcon{check}
+
+#+MACRO: linux  \faIcon{linux}
+#+MACRO: windows  \faIcon{windows}
+
+#+MACRO: python  \faIcon{python}
+#+MACRO: java  \faIcon{java}
+
 # Wrapper
 #+NAME: attr_wrap
 #+HEADER: :var width="\\textwidth"

doc/users/Tuto1/build.sh

@@ -0,0 +1,6 @@
+#! /bin/sh
+
+pdflatex -no-shell-escape step-by-step.tex
+pdflatex -no-shell-escape step-by-step.tex
+pdflatex -no-shell-escape pas-a-pas.tex
+pdflatex -no-shell-escape pas-a-pas.tex

doc/users/Tuto1/data/Bief_1.ST

@@ -65,7 +65,8 @@
    31874.0000      14.5000      22.1900 
    31874.0000      17.6000      22.9900 
      999.9990     999.9990     999.9990 
-     7     0     0     7   31875.0000   PontRD101m
+     7     0     0     9   31875.0000   PontRD101m
+   31875.0000       0.5400      23.0000 
    31875.0000       0.5400      21.8900 
    31875.0000       2.5000      19.6900 rg
    31875.0000       2.5000      18.6900 
@@ -73,8 +74,10 @@
    31875.0000      10.7000      18.9900 
    31875.0000      10.7000      19.9900 rd
    31875.0000      13.8900      21.8900 
+   31875.0000      13.8900      23.0000 
      999.9990     999.9990     999.9990 
-     8     0     0     7   31885.0000   PontRD101v
+     8     0     0     9   31885.0000   PontRD101v
+   31885.0000       0.5400      23.0000 
    31885.0000       0.5400      21.8900 
    31885.0000       2.5000      19.6900 rg
    31885.0000       2.5000      18.6900 
@@ -82,6 +85,7 @@
    31885.0000      10.7000      18.9900 
    31885.0000      10.7000      19.9900 rd
    31885.0000      13.8900      21.8900 
+   31885.0000      13.8900      23.0000 
      999.9990     999.9990     999.9990 
      9     0     0     9   31886.0000   
    31886.0000       0.0000      22.9900 
@@ -303,7 +307,8 @@
    34334.0000      14.0000      18.1000 rd
    34334.0000      16.1000      21.1300 
      999.9990     999.9990     999.9990 
-    26     0     0     7   34335.0000   PontmThivencelle
+    26     0     0     9   34335.0000   PontmThivencelle
+   34335.0000       2.9000      22.0000 
    34335.0000       2.9000      20.7400 
    34335.0000       2.9000      18.2900 rg
    34335.0000       6.4000      17.7900 
@@ -311,8 +316,10 @@
    34335.0000      12.8000      17.2600 
    34335.0000      12.8000      18.3100 rd
    34335.0000      12.8000      20.7400 
+   34335.0000      12.8000      22.0000 
      999.9990     999.9990     999.9990 
-    27     0     0     7   34343.0000   PontvThivencelle
+    27     0     0     9   34343.0000   PontvThivencelle
+   34343.0000       2.9000      22.0000 
    34343.0000       2.9000      20.7400 
    34343.0000       2.9000      18.2900 rg
    34343.0000       6.4000      17.7900 
@@ -320,6 +327,7 @@
    34343.0000      12.8000      17.2600 
    34343.0000      12.8000      18.2900 rd
    34343.0000      12.8000      20.7400 
+   34343.0000      12.8000      22.0000 
      999.9990     999.9990     999.9990 
     28     0     0    10   34345.0000   avalPontThivencell
    34345.0000       0.0000      21.3600 

doc/users/Tuto1/data/Cote_canal

@@ -1,2 +0,0 @@
-0:00:00:00	15
-0:00:01:00	15

doc/users/Tuto1/data/Hogneau.SIN

@@ -1,25 +0,0 @@
-**************** SINGULARITES **********************
-*BieSec Nb Longueur  Cote dev Cote charg Coef deb            Impression         
-*===---===----------==========----------==========----------------------------- 
-*****************************************************
-* Bief n°  1
-*****************************************************
-* Ouvrage au pk 36270.0  seuil_aval
-*SeuilR type D
-D  1  36270.00    18.250    15.500     0.000     0.400 99999.000 seuil palplanches
-* Ouvrage au pk 31875.0  PontRS101
-*OrificeR type O
-O  1  31875.00     9.660    18.710    21.890     0.400  9999.000 
-*SeuilR type D
-D  1  31875.00    14.000    22.890     0.000     0.400 99999.000 
-* Ouvrage au pk 34335.0  PontThivencelle
-*SeuilR type D
-D  1  34335.00    13.000    21.740     0.000     0.400 99999.000 
-*OrificeR type O
-O  1  34335.00     9.070    17.280    20.740     0.400  9999.000 
-*****************************************************
-* Bief n°  3
-*****************************************************
-* Ouvrage au pk 0.0  Orifice
-*OrificeR type O
-*O  3     0.000     6.000    19.000    19.001     0.400    20.000 Clapet_001

doc/users/Tuto1/data/Hogneau.var

@@ -1 +0,0 @@
-$Clapet_001  clapet

doc/users/Tuto1/data/Q_permanent

@@ -1,2 +0,0 @@
-0:00:00:00	4
-0:00:01:00	4

doc/users/Tuto1/data/Seuil_aval_23m

@@ -1,24 +0,0 @@
-16,03	0
-16,13	1,29
-16,23	3,64
-16,33	6,7
-16,43	10,31
-16,53	14,41
-16,63	18,94
-16,73	23,87
-16,83	29,16
-16,93	34,79
-17,03	40,75
-17,13	47,01
-17,23	53,57
-17,33	60,4
-17,43	67,5
-17,53	74,86
-17,63	82,47
-17,73	90,33
-17,83	98,41
-17,93	106,73
-18,03	115,26
-18,13	124,01
-18,23	132,98
-18,33	142,14