From 07b58e9c4b7a3b28f7442caad8341c2592756513 Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@irstea.fr>
Date: Tue, 16 Feb 2021 10:05:02 +0100
Subject: [PATCH] doc(bief): add page for Up/downstream elevations of a reach
 module

Fix #490
---
 docs/en/calculators/hsl/cote_amont_aval.md | 11 +++++++++++
 docs/fr/calculators/hsl/cote_amont_aval.md | 12 ++++++++++++
 mkdocs-en.yml                              |  1 +
 mkdocs-fr.yml                              |  1 +
 src/app/calculators/bief/config.json       |  2 +-
 5 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 docs/en/calculators/hsl/cote_amont_aval.md
 create mode 100644 docs/fr/calculators/hsl/cote_amont_aval.md

diff --git a/docs/en/calculators/hsl/cote_amont_aval.md b/docs/en/calculators/hsl/cote_amont_aval.md
new file mode 100644
index 000000000..98d642901
--- /dev/null
+++ b/docs/en/calculators/hsl/cote_amont_aval.md
@@ -0,0 +1,11 @@
+# Upstream / downstream elevations of a reach
+
+This module is based on the equations of the [backwater curves module](courbe_remous.md) and is used to calculate the following:
+
+- The water elevation upstream of a reach of a fluvial backwater curve;
+- The water elevation downstream of a reach of a torrential backwater curve;
+- The flow that connects the upstream and downstream water elevations of a fluvial or torrential backwater curve.
+
+The regime chosen on the type of water line determines whether the calculation is made from downstream to upstream (fluvial regime) and from upstream to downstream (torrential regime).
+
+This calculation module is particularly useful for calculating the water line of a series of hydraulic structures or reaches (see the typical example "Flow of a channel with structures").
diff --git a/docs/fr/calculators/hsl/cote_amont_aval.md b/docs/fr/calculators/hsl/cote_amont_aval.md
new file mode 100644
index 000000000..a3f27e286
--- /dev/null
+++ b/docs/fr/calculators/hsl/cote_amont_aval.md
@@ -0,0 +1,12 @@
+# Cotes amont / aval d'un bief
+
+Ce module basé sur les équations du [module de calcul des courbes de remous](courbe_remous.md) permet de calculer&nbsp;:
+
+- La cote de l'eau à l'amont d'un bief d'une courbe de remous fluviale&nbsp;
+- La cote de l'eau à l'aval d'un bief d'une courbe de remous torrentielle&nbsp;
+- Le débit permettant de relié les cotes de l'eau amont et aval d'une courbe de remous fluviale ou torrentielle.
+
+Le régime choisi sur le type de ligne d'eau détermine si le calcul s'effectue de l'aval vers l'amont (régime fluvial) et de l'amont vers l'aval (régime torrentiel).
+
+Ce module de calcul est particulièrement utile pour calculer la ligne d'eau d'un enchaînement de ouvrages hydrauliques ou de biefs (Voir l'exemple type "Débit d'un chenal avec ouvrages").
+
diff --git a/mkdocs-en.yml b/mkdocs-en.yml
index 409dc0282..fc9fc321d 100644
--- a/mkdocs-en.yml
+++ b/mkdocs-en.yml
@@ -32,6 +32,7 @@ nav:
     - Open-channel flow:
         - Uniform flow: calculators/hsl/regime_uniforme.md
         - calculators/hsl/courbe_remous.md
+        - calculators/hsl/cote_amont_aval.md
         - calculators/hsl/section_parametree.md
         - calculators/hsl/pente.md
         - calculators/hsl/types_sections.md
diff --git a/mkdocs-fr.yml b/mkdocs-fr.yml
index 947cffb05..e32b6f3f8 100644
--- a/mkdocs-fr.yml
+++ b/mkdocs-fr.yml
@@ -32,6 +32,7 @@ nav:
     - Hydraulique à surface libre:
         - Régime uniforme: calculators/hsl/regime_uniforme.md
         - calculators/hsl/courbe_remous.md
+        - calculators/hsl/cote_amont_aval.md
         - calculators/hsl/section_parametree.md
         - calculators/hsl/pente.md
         - calculators/hsl/types_sections.md
diff --git a/src/app/calculators/bief/config.json b/src/app/calculators/bief/config.json
index 399d8a25f..95f2ca549 100644
--- a/src/app/calculators/bief/config.json
+++ b/src/app/calculators/bief/config.json
@@ -70,6 +70,6 @@
         "type": "options",
         "defaultNodeType": "SectionRectangle",
         "selectIds": [ "select_section", "select_regime" ],
-        "help": "hsl/bief.html"
+        "help": "hsl/cote_amont_aval.html"
     }
 ]
\ No newline at end of file
-- 
GitLab