From 368b48d2a34d54af263e6e706a221727d04436e7 Mon Sep 17 00:00:00 2001 From: Jean-Pascal <jean-pascal.aubry@inrae.fr> Date: Wed, 9 Oct 2024 14:33:37 +0000 Subject: [PATCH 01/10] fix: correct footnotes error in PDF documentation Refs #655 --- docs/en/calculators/devalaison/grille.md | 18 +++++----- docs/en/calculators/pam/concentration.md | 4 +-- docs/en/calculators/pam/macrorugo.md | 4 +-- docs/en/calculators/pam/macrorugo_theorie.md | 34 +++++++++---------- docs/en/calculators/par/theorie_fatou.md | 12 +++---- docs/en/calculators/par/theorie_mixte.md | 10 +++--- docs/en/calculators/par/theorie_plans.md | 12 +++---- docs/en/calculators/par/theorie_suractif.md | 10 +++--- docs/en/calculators/structures/cunge_80.md | 6 ++-- .../en/calculators/structures/dever_triang.md | 12 +++---- docs/fr/calculators/devalaison/grille.md | 18 +++++----- docs/fr/calculators/pam/concentration.md | 4 +-- docs/fr/calculators/pam/macrorugo.md | 4 +-- docs/fr/calculators/pam/macrorugo_theorie.md | 34 +++++++++---------- docs/fr/calculators/par/theorie_fatou.md | 12 +++---- docs/fr/calculators/par/theorie_mixte.md | 10 +++--- docs/fr/calculators/par/theorie_plans.md | 12 +++---- docs/fr/calculators/par/theorie_suractif.md | 10 +++--- docs/fr/calculators/structures/cunge_80.md | 6 ++-- .../fr/calculators/structures/dever_triang.md | 12 +++---- 20 files changed, 122 insertions(+), 122 deletions(-) diff --git a/docs/en/calculators/devalaison/grille.md b/docs/en/calculators/devalaison/grille.md index fbff1dcdc..9570a067e 100644 --- a/docs/en/calculators/devalaison/grille.md +++ b/docs/en/calculators/devalaison/grille.md @@ -9,7 +9,7 @@ and the intake width \(B\) upstream the trashrack: $$ V_1 = \frac{Q}{H_1 \times B} $$ -The calculation of the head loss coefficient \(\xi\) is based on the characteristics of the trashrack. For a full description of the assumptions, formulas and limitations of the method, please refer to the Raynal et al. (2012) report[^1] available here (in French): https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +The calculation of the head loss coefficient \(\xi\) is based on the characteristics of the trashrack. For a full description of the assumptions, formulas and limitations of the method, please refer to the Raynal et al. (2012) report[^Raynal2012] available here (in French): https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf <div style="position: relative"><a id="grille-conventionnelle" style="position: absolute; top: -60px;"></a></div> @@ -19,7 +19,7 @@ Conventional trashracks: perpendicular to the flow and slightly inclined to the ### Formula -Use of the F1 formula of Raynal et al (2012)[^1] to calculate the head losses. +Use of the F1 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses. $$\xi = a * K_O * K_\beta$$ @@ -56,7 +56,7 @@ Flow-oriented and near-vertical trashracks. ### Formula -Use of the F2 formula of Raynal et al (2012)[^1] to calculate the head losses (Also in Equation (7) of Raynal et al. (2013)[^2]). +Use of the F2 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses (Also in Equation (7) of Raynal et al. (2013)[^Raynal_P2_2013]). $$\xi = a * K_O * K_\alpha$$ @@ -82,7 +82,7 @@ trashracks perpendicular to the flow, and inclined with respect to the horizonta ### Formula -Use of the F3 formula of Raynal et al (2012)[^1] to calculate the head losses (Also in Equation (11) of Raynal et al. (2013)[^3]). +Use of the F3 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses (Also in Equation (11) of Raynal et al. (2013)[^Raynal_P1_2013]). $$\xi = a * K_b * K_\beta + K_{Fent} * K_{entH}$$ @@ -216,7 +216,7 @@ The shape coefficient of the bars \(c\) is 1.69 for the rectangular profile (PR) | | <img src="ge.png" alt="Droplet" style="width:65px;height:289px;"> | <img src="pletina.png" alt="Plétina" style="width:65px;height:289px;"> | <img src="tadpole8.png" alt="Tadpole 8" style="width:65px;height:289px;"> | <img src="tadpole10.png" alt="Tadpole 10" style="width:65px;height:289px;"> | <img src="hydrodynamique.png" alt="Hydrodynamique" style="width:65px;height:289px;"> | <img src="rec.png" alt="Rectangulaire" style="width:65px;height:289px;"> | | Bar coefficient $A_i$| 2.47 | 1.75 | 1.27 | 1.79 | 2.10 | 3.85 | -After Lemkecher et al. (2020)[^4] +After Lemkecher et al. (2020)[^Lemkecher2020] <div style="position: relative"><a id="coefficient-de-forme-moyen-des-entretoises-et-elements-transversaux-ponderes-selon-leurs-parts-respectives" style="position: absolute; top: -60px;"></a></div> ### Average shape coefficient of spacers and transverse elements, weighted according to their respective shares @@ -227,10 +227,10 @@ To be determined from the trashrack plans. For example, 1.79 for cylindrical spacers, 2.42 for rectangular spacers, and around 4 for square beams and IPNs. -[^1]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +[^Raynal2012]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf -[^2]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 +[^Raynal_P2_2013]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 -[^3]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 +[^Raynal_P1_2013]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 -[^4]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 +[^Lemkecher2020]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 diff --git a/docs/en/calculators/pam/concentration.md b/docs/en/calculators/pam/concentration.md index 347267607..9666b3cd5 100644 --- a/docs/en/calculators/pam/concentration.md +++ b/docs/en/calculators/pam/concentration.md @@ -13,9 +13,9 @@ It allows to calculate one of the following values:  -*Excerpt from Larinier et al., 2006[^1]* +*Excerpt from Larinier et al., 2006[^Larinier2006]* -[^1]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 The spacing between the blocks is then calculated with the following formula: diff --git a/docs/en/calculators/pam/macrorugo.md b/docs/en/calculators/pam/macrorugo.md index 0efc4e042..0382a13ff 100644 --- a/docs/en/calculators/pam/macrorugo.md +++ b/docs/en/calculators/pam/macrorugo.md @@ -4,9 +4,9 @@ The rock-ramp fishpass calculation module makes it possible to calculate the cha  -*Excerpt from Larinier et al., 2006[^1]* +*Excerpt from Larinier et al., 2006[^Larinier2006]* -[^1]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 The tool allows you to calculate one of the following values: diff --git a/docs/en/calculators/pam/macrorugo_theorie.md b/docs/en/calculators/pam/macrorugo_theorie.md index 5ea81ee43..b87f6cbcd 100644 --- a/docs/en/calculators/pam/macrorugo_theorie.md +++ b/docs/en/calculators/pam/macrorugo_theorie.md @@ -1,12 +1,12 @@ # Calculation of the flow rate of a rock-ramp pass -The calculation of the flow rate of a rock-ramp pass corresponds to the implementation of the algorithm and the equations present in Cassan et al. (2016)[^1]. +The calculation of the flow rate of a rock-ramp pass corresponds to the implementation of the algorithm and the equations present in Cassan et al. (2016)[^Cassan2016]. ## General calculation principle  -*After Cassan et al., 2016[^1]* +*After Cassan et al., 2016[^Cassan2016]* There are three possibilities: @@ -116,7 +116,7 @@ $$V = \frac{Q}{B \times h}$$ ### Average speed between blocks *V<sub>g</sub>* -From Eq. 1 Cassan et al (2016)[^1] and Eq. 1 Cassan et al (2014)[^2]: +From Eq. 1 Cassan et al (2016)[^Cassan2016] and Eq. 1 Cassan et al (2014)[^Cassan2014]: $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ @@ -124,7 +124,7 @@ $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ ### Drag coefficient of a single block *C<sub>d0</sub>* \(C_{d0}\) is the drag coefficient of a block considering a single block -infinitely high with \(F << 1\) (Cassan et al, 2014[^2]). +infinitely high with \(F << 1\) (Cassan et al, 2014[^Cassan2014]). | Block shape | Cylinder | "Rounded face" shape | Square-based parallelepiped | "Flat face" shape | @@ -132,7 +132,7 @@ infinitely high with \(F << 1\) (Cassan et al, 2014[^2]). | |  |  |  |  | | Value of \(C_{d0}\) | 1.0 | 1.2-1.3 | 2.0 | 2.2 | -When establishing the statistical formulae for the 2006 technical guide (Larinier et al. 2006[^4]), the definition of the block shapes to be tested was based on the use of quarry blocks with neither completely round nor completely square faces. +When establishing the statistical formulae for the 2006 technical guide (Larinier et al. 2006[^Larinier2006]), the definition of the block shapes to be tested was based on the use of quarry blocks with neither completely round nor completely square faces. The so-called "rounded face" shape was thus not completely cylindrical, but had a trapezoidal bottom face (seen in plan). Similarly, the "flat face" shape was not square in cross-section, but also had a trapezoidal bottom face. These differences in shape between the "rounded face" and a true cylinder on the one hand, and the "flat face" and a true parallelepiped with a square base on the other hand, result in slight differences between them in the shape coefficients \(C_{d0}\). @@ -140,13 +140,13 @@ These differences in shape between the "rounded face" and a true cylinder on the ### Block shape coefficient *σ* -Cassan et al. (2014)[^2], et Cassan et al. (2016)[^1] define \(\sigma\) as the ratio between the +Cassan et al. (2014)[^Cassan2014], et Cassan et al. (2016)[^Cassan2016] define \(\sigma\) as the ratio between the block area in the \(x,y\) plane and \(D^2\). For the cylindrical form of the blocks, \(\sigma\) is equal to \(\pi / 4\) and for a square block, \(\sigma = 1\). ### Ratio between the average speed downstream of a block and the maximum speed *r* -The values of \(r\) depends on the block shapes (Cassan et al., 2014[^2] et Tran et al. 2016 [^3]): +The values of \(r\) depends on the block shapes (Cassan et al., 2014[^Cassan2014] et Tran et al. 2016 [^Tran2016]): - round : \(r_Q=1.1\) - "rounded face" shape : \(r=1.2\) @@ -163,7 +163,7 @@ $$F = \frac{V_g}{\sqrt{gh}}$$ ### Froude-related drag coefficient correction function *f<sub>F</sub>(F)* -If \(F < 1\) (Eq. 19, Cassan et al., 2014[^2]): +If \(F < 1\) (Eq. 19, Cassan et al., 2014[^Cassan2014]): $$f_F(F) = \min \left( \frac{r}{1- \frac{F_{g}^{2}}{4}}, \frac{1}{F^{\frac{2}{3}}} \right)^2$$ @@ -171,14 +171,14 @@ otherwise \(f_F(F) = 1\) because a torrential flow upstream of the blocks is the ### Maximum speed *u<sub>max</sub>* -According to equation 19 of Cassan et al, 2014[^2] : +According to equation 19 of Cassan et al, 2014[^Cassan2014] : $$ u_{max} = V_g \sqrt{f_F(F)} $$ ### Drag coefficient correction function linked to relative depth *f<sub>h\*</sub>(h<sub>\*</sub>)* -The equation used in Cassiopeia differs slightly from equation 20 of Cassan et al. 2014[^2] and equation 6 of Cassan et al. 2016[^1]. -This formula is a fit to the experimental measurements on circular blocks used in Cassan et al. 2016[^1]: +The equation used in Cassiopeia differs slightly from equation 20 of Cassan et al. 2014[^Cassan2014] and equation 6 of Cassan et al. 2016[^Cassan2016]. +This formula is a fit to the experimental measurements on circular blocks used in Cassan et al. 2016[^Cassan2016]: $$ f_{h_*}(h_*) = (1 + 1 / h_*^{2}) $$ @@ -192,7 +192,7 @@ with $$Re = u_0 \times h / \nu$$ -Else (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^5]) +Else (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^Rice1998] $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ @@ -232,12 +232,12 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\): hydraulic roughness (m) - \(\tilde{z}\): dimensionless stand \(\tilde{z} = z / k\) -[^1]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 +[^Cassan2016]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 -[^2]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 +[^Cassan2014]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 -[^3]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 +[^Tran2016]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 -[^4]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 -[^5]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) +[^Rice1998]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) diff --git a/docs/en/calculators/par/theorie_fatou.md b/docs/en/calculators/par/theorie_fatou.md index df03a2465..e803bcc95 100644 --- a/docs/en/calculators/par/theorie_fatou.md +++ b/docs/en/calculators/par/theorie_fatou.md @@ -4,11 +4,11 @@  -*Excerpt from Larinier, 2002[^1]* +*Excerpt from Larinier, 2002[^Larinier2002]* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^1] allowed to establish abacuses that link adimensional flow \(Q^*\): +Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(Q^*\): $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +16,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abacuses of a Fatou baffle fishway for a slope of 10% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a Fatou baffle fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a Fatou baffle fishway for a slope of 15% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a Fatou baffle fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a Fatou baffle fishway for a slope of 20% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a Fatou baffle fishway for a slope of 20% (Excerpt from Larinier, 2002[^Larinier2002])* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -88,4 +88,4 @@ $$ Z_{r1} = Z_{d1} + \frac{0.3 S - 0.2}{\sqrt{1 + S^2}} $$ $$ Z_m = Z_{r1} + \frac{4 L}{3 \sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/par/theorie_mixte.md b/docs/en/calculators/par/theorie_mixte.md index cef432210..379feaf58 100644 --- a/docs/en/calculators/par/theorie_mixte.md +++ b/docs/en/calculators/par/theorie_mixte.md @@ -2,11 +2,11 @@  -*Excerpt from Larinier, 2002[^1]* +*Excerpt from Larinier, 2002[^Larinier2002]* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^1] allowed to establish abacuses that link adimensional flow \(q^*\) : +Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +14,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abacuses of a mixed / chevron baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a mixed / chevron baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a mixed / chevron baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a mixed / chevron baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -74,5 +74,5 @@ $$ A_w = h \times L$$ $$ Z_{r1} = Z_{d1} + \frac{3 a S - a}{\sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/par/theorie_plans.md b/docs/en/calculators/par/theorie_plans.md index 7c695f117..e8229710b 100644 --- a/docs/en/calculators/par/theorie_plans.md +++ b/docs/en/calculators/par/theorie_plans.md @@ -4,11 +4,11 @@  -*Excerpt from Larinier, 2002[^1]* +*Excerpt from Larinier, 2002[^Larinier2002]* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^1] allowed to establish abacuses that link adimensional flow \(Q^*\): +Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(Q^*\): $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +16,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abacuses of a plane baffles (Denil) fishway for a slope of 10% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a plane baffles (Denil) fishway for a slope of 15% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a plane baffles (Denil) fishway for a slope of 20% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 20% (Excerpt from Larinier, 2002[^Larinier2002])* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -88,4 +88,4 @@ $$ Z_{r1} = Z_{d1} - D \sin(45° + \arctan(S)) $$ $$ Z_m = Z_{r1} + - H_{min} \sin(45° + \arctan(S)) $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/par/theorie_suractif.md b/docs/en/calculators/par/theorie_suractif.md index 346d610ae..4a97a7ae5 100644 --- a/docs/en/calculators/par/theorie_suractif.md +++ b/docs/en/calculators/par/theorie_suractif.md @@ -2,11 +2,11 @@  -*Excerpt from Larinier, 2002[^1]* +*Excerpt from Larinier, 2002[^Larinier2002]* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^1] allowed to establish abacuses that link adimensional flow \(q^*\) : +Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +14,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abacuses of a superactive baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a superactive baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])*  -*Abacuses of a superactive baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^1])* +*Abacuses of a superactive baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -74,4 +74,4 @@ $$ A_w = h \times L$$ $$ Z_{r1} = Z_{d1} + \frac{2.6 a S - a}{\sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/structures/cunge_80.md b/docs/en/calculators/structures/cunge_80.md index 07024aceb..6748bf7d7 100644 --- a/docs/en/calculators/structures/cunge_80.md +++ b/docs/en/calculators/structures/cunge_80.md @@ -1,6 +1,6 @@ # Cunge 1980 formula -This stage discharge equation is based on the equations described by Cunge in his book [^1], or in more detail in an article by Mahmood and Yevjevich [^2]. This law is a compilation of the classical laws taking into account the different flow conditions: submerged, free flow, free surface and in charge as well as the equations [CEM88(D) : Weir / Orifice (important sill)](cem_88_d.md) and [CEM88(D) : Weir / Orifice (low sill)](cem_88_v.md). However, contrary to these equations, it does not provide any continuity between free surface and in charge flow conditions. This can lead to design problems in the vicinity of this transition. +This stage discharge equation is based on the equations described by Cunge in his book [^Cunge1980], or in more detail in an article by Mahmood and Yevjevich [^Mahmood1975]. This law is a compilation of the classical laws taking into account the different flow conditions: submerged, free flow, free surface and in charge as well as the equations [CEM88(D) : Weir / Orifice (important sill)](cem_88_d.md) and [CEM88(D) : Weir / Orifice (low sill)](cem_88_v.md). However, contrary to these equations, it does not provide any continuity between free surface and in charge flow conditions. This can lead to design problems in the vicinity of this transition. This law is suitable for a broad-crested rectangular weir, possibly in combination with a valve. The default discharge coefficient \(C_d = 1\) corresponds to the following discharge coefficients for the classical equations: @@ -47,6 +47,6 @@ For all other flow regimes, used equations here are the following as they can be | Free flow | [Free flow weir](seuil_denoye.md) | [free flow gate](vanne_denoyee.md) | | Submerged | [Submerged weir](seuil_noye.md) | [Submerged gate](vanne_noyee.md) | -[^1]: Cunge, Holly, Verwey, 1980, "Practical aspects of computational river hydraulics", Pitman, p. 169 for weirs and p. 266 for gates. +[^Cunge1980]: Cunge, Holly, Verwey, 1980, "Practical aspects of computational river hydraulics", Pitman, p. 169 for weirs and p. 266 for gates. -[^2]: Mahmood K., Yevjevich V., 1975, "Unsteady flow in open channels, Volume 1 and 2", Water resources publications, Fort Collins, USA, 923 p. +[^Mahmood1975]: Mahmood K., Yevjevich V., 1975, "Unsteady flow in open channels, Volume 1 and 2", Water resources publications, Fort Collins, USA, 923 p. diff --git a/docs/en/calculators/structures/dever_triang.md b/docs/en/calculators/structures/dever_triang.md index 748232c3b..c1e73dfc5 100644 --- a/docs/en/calculators/structures/dever_triang.md +++ b/docs/en/calculators/structures/dever_triang.md @@ -2,7 +2,7 @@  -*Perspective view of a triangular weir (from CETMEF, 2005[^1])* +*Perspective view of a triangular weir (from CETMEF, 2005[^CETMEF2005] ## Free flow formula @@ -29,16 +29,16 @@ The weir is submerged as soon as \(Z_{2} > Z_{d}\) and [the Villemonte reduction Submergence occurs for \(h_2 / h_1 > 4 / 5\) with \(h_1 = Z_1 - Z_d\) and \(h_2 = Z_2 - Z_d\), and with \(Z_2\) the downstream water elevation. -The reduction coefficient proposed by Bos (1989) [^2] is then applied: +The reduction coefficient proposed by Bos (1989) [^Bos1989] is then applied: -![Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^2])](dever_triang_abaque_bos.png) +![Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^Bos1989])](dever_triang_abaque_bos.png) -*Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^2])* +*Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^Bos1989])* The abacus is approximated by the following formula: $$K_s = sin(3.9629 (1 - h_2 / h_1)^{0.575})$$ -[^1]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. +[^CETMEF2005]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. -[^2]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. +[^Bos1989]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. diff --git a/docs/fr/calculators/devalaison/grille.md b/docs/fr/calculators/devalaison/grille.md index f3ec4f443..797812655 100644 --- a/docs/fr/calculators/devalaison/grille.md +++ b/docs/fr/calculators/devalaison/grille.md @@ -9,7 +9,7 @@ et de la largeur de la prise d’eau \(B\) à l’amont du plan de grille : $$ V_1 = \frac{Q}{H_1 \times B} $$ -Le calcul du coefficient de pertes de charge \(\xi\) se fait à partir des caractéristiques de la grille. Pour une description complète des hypothèses, des formules et des limitations de la méthode, se référer au rapport de Raynal et al. (2012)[^1] disponible ici : https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +Le calcul du coefficient de pertes de charge \(\xi\) se fait à partir des caractéristiques de la grille. Pour une description complète des hypothèses, des formules et des limitations de la méthode, se référer au rapport de Raynal et al. (2012)[^Raynal2012] disponible ici : https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf ## Grille conventionnelle @@ -17,7 +17,7 @@ Plans de grille conventionnels : perpendiculaires à l'écoulement et peu i ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F1 de Raynal et al. (2012)[^1] : +Le calcul des pertes de charges s'effectue à l'aide de la formule F1 de Raynal et al. (2012)[^Raynal2012] : $$\xi = a * K_O * K_\beta$$ @@ -54,7 +54,7 @@ Plans de grille orientés par rapport à l'écoulement et quasi-verticaux. ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F2 de Raynal et al. (2012)[^1] ou encore de l'équation (7) de Raynal et al. (2013)[^2] +Le calcul des pertes de charges s'effectue à l'aide de la formule F2 de Raynal et al. (2012)[^Raynal2012] ou encore de l'équation (7) de Raynal et al. (2013)[^Raynal_P2_2013] $$\xi = a * K_O * K_\alpha$$ @@ -79,7 +79,7 @@ Plans de grille perpendiculaires à l'écoulement, et inclinés par rapport à l ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F3 de Raynal et al. (2012)[^1] ou encore de l'équation (11) de Raynal et al. (2013)[^3] +Le calcul des pertes de charges s'effectue à l'aide de la formule F3 de Raynal et al. (2012)[^Raynal2012] ou encore de l'équation (11) de Raynal et al. (2013)[^Raynal_P1_2013] $$\xi = a * K_b * K_\beta + K_{Fent} * K_{entH}$$ @@ -205,7 +205,7 @@ Le coefficient de forme des barreaux \(c\) vaut 1.69 pour le profil rectangulair | | <img src="ge.png" alt="Droplet" style="width:65px;height:289px;"> | <img src="pletina.png" alt="Plétina" style="width:65px;height:289px;"> | <img src="tadpole8.png" alt="Tadpole 8" style="width:65px;height:289px;"> | <img src="tadpole10.png" alt="Tadpole 10" style="width:65px;height:289px;"> | <img src="hydrodynamique.png" alt="Hydrodynamique" style="width:65px;height:289px;"> | <img src="rec.png" alt="Rectangulaire" style="width:65px;height:289px;"> | | Coefficient de forme $A_i$| 2.47 | 1.75 | 1.27 | 1.79 | 2.10 | 3.85 | -Extrait de Lemkecher et al. (2020)[^4] +Extrait de Lemkecher et al. (2020)[^Lemkecher2020] ### Coefficient de forme moyen des entretoises et éléments transversaux, pondérés selon leurs parts respectives @@ -215,10 +215,10 @@ A déterminer à partir des plans de la grille. Vaut par exemple 1.79 pour les entretoises cylindriques, 2.42 pour les entretoises rectangulaires, et de l'ordre de 4 pour les poutres carrées et IPN. -[^1]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +[^Raynal2012]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf -[^2]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 +[^Raynal_P2_2013]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 -[^3]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 +[^Raynal_P1_2013]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 -[^4]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 +[^Lemkecher2020]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 diff --git a/docs/fr/calculators/pam/concentration.md b/docs/fr/calculators/pam/concentration.md index 5a8390bd2..18b8c6131 100644 --- a/docs/fr/calculators/pam/concentration.md +++ b/docs/fr/calculators/pam/concentration.md @@ -13,9 +13,9 @@ L'outil permet de calculer l'une des valeurs suivantes :  -*Extrait de Larinier et al., 2006[^1]* +*Extrait de Larinier et al., 2006[^Larinier2006]* -[^1]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 L'espacement entre les blocs se calcule ensuite avec la formule suivante : diff --git a/docs/fr/calculators/pam/macrorugo.md b/docs/fr/calculators/pam/macrorugo.md index 83395baef..7fea02f19 100644 --- a/docs/fr/calculators/pam/macrorugo.md +++ b/docs/fr/calculators/pam/macrorugo.md @@ -4,9 +4,9 @@ Le module de calcul passe à macro-rugosités permet de calculer les caractéris  -*Extrait de Larinier et al., 2006[^1]* +*Extrait de Larinier et al., 2006[^Larinier2006]* -[^1]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 L'outil permet de calculer l'une des valeurs suivantes : diff --git a/docs/fr/calculators/pam/macrorugo_theorie.md b/docs/fr/calculators/pam/macrorugo_theorie.md index de028e450..c1c157d6d 100644 --- a/docs/fr/calculators/pam/macrorugo_theorie.md +++ b/docs/fr/calculators/pam/macrorugo_theorie.md @@ -1,12 +1,12 @@ # Calcul du débit d'une passe à macro-rugosité -Le calcul du débit d'une passe à macro-rugosité correspond à l'implémentation de l'algorithme et des équations présentent dans Cassan et al. (2016)[^1]. +Le calcul du débit d'une passe à macro-rugosité correspond à l'implémentation de l'algorithme et des équations présentent dans Cassan et al. (2016)[^Cassan2016]. ## Principe général du calcul  -*Extrait de Cassan et al., 2016[^1]* +*Extrait de Cassan et al., 2016[^Cassan2016]* Il existe trois cas : @@ -116,32 +116,32 @@ $$V = \frac{Q}{B \times h}$$ ### Vitesse moyenne entre les blocs *V<sub>g</sub>* -Eq. 1 Cassan et al (2016)[^1] et Eq. 1 Cassan et al (2014)[^2]: +Eq. 1 Cassan et al (2016)[^Cassan2016] et Eq. 1 Cassan et al (2014)[^Cassan2014]: $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ ### Coefficient de trainée d'un bloc *C<sub>d0</sub>* -\(C_{d0}\) est le coefficient de trainée théorique d'un bloc de hauteur infinie pour un Froude \(F << 1\) (Cassan et al, 2014[^2]). +\(C_{d0}\) est le coefficient de trainée théorique d'un bloc de hauteur infinie pour un Froude \(F << 1\) (Cassan et al, 2014[^Cassan2014]). | Forme du bloc | Cylindre | Forme "face arrondie" | Parallélépipède à base carré | Forme "face plate" | |:--------------|:--------:|:---------------------:|:----------------------------:|:------------------:| | |  |  |  |  | | Valeur de \(C_{d0}\) | 1.0 | 1.2-1.3 | 2.0 | 2.2 | -Lors de l'établissement des formules statistiques du guide technique de 2006 (Larinier et al. 2006[^4]), la définition des formes de blocs à tester a été établie dans la perspective de l'utilisation de blocs de carrière à faces ni complètement rondes, ni complètement carrées. +Lors de l'établissement des formules statistiques du guide technique de 2006 (Larinier et al. 2006[^Larinier2006]), la définition des formes de blocs à tester a été établie dans la perspective de l'utilisation de blocs de carrière à faces ni complètement rondes, ni complètement carrées. La forme dite à « face arrondie » n'était ainsi pas complètement cylindrique, mais présentait une face aval trapézoïdale (vue en plan). De même, la forme dite à « face plane » ne présentait pas une section carrée, mais également une face aval trapézoïdale. Ces différences de forme entre la « face arrondie » et un véritable cylindre d’une part, et la « face plate » et un véritable parallélépipède à base carrée d’autre part, se traduisent par de légères différences entre celles-ci sur les coefficients de forme \(C_{d0}\). ### Coefficient de forme de bloc *σ* -Cassan et al. (2014)[^2], et Cassan et al. (2016)[^1] définit \(\sigma\) comme le ratio entre l'aire du bloc vu du dessus et \(D^2\). +Cassan et al. (2014)[^Cassan2014], et Cassan et al. (2016)[^Cassan2016] définit \(\sigma\) comme le ratio entre l'aire du bloc vu du dessus et \(D^2\). On a donc \(\sigma = \pi / 4\) pour un bloc circulaire et \(\sigma = 1\) pour un bloc carré. ### Rapport entre la vitesse moyenne à l'aval d'un bloc et la vitesse max *r* -Les valeurs de \(r\) dépendent de la forme des blocs (Cassan et al., 2014[^2] et Tran et al. 2016 [^3]) : +Les valeurs de \(r\) dépendent de la forme des blocs (Cassan et al., 2014[^Cassan2014] et Tran et al. 2016 [^Tran2016]) : - rond : \(r=1.1\) - face arrondie : \(r=1.2\) @@ -158,7 +158,7 @@ $$F = \frac{V_g}{\sqrt{gh}}$$ ### Fonction de correction du coefficient de trainée liée au Froude *f<sub>F</sub>(F,r)* -Si \(F < 1\) (Eq. 19, Cassan et al., 2014[^2]) : +Si \(F < 1\) (Eq. 19, Cassan et al., 2014[^Cassan2014]) : $$f_F(F) = \min \left( \frac{r}{1- \frac{F_{g}^{2}}{4}}, \frac{1}{F^{\frac{2}{3}}} \right)^2$$ @@ -166,7 +166,7 @@ sinon \(f_F(F) = 1\) car un écoulement torrentiel à l'amont des blocs est thé ### Vitesse maximale *u<sub>max</sub>* -D'après l'équation 19 de Cassan et al., 2014[^2] : +D'après l'équation 19 de Cassan et al., 2014[^Cassan2014] : $$ u_{max} = V_g \sqrt{f_F(F)} $$ @@ -174,8 +174,8 @@ $$ u_{max} = V_g \sqrt{f_F(F)} $$ ### Fonction de correction du coefficient de trainée lié à la profondeur relative *f<sub>h\*</sub>(h<sub>\*</sub>)* -L'équation utilisée dans Cassiopée diffère légèrement de l'équation 20 de Cassan et al. 2014[^2] et l'équation 6 de Cassan et al. 2016[^1]. -Cette formule est un ajustement sur les mesures expérimentales sur les blocs circulaires utilisées dans de Cassan et al. 2016[^1] : +L'équation utilisée dans Cassiopée diffère légèrement de l'équation 20 de Cassan et al. 2014[^Cassan2014] et l'équation 6 de Cassan et al. 2016[^Cassan2016]. +Cette formule est un ajustement sur les mesures expérimentales sur les blocs circulaires utilisées dans de Cassan et al. 2016[^Cassan2016] : $$ f_{h_*}(h_*) = (1 + 1 / h_*^{2}) $$ @@ -189,7 +189,7 @@ avec $$Re = u_0 \times h / \nu$$ -Sinon (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^5]) +Sinon (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^Rice1998]) $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ @@ -229,12 +229,12 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\) : rugosité hydraulique (m) - \(\tilde{z}\) : position verticale adimensionnelle \(\tilde{z} = z / k\) -[^1]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 +[^Cassan2016]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 -[^2]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 +[^Cassan2014]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 -[^3]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 +[^Tran2016]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 -[^4]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 -[^5]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) +[^Rice1998]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) diff --git a/docs/fr/calculators/par/theorie_fatou.md b/docs/fr/calculators/par/theorie_fatou.md index 2f3021a6d..99ef738c9 100644 --- a/docs/fr/calculators/par/theorie_fatou.md +++ b/docs/fr/calculators/par/theorie_fatou.md @@ -4,11 +4,11 @@  -*Extrait de Larinier, 2002[^1]* +*Extrait de Larinier, 2002[^Larinier2002]* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^1] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : +Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +16,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 10% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 15% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 20% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 20% (Extrait de Larinier, 2002[^Larinier2002])* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -88,4 +88,4 @@ $$ Z_{r1} = Z_{d1} + \frac{0.3 S - 0.2}{\sqrt{1 + S^2}} $$ $$ Z_m = Z_{r1} + \frac{4 L}{3 \sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/par/theorie_mixte.md b/docs/fr/calculators/par/theorie_mixte.md index b010bde1b..3ae635fd3 100644 --- a/docs/fr/calculators/par/theorie_mixte.md +++ b/docs/fr/calculators/par/theorie_mixte.md @@ -2,11 +2,11 @@  -*Extrait de Larinier, 2002[^1]* +*Extrait de Larinier, 2002[^Larinier2002]* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^1] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : +Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +14,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abaques d'une passe à ralentisseurs mixte pour une pente de 10% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs mixte pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs mixte pour une pente de 15% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs mixte pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -74,5 +74,5 @@ $$ A_w = h \times L$$ $$ Z_{r1} = Z_{d1} + \frac{3 a S - a}{\sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/par/theorie_plans.md b/docs/fr/calculators/par/theorie_plans.md index 98781d18d..795901a3c 100644 --- a/docs/fr/calculators/par/theorie_plans.md +++ b/docs/fr/calculators/par/theorie_plans.md @@ -4,11 +4,11 @@  -*Extrait de Larinier, 2002[^1]* +*Extrait de Larinier, 2002[^Larinier2002]* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^1] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : +Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +16,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 10% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 15% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 20% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 20% (Extrait de Larinier, 2002[^Larinier2002])* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous la forme de polynômes dépendant de la pente \(S\). @@ -88,4 +88,4 @@ $$ Z_{r1} = Z_{d1} - D \sin(45° + \arctan(S)) $$ $$ Z_m = Z_{r1} + - H_{min} \sin(45° + \arctan(S)) $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/par/theorie_suractif.md b/docs/fr/calculators/par/theorie_suractif.md index 818166ba7..1df53028e 100644 --- a/docs/fr/calculators/par/theorie_suractif.md +++ b/docs/fr/calculators/par/theorie_suractif.md @@ -2,11 +2,11 @@  -*Extrait de Larinier, 2002[^1]* +*Extrait de Larinier, 2002[^Larinier2002]* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^1] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : +Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +14,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 10% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])*  -*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 15% (Extrait de Larinier, 2002[^1])* +*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -74,4 +74,4 @@ $$ A_w = h \times L$$ $$ Z_{r1} = Z_{d1} + \frac{2.6 a S - a}{\sqrt{1 + S^2}} $$ -[^1]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). +[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/structures/cunge_80.md b/docs/fr/calculators/structures/cunge_80.md index 7f5588054..d49de88c7 100644 --- a/docs/fr/calculators/structures/cunge_80.md +++ b/docs/fr/calculators/structures/cunge_80.md @@ -1,6 +1,6 @@ # Formules de Cunge 1980 -Cette loi de débit est inspirée des équations décrites par Cunge dans son livre [^1], ou avec plus de détails dans un article de Mahmood et Yevjevich [^2]. Cette loi est une compilation des lois classiques prenant en considération les différentes conditions d’écoulement : noyé, dénoyé, à surface libre et en charge tout comme les équations [CEM88(D) : Déversoir / Orifice (pelle importante)](cem_88_d.md) et [CEM88(V) : Déversoir / Vanne de fond (pelle faible)](cem_88_v.md). Cependant contrairement à ces équations, celle-ci n'asssure aucune continuité entre les conditions d’écoulement à surface libre et en charge. Cela peut entraîner des problèmes de calcul au voisinage de cette transition. +Cette loi de débit est inspirée des équations décrites par Cunge dans son livre [^Cunge1980], ou avec plus de détails dans un article de Mahmood et Yevjevich [^Mahmood1975]. Cette loi est une compilation des lois classiques prenant en considération les différentes conditions d’écoulement : noyé, dénoyé, à surface libre et en charge tout comme les équations [CEM88(D) : Déversoir / Orifice (pelle importante)](cem_88_d.md) et [CEM88(V) : Déversoir / Vanne de fond (pelle faible)](cem_88_v.md). Cependant contrairement à ces équations, celle-ci n'asssure aucune continuité entre les conditions d’écoulement à surface libre et en charge. Cela peut entraîner des problèmes de calcul au voisinage de cette transition. Cette loi est adaptée pour un seuil rectangulaire à crête épaisse, éventuellement associée à une vanne. Le coefficient de débit par défaut \(C_d = 1\) correspond aux coefficients de débits suivant pour les équations classiques: @@ -49,6 +49,6 @@ Pour tous les autres régimes d'écoulement les équations utilisées sont les s | Dénoyé | [Seuil dénoyé](seuil_denoye.md) | [Vanne dénoyée](vanne_denoyee.md) | | Noyé | [Seuil noyé](seuil_noye.md) | [Vanne noyée](vanne_noyee.md) | -[^1]: Cunge, Holly, Verwey, 1980, "Practical aspects of computational river hydraulics", Pitman, p. 169 pour les seuils et p. 266 pour les vannes. +[^Cunge1980]: Cunge, Holly, Verwey, 1980, "Practical aspects of computational river hydraulics", Pitman, p. 169 pour les seuils et p. 266 pour les vannes. -[^2]: Mahmood K., Yevjevich V., 1975, "Unsteady flow in open channels, Volume 1 and 2", Water resources publications, Fort Collins, USA, 923 p. +[^Mahmood1975]: Mahmood K., Yevjevich V., 1975, "Unsteady flow in open channels, Volume 1 and 2", Water resources publications, Fort Collins, USA, 923 p. diff --git a/docs/fr/calculators/structures/dever_triang.md b/docs/fr/calculators/structures/dever_triang.md index 62bf10737..0f35fbfdb 100644 --- a/docs/fr/calculators/structures/dever_triang.md +++ b/docs/fr/calculators/structures/dever_triang.md @@ -2,7 +2,7 @@  -*Vue en perspective d'un déversoir triangulaire (d'après CETMEF, 2005[^1])* +*Vue en perspective d'un déversoir triangulaire (d'après CETMEF, 2005[^CETMEF2005])* ## Formule du déversoir dénoyé @@ -29,16 +29,16 @@ Le seuil est noyé dès que \(Z_{2} > Z_{d}\) et [le coefficient de réduction d L'ennoiement a lieu pour \(h_2 / h_1 > 4 / 5\) avec \(h_1 = Z_1 - Z_d\) et \(h_2 = Z_2 - Z_d\), et avec \(Z_2\) la cote de l'eau à l'aval du seuil. -Le coefficient de réduction proposé par Bos (1989)[^2] est alors appliqué: +Le coefficient de réduction proposé par Bos (1989)[^Bos1989] est alors appliqué: -![Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (d'après Bos, 1989 [^2])](dever_triang_abaque_bos.png) +![Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (d'après Bos, 1989 [^Bos1989])](dever_triang_abaque_bos.png) -*Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (extrait de Bos, 1989 [^2])* +*Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (extrait de Bos, 1989 [^Bos1989])* L'abaque est approché par la formule suivante : $$K_s = sin(3.9629 (1 - h_2 / h_1)^{0.575})$$ -[^1]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. +[^CETMEF2005]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. -[^2]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. +[^Bos1989]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. -- GitLab From 106145f1c20dc0fec25354bab58ef0d217b1ca19 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 10:27:31 +0000 Subject: [PATCH 02/10] docs(macrorugo): replace footnotes by bibliography Refs #655 --- docs/en/calculators/pam/macrorugo_theorie.md | 36 +++++++++++--------- docs/fr/calculators/pam/macrorugo_theorie.md | 36 +++++++++++--------- 2 files changed, 38 insertions(+), 34 deletions(-) diff --git a/docs/en/calculators/pam/macrorugo_theorie.md b/docs/en/calculators/pam/macrorugo_theorie.md index b87f6cbcd..56773521e 100644 --- a/docs/en/calculators/pam/macrorugo_theorie.md +++ b/docs/en/calculators/pam/macrorugo_theorie.md @@ -1,12 +1,12 @@ # Calculation of the flow rate of a rock-ramp pass -The calculation of the flow rate of a rock-ramp pass corresponds to the implementation of the algorithm and the equations present in Cassan et al. (2016)[^Cassan2016]. +The calculation of the flow rate of a rock-ramp pass corresponds to the implementation of the algorithm and the equations present in Cassan et al. (2016). ## General calculation principle  -*After Cassan et al., 2016[^Cassan2016]* +*After Cassan et al., 2016* There are three possibilities: @@ -116,7 +116,7 @@ $$V = \frac{Q}{B \times h}$$ ### Average speed between blocks *V<sub>g</sub>* -From Eq. 1 Cassan et al (2016)[^Cassan2016] and Eq. 1 Cassan et al (2014)[^Cassan2014]: +From Eq. 1 Cassan et al (2016) and Eq. 1 Cassan et al (2014): $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ @@ -124,7 +124,7 @@ $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ ### Drag coefficient of a single block *C<sub>d0</sub>* \(C_{d0}\) is the drag coefficient of a block considering a single block -infinitely high with \(F << 1\) (Cassan et al, 2014[^Cassan2014]). +infinitely high with \(F << 1\) (Cassan et al, 2014). | Block shape | Cylinder | "Rounded face" shape | Square-based parallelepiped | "Flat face" shape | @@ -132,7 +132,7 @@ infinitely high with \(F << 1\) (Cassan et al, 2014[^Cassan2014]). | |  |  |  |  | | Value of \(C_{d0}\) | 1.0 | 1.2-1.3 | 2.0 | 2.2 | -When establishing the statistical formulae for the 2006 technical guide (Larinier et al. 2006[^Larinier2006]), the definition of the block shapes to be tested was based on the use of quarry blocks with neither completely round nor completely square faces. +When establishing the statistical formulae for the 2006 technical guide (Larinier et al. 2006), the definition of the block shapes to be tested was based on the use of quarry blocks with neither completely round nor completely square faces. The so-called "rounded face" shape was thus not completely cylindrical, but had a trapezoidal bottom face (seen in plan). Similarly, the "flat face" shape was not square in cross-section, but also had a trapezoidal bottom face. These differences in shape between the "rounded face" and a true cylinder on the one hand, and the "flat face" and a true parallelepiped with a square base on the other hand, result in slight differences between them in the shape coefficients \(C_{d0}\). @@ -140,13 +140,13 @@ These differences in shape between the "rounded face" and a true cylinder on the ### Block shape coefficient *σ* -Cassan et al. (2014)[^Cassan2014], et Cassan et al. (2016)[^Cassan2016] define \(\sigma\) as the ratio between the +Cassan et al. (2014), et Cassan et al. (2016) define \(\sigma\) as the ratio between the block area in the \(x,y\) plane and \(D^2\). For the cylindrical form of the blocks, \(\sigma\) is equal to \(\pi / 4\) and for a square block, \(\sigma = 1\). ### Ratio between the average speed downstream of a block and the maximum speed *r* -The values of \(r\) depends on the block shapes (Cassan et al., 2014[^Cassan2014] et Tran et al. 2016 [^Tran2016]): +The values of \(r\) depends on the block shapes (Cassan et al., 2014 et Tran et al. 2016): - round : \(r_Q=1.1\) - "rounded face" shape : \(r=1.2\) @@ -163,7 +163,7 @@ $$F = \frac{V_g}{\sqrt{gh}}$$ ### Froude-related drag coefficient correction function *f<sub>F</sub>(F)* -If \(F < 1\) (Eq. 19, Cassan et al., 2014[^Cassan2014]): +If \(F < 1\) (Eq. 19, Cassan et al., 2014): $$f_F(F) = \min \left( \frac{r}{1- \frac{F_{g}^{2}}{4}}, \frac{1}{F^{\frac{2}{3}}} \right)^2$$ @@ -171,14 +171,14 @@ otherwise \(f_F(F) = 1\) because a torrential flow upstream of the blocks is the ### Maximum speed *u<sub>max</sub>* -According to equation 19 of Cassan et al, 2014[^Cassan2014] : +According to equation 19 of Cassan et al, 2014 : $$ u_{max} = V_g \sqrt{f_F(F)} $$ ### Drag coefficient correction function linked to relative depth *f<sub>h\*</sub>(h<sub>\*</sub>)* -The equation used in Cassiopeia differs slightly from equation 20 of Cassan et al. 2014[^Cassan2014] and equation 6 of Cassan et al. 2016[^Cassan2016]. -This formula is a fit to the experimental measurements on circular blocks used in Cassan et al. 2016[^Cassan2016]: +The equation used in Cassiopeia differs slightly from equation 20 of Cassan et al. 2014 and equation 6 of Cassan et al. 2016. +This formula is a fit to the experimental measurements on circular blocks used in Cassan et al. 2016: $$ f_{h_*}(h_*) = (1 + 1 / h_*^{2}) $$ @@ -192,7 +192,7 @@ with $$Re = u_0 \times h / \nu$$ -Else (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^Rice1998] +Else (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998) $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ @@ -232,12 +232,14 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\): hydraulic roughness (m) - \(\tilde{z}\): dimensionless stand \(\tilde{z} = z / k\) -[^Cassan2016]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 +## Bibliography -[^Cassan2014]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 +Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 -[^Tran2016]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 +Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 -[^Rice1998]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) +Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) + +Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 diff --git a/docs/fr/calculators/pam/macrorugo_theorie.md b/docs/fr/calculators/pam/macrorugo_theorie.md index c1c157d6d..c4f1dba31 100644 --- a/docs/fr/calculators/pam/macrorugo_theorie.md +++ b/docs/fr/calculators/pam/macrorugo_theorie.md @@ -1,12 +1,12 @@ # Calcul du débit d'une passe à macro-rugosité -Le calcul du débit d'une passe à macro-rugosité correspond à l'implémentation de l'algorithme et des équations présentent dans Cassan et al. (2016)[^Cassan2016]. +Le calcul du débit d'une passe à macro-rugosité correspond à l'implémentation de l'algorithme et des équations présentent dans Cassan et al. (2016). ## Principe général du calcul  -*Extrait de Cassan et al., 2016[^Cassan2016]* +*Extrait de Cassan et al., 2016* Il existe trois cas : @@ -116,32 +116,32 @@ $$V = \frac{Q}{B \times h}$$ ### Vitesse moyenne entre les blocs *V<sub>g</sub>* -Eq. 1 Cassan et al (2016)[^Cassan2016] et Eq. 1 Cassan et al (2014)[^Cassan2014]: +Eq. 1 Cassan et al (2016) et Eq. 1 Cassan et al (2014): $$V_g = \frac{V}{1 - \sqrt{(a_x/a_y)C}}$$ ### Coefficient de trainée d'un bloc *C<sub>d0</sub>* -\(C_{d0}\) est le coefficient de trainée théorique d'un bloc de hauteur infinie pour un Froude \(F << 1\) (Cassan et al, 2014[^Cassan2014]). +\(C_{d0}\) est le coefficient de trainée théorique d'un bloc de hauteur infinie pour un Froude \(F << 1\) (Cassan et al, 2014). | Forme du bloc | Cylindre | Forme "face arrondie" | Parallélépipède à base carré | Forme "face plate" | |:--------------|:--------:|:---------------------:|:----------------------------:|:------------------:| | |  |  |  |  | | Valeur de \(C_{d0}\) | 1.0 | 1.2-1.3 | 2.0 | 2.2 | -Lors de l'établissement des formules statistiques du guide technique de 2006 (Larinier et al. 2006[^Larinier2006]), la définition des formes de blocs à tester a été établie dans la perspective de l'utilisation de blocs de carrière à faces ni complètement rondes, ni complètement carrées. +Lors de l'établissement des formules statistiques du guide technique de 2006 (Larinier et al. 2006), la définition des formes de blocs à tester a été établie dans la perspective de l'utilisation de blocs de carrière à faces ni complètement rondes, ni complètement carrées. La forme dite à « face arrondie » n'était ainsi pas complètement cylindrique, mais présentait une face aval trapézoïdale (vue en plan). De même, la forme dite à « face plane » ne présentait pas une section carrée, mais également une face aval trapézoïdale. Ces différences de forme entre la « face arrondie » et un véritable cylindre d’une part, et la « face plate » et un véritable parallélépipède à base carrée d’autre part, se traduisent par de légères différences entre celles-ci sur les coefficients de forme \(C_{d0}\). ### Coefficient de forme de bloc *σ* -Cassan et al. (2014)[^Cassan2014], et Cassan et al. (2016)[^Cassan2016] définit \(\sigma\) comme le ratio entre l'aire du bloc vu du dessus et \(D^2\). +Cassan et al. (2014), et Cassan et al. (2016) définit \(\sigma\) comme le ratio entre l'aire du bloc vu du dessus et \(D^2\). On a donc \(\sigma = \pi / 4\) pour un bloc circulaire et \(\sigma = 1\) pour un bloc carré. ### Rapport entre la vitesse moyenne à l'aval d'un bloc et la vitesse max *r* -Les valeurs de \(r\) dépendent de la forme des blocs (Cassan et al., 2014[^Cassan2014] et Tran et al. 2016 [^Tran2016]) : +Les valeurs de \(r\) dépendent de la forme des blocs (Cassan et al., 2014 et Tran et al. 2016 ) : - rond : \(r=1.1\) - face arrondie : \(r=1.2\) @@ -158,7 +158,7 @@ $$F = \frac{V_g}{\sqrt{gh}}$$ ### Fonction de correction du coefficient de trainée liée au Froude *f<sub>F</sub>(F,r)* -Si \(F < 1\) (Eq. 19, Cassan et al., 2014[^Cassan2014]) : +Si \(F < 1\) (Eq. 19, Cassan et al., 2014) : $$f_F(F) = \min \left( \frac{r}{1- \frac{F_{g}^{2}}{4}}, \frac{1}{F^{\frac{2}{3}}} \right)^2$$ @@ -166,7 +166,7 @@ sinon \(f_F(F) = 1\) car un écoulement torrentiel à l'amont des blocs est thé ### Vitesse maximale *u<sub>max</sub>* -D'après l'équation 19 de Cassan et al., 2014[^Cassan2014] : +D'après l'équation 19 de Cassan et al., 2014 : $$ u_{max} = V_g \sqrt{f_F(F)} $$ @@ -174,8 +174,8 @@ $$ u_{max} = V_g \sqrt{f_F(F)} $$ ### Fonction de correction du coefficient de trainée lié à la profondeur relative *f<sub>h\*</sub>(h<sub>\*</sub>)* -L'équation utilisée dans Cassiopée diffère légèrement de l'équation 20 de Cassan et al. 2014[^Cassan2014] et l'équation 6 de Cassan et al. 2016[^Cassan2016]. -Cette formule est un ajustement sur les mesures expérimentales sur les blocs circulaires utilisées dans de Cassan et al. 2016[^Cassan2016] : +L'équation utilisée dans Cassiopée diffère légèrement de l'équation 20 de Cassan et al. 2014 et l'équation 6 de Cassan et al. 2016. +Cette formule est un ajustement sur les mesures expérimentales sur les blocs circulaires utilisées dans de Cassan et al. 2016 : $$ f_{h_*}(h_*) = (1 + 1 / h_*^{2}) $$ @@ -189,7 +189,7 @@ avec $$Re = u_0 \times h / \nu$$ -Sinon (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998[^Rice1998]) +Sinon (Eq. 3, Cassan et al., 2016 d'après Rice et al., 1998) $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ @@ -229,12 +229,14 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\) : rugosité hydraulique (m) - \(\tilde{z}\) : position verticale adimensionnelle \(\tilde{z} = z / k\) -[^Cassan2016]: Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 +## Bibliographie -[^Cassan2014]: Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 +Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 -[^Tran2016]: Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 +Cassan, L., Tien, T.D., Courret, D., Laurens, P., Dartus, D., 2014. Hydraulic Resistance of Emergent Macroroughness at Large Froude Numbers: Design of Nature-Like Fishpasses. Journal of Hydraulic Engineering 140, 04014043. https://doi.org/10.1061/(ASCE)HY.1943-7900.0000910 -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 -[^Rice1998]: Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) +Rice C. E., Kadavy K. C., et Robinson K. M., 1998. Roughness of Loose Rock Riprap on Steep Slopes. Journal of Hydraulic Engineering 124, 179-85. https://doi.org/10.1061/(ASCE)0733-9429(1998)124:2(179) + +Tran, T.D., Chorda, J., Laurens, P., Cassan, L., 2016. Modelling nature-like fishway flow around unsubmerged obstacles using a 2D shallow water model. Environmental Fluid Mechanics 16, 413–428. https://doi.org/10.1007/s10652-015-9430-3 -- GitLab From 3044145aee79c071b4afe3dad8e05273751df6e0 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 10:56:11 +0000 Subject: [PATCH 03/10] docs: replace footnotes by references Refs #655 --- docs/en/calculators/devalaison/grille.md | 20 ++++++++++-------- docs/en/calculators/pam/macrorugo_theorie.md | 2 +- docs/en/calculators/par/theorie_fatou.md | 16 +++++++------- docs/en/calculators/par/theorie_mixte.md | 15 ++++++------- docs/en/calculators/par/theorie_plans.md | 16 +++++++------- docs/en/calculators/par/theorie_suractif.md | 14 +++++++------ docs/fr/calculators/devalaison/grille.md | 22 +++++++++++--------- docs/fr/calculators/pam/macrorugo_theorie.md | 2 +- docs/fr/calculators/par/theorie_fatou.md | 16 +++++++------- docs/fr/calculators/par/theorie_mixte.md | 15 ++++++------- docs/fr/calculators/par/theorie_plans.md | 16 +++++++------- docs/fr/calculators/par/theorie_suractif.md | 14 +++++++------ 12 files changed, 93 insertions(+), 75 deletions(-) diff --git a/docs/en/calculators/devalaison/grille.md b/docs/en/calculators/devalaison/grille.md index 9570a067e..408a0cdd6 100644 --- a/docs/en/calculators/devalaison/grille.md +++ b/docs/en/calculators/devalaison/grille.md @@ -9,7 +9,7 @@ and the intake width \(B\) upstream the trashrack: $$ V_1 = \frac{Q}{H_1 \times B} $$ -The calculation of the head loss coefficient \(\xi\) is based on the characteristics of the trashrack. For a full description of the assumptions, formulas and limitations of the method, please refer to the Raynal et al. (2012) report[^Raynal2012] available here (in French): https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +The calculation of the head loss coefficient \(\xi\) is based on the characteristics of the trashrack. For a full description of the assumptions, formulas and limitations of the method, please refer to the Raynal et al. (2012) report available here (in French): https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf <div style="position: relative"><a id="grille-conventionnelle" style="position: absolute; top: -60px;"></a></div> @@ -19,7 +19,7 @@ Conventional trashracks: perpendicular to the flow and slightly inclined to the ### Formula -Use of the F1 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses. +Use of the F1 formula of Raynal et al (2012) to calculate the head losses. $$\xi = a * K_O * K_\beta$$ @@ -56,7 +56,7 @@ Flow-oriented and near-vertical trashracks. ### Formula -Use of the F2 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses (Also in Equation (7) of Raynal et al. (2013)[^Raynal_P2_2013]). +Use of the F2 formula of Raynal et al (2012) to calculate the head losses (Also in Equation (7) of Raynal et al. (2013b)). $$\xi = a * K_O * K_\alpha$$ @@ -82,7 +82,7 @@ trashracks perpendicular to the flow, and inclined with respect to the horizonta ### Formula -Use of the F3 formula of Raynal et al (2012)[^Raynal2012] to calculate the head losses (Also in Equation (11) of Raynal et al. (2013)[^Raynal_P1_2013]). +Use of the F3 formula of Raynal et al (2012) to calculate the head losses (Also in Equation (11) of Raynal et al. (2013a)). $$\xi = a * K_b * K_\beta + K_{Fent} * K_{entH}$$ @@ -216,7 +216,7 @@ The shape coefficient of the bars \(c\) is 1.69 for the rectangular profile (PR) | | <img src="ge.png" alt="Droplet" style="width:65px;height:289px;"> | <img src="pletina.png" alt="Plétina" style="width:65px;height:289px;"> | <img src="tadpole8.png" alt="Tadpole 8" style="width:65px;height:289px;"> | <img src="tadpole10.png" alt="Tadpole 10" style="width:65px;height:289px;"> | <img src="hydrodynamique.png" alt="Hydrodynamique" style="width:65px;height:289px;"> | <img src="rec.png" alt="Rectangulaire" style="width:65px;height:289px;"> | | Bar coefficient $A_i$| 2.47 | 1.75 | 1.27 | 1.79 | 2.10 | 3.85 | -After Lemkecher et al. (2020)[^Lemkecher2020] +After Lemkecher et al. (2020) <div style="position: relative"><a id="coefficient-de-forme-moyen-des-entretoises-et-elements-transversaux-ponderes-selon-leurs-parts-respectives" style="position: absolute; top: -60px;"></a></div> ### Average shape coefficient of spacers and transverse elements, weighted according to their respective shares @@ -227,10 +227,12 @@ To be determined from the trashrack plans. For example, 1.79 for cylindrical spacers, 2.42 for rectangular spacers, and around 4 for square beams and IPNs. -[^Raynal2012]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +## References -[^Raynal_P2_2013]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 +Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf -[^Raynal_P1_2013]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 +Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013a. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 -[^Lemkecher2020]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 +Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013b. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 + +Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 diff --git a/docs/en/calculators/pam/macrorugo_theorie.md b/docs/en/calculators/pam/macrorugo_theorie.md index 56773521e..197eef646 100644 --- a/docs/en/calculators/pam/macrorugo_theorie.md +++ b/docs/en/calculators/pam/macrorugo_theorie.md @@ -232,7 +232,7 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\): hydraulic roughness (m) - \(\tilde{z}\): dimensionless stand \(\tilde{z} = z / k\) -## Bibliography +## References Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 diff --git a/docs/en/calculators/par/theorie_fatou.md b/docs/en/calculators/par/theorie_fatou.md index e803bcc95..b44a71607 100644 --- a/docs/en/calculators/par/theorie_fatou.md +++ b/docs/en/calculators/par/theorie_fatou.md @@ -1,14 +1,18 @@ # "Fatou" baffle fiwhway +All concepts and formulas are extracted from the following reference: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) + ## Geometrical characteristics  -*Excerpt from Larinier, 2002[^Larinier2002]* +*Excerpt from Larinier, 2002* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(Q^*\): +Experiments conducted by Larinier, 2002 allowed to establish abacuses that link adimensional flow \(Q^*\): $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +20,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abacuses of a Fatou baffle fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a Fatou baffle fishway for a slope of 10% (Excerpt from Larinier, 2002)*  -*Abacuses of a Fatou baffle fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a Fatou baffle fishway for a slope of 15% (Excerpt from Larinier, 2002)*  -*Abacuses of a Fatou baffle fishway for a slope of 20% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a Fatou baffle fishway for a slope of 20% (Excerpt from Larinier, 2002)* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -87,5 +91,3 @@ $$ Z_{r1} = Z_{d1} + \frac{0.3 S - 0.2}{\sqrt{1 + S^2}} $$ ## Minimal rake height of upstream side walls \(Z_m\) $$ Z_m = Z_{r1} + \frac{4 L}{3 \sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/par/theorie_mixte.md b/docs/en/calculators/par/theorie_mixte.md index 379feaf58..229925511 100644 --- a/docs/en/calculators/par/theorie_mixte.md +++ b/docs/en/calculators/par/theorie_mixte.md @@ -1,12 +1,16 @@ # Mixed / chevron baffles fishway +All concepts and formulas are extracted from the following reference: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) +  -*Excerpt from Larinier, 2002[^Larinier2002]* +*Excerpt from Larinier, 2002* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(q^*\) : +Experiments conducted by Larinier, 2002 allowed to establish abacuses that link adimensional flow \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +18,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abacuses of a mixed / chevron baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a mixed / chevron baffles fishway for a slope of 10% (Excerpt from Larinier, 2002)*  -*Abacuses of a mixed / chevron baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a mixed / chevron baffles fishway for a slope of 15% (Excerpt from Larinier, 2002)* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -73,6 +77,3 @@ $$ A_w = h \times L$$ ## Upstream apron elevation \(Z_{r1}\) $$ Z_{r1} = Z_{d1} + \frac{3 a S - a}{\sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). - diff --git a/docs/en/calculators/par/theorie_plans.md b/docs/en/calculators/par/theorie_plans.md index e8229710b..4c1a57894 100644 --- a/docs/en/calculators/par/theorie_plans.md +++ b/docs/en/calculators/par/theorie_plans.md @@ -1,14 +1,18 @@ # Plane baffles (Denil) fishway +All concepts and formulas are extracted from the following reference: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) + ## Geometrical characteristics  -*Excerpt from Larinier, 2002[^Larinier2002]* +*Excerpt from Larinier, 2002* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(Q^*\): +Experiments conducted by Larinier, 2002 allowed to establish abacuses that link adimensional flow \(Q^*\): $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +20,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abacuses of a plane baffles (Denil) fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 10% (Excerpt from Larinier, 2002)*  -*Abacuses of a plane baffles (Denil) fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 15% (Excerpt from Larinier, 2002)*  -*Abacuses of a plane baffles (Denil) fishway for a slope of 20% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a plane baffles (Denil) fishway for a slope of 20% (Excerpt from Larinier, 2002)* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -87,5 +91,3 @@ $$ Z_{r1} = Z_{d1} - D \sin(45° + \arctan(S)) $$ ## Minimal rake height of upstream side walls \(Z_m\) $$ Z_m = Z_{r1} + - H_{min} \sin(45° + \arctan(S)) $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/en/calculators/par/theorie_suractif.md b/docs/en/calculators/par/theorie_suractif.md index 4a97a7ae5..bcc5fc095 100644 --- a/docs/en/calculators/par/theorie_suractif.md +++ b/docs/en/calculators/par/theorie_suractif.md @@ -1,12 +1,16 @@ # Superactive baffles fishway +All concepts and formulas are extracted from the following reference: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) +  -*Excerpt from Larinier, 2002[^Larinier2002]* +*Excerpt from Larinier, 2002* ## Hydraulic laws given by abacuses -Experiments conducted by Larinier, 2002[^Larinier2002] allowed to establish abacuses that link adimensional flow \(q^*\) : +Experiments conducted by Larinier, 2002 allowed to establish abacuses that link adimensional flow \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +18,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abacuses of a superactive baffles fishway for a slope of 10% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a superactive baffles fishway for a slope of 10% (Excerpt from Larinier, 2002)*  -*Abacuses of a superactive baffles fishway for a slope of 15% (Excerpt from Larinier, 2002[^Larinier2002])* +*Abacuses of a superactive baffles fishway for a slope of 15% (Excerpt from Larinier, 2002)* To run calculations for all slopes between 8% and 22%, polynomes coefficients of abacuses above are themelves adjusted in the form of slope \(S\) depending polynomes. @@ -73,5 +77,3 @@ $$ A_w = h \times L$$ ## Upstream apron elevation \(Z_{r1}\) $$ Z_{r1} = Z_{d1} + \frac{2.6 a S - a}{\sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/devalaison/grille.md b/docs/fr/calculators/devalaison/grille.md index 797812655..76094f95f 100644 --- a/docs/fr/calculators/devalaison/grille.md +++ b/docs/fr/calculators/devalaison/grille.md @@ -9,7 +9,7 @@ et de la largeur de la prise d’eau \(B\) à l’amont du plan de grille : $$ V_1 = \frac{Q}{H_1 \times B} $$ -Le calcul du coefficient de pertes de charge \(\xi\) se fait à partir des caractéristiques de la grille. Pour une description complète des hypothèses, des formules et des limitations de la méthode, se référer au rapport de Raynal et al. (2012)[^Raynal2012] disponible ici : https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +Le calcul du coefficient de pertes de charge \(\xi\) se fait à partir des caractéristiques de la grille. Pour une description complète des hypothèses, des formules et des limitations de la méthode, se référer au rapport de Raynal et al. (2012) disponible ici : https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf ## Grille conventionnelle @@ -17,7 +17,7 @@ Plans de grille conventionnels : perpendiculaires à l'écoulement et peu i ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F1 de Raynal et al. (2012)[^Raynal2012] : +Le calcul des pertes de charges s'effectue à l'aide de la formule F1 de Raynal et al. (2012) : $$\xi = a * K_O * K_\beta$$ @@ -54,7 +54,7 @@ Plans de grille orientés par rapport à l'écoulement et quasi-verticaux. ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F2 de Raynal et al. (2012)[^Raynal2012] ou encore de l'équation (7) de Raynal et al. (2013)[^Raynal_P2_2013] +Le calcul des pertes de charges s'effectue à l'aide de la formule F2 de Raynal et al. (2012) ou encore de l'équation (7) de Raynal et al. (2013b) $$\xi = a * K_O * K_\alpha$$ @@ -79,7 +79,7 @@ Plans de grille perpendiculaires à l'écoulement, et inclinés par rapport à l ### Formule -Le calcul des pertes de charges s'effectue à l'aide de la formule F3 de Raynal et al. (2012)[^Raynal2012] ou encore de l'équation (11) de Raynal et al. (2013)[^Raynal_P1_2013] +Le calcul des pertes de charges s'effectue à l'aide de la formule F3 de Raynal et al. (2012) ou encore de l'équation (11) de Raynal et al. (2013a) $$\xi = a * K_b * K_\beta + K_{Fent} * K_{entH}$$ @@ -202,10 +202,10 @@ Le coefficient de forme des barreaux \(c\) vaut 1.69 pour le profil rectangulair | Forme des barreaux | Droplet | Plétina | Tadpole 8 | Tadpole 10 | Hydrodynamique | Rectangulaire | | --- | --- | --- | --- | --- | --- | --- | -| | <img src="ge.png" alt="Droplet" style="width:65px;height:289px;"> | <img src="pletina.png" alt="Plétina" style="width:65px;height:289px;"> | <img src="tadpole8.png" alt="Tadpole 8" style="width:65px;height:289px;"> | <img src="tadpole10.png" alt="Tadpole 10" style="width:65px;height:289px;"> | <img src="hydrodynamique.png" alt="Hydrodynamique" style="width:65px;height:289px;"> | <img src="rec.png" alt="Rectangulaire" style="width:65px;height:289px;"> | +| | <img src="ge.png" alt="Droplet" style="width:65px;height:289px;"> | <img src="pletina.png" alt="Plétina" style="width:65px;height:289px;"> | <img src="tadpole8.png" alt="Tadpole 8" style="width:65px;height:289px;"> | <img src="tadpole10.png" alt="Tadpole 10" style="width:65px;height:289px;"> | <img src="hydrodynamique.png" alt="Hydrodynamique" style="width:65px;height:289px;"> | <img src="rec.png" alt="Rectangulaire" style="width:65px;height:289px;"> | | Coefficient de forme $A_i$| 2.47 | 1.75 | 1.27 | 1.79 | 2.10 | 3.85 | -Extrait de Lemkecher et al. (2020)[^Lemkecher2020] +Extrait de Lemkecher et al. (2020) ### Coefficient de forme moyen des entretoises et éléments transversaux, pondérés selon leurs parts respectives @@ -215,10 +215,12 @@ A déterminer à partir des plans de la grille. Vaut par exemple 1.79 pour les entretoises cylindriques, 2.42 pour les entretoises rectangulaires, et de l'ordre de 4 pour les poutres carrées et IPN. -[^Raynal2012]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf +## Références -[^Raynal_P2_2013]: Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 +Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2012. Définition de prises d’eau ichtyocompatibles -Pertes de charge au passage des plans de grille inclinés ou orientés dans des configurations ichtyocompatibles et champs de vitesse à leur approche (POLE RA11.02). https://continuite-ecologique.fr/wp-content/uploads/2019/11/2012_014.pdf -[^Raynal_P1_2013]: Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 +Raynal, S., Courret, D., Chatellier, L., Larinier, M., David, L., 2013a. An experimental study on fish-friendly trashracks–Part 1. Inclined trashracks. Journal of Hydraulic Research 51, 56–66. https://doi.org/10.1080/00221686.2012.753647 -[^Lemkecher2020]: Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 +Raynal, S., Chatellier, L., Courret, D., Larinier, M., David, L., 2013b. An experimental study on fish-friendly trashracks–Part 2. Angled trashracks. Journal of Hydraulic Research 51, 67–75. https://doi.org/10.1080/00221686.2012.753646 + +Lemkecher, F., Chatellier, L., Courret, D., David, L., 2020. Contribution of Different Elements of Inclined Trash Racks to Head Losses Modeling. Water 12, 966. https://doi.org/10.3390/w12040966 diff --git a/docs/fr/calculators/pam/macrorugo_theorie.md b/docs/fr/calculators/pam/macrorugo_theorie.md index c4f1dba31..f1bb2c461 100644 --- a/docs/fr/calculators/pam/macrorugo_theorie.md +++ b/docs/fr/calculators/pam/macrorugo_theorie.md @@ -229,7 +229,7 @@ $$C_f = \frac{2}{(5.1 \mathrm{log} (h/k_s)+6)^2}$$ - \(z_0\) : rugosité hydraulique (m) - \(\tilde{z}\) : position verticale adimensionnelle \(\tilde{z} = z / k\) -## Bibliographie +## Références Cassan L, Laurens P. 2016. Design of emergent and submerged rock-ramp fish passes. Knowl. Manag. Aquat. Ecosyst., 417, 45. https://doi.org/10.1051/kmae/2016032 diff --git a/docs/fr/calculators/par/theorie_fatou.md b/docs/fr/calculators/par/theorie_fatou.md index 99ef738c9..953213793 100644 --- a/docs/fr/calculators/par/theorie_fatou.md +++ b/docs/fr/calculators/par/theorie_fatou.md @@ -1,14 +1,18 @@ # Passe à ralentisseurs "Fatou" +Tous les concepts et formules sont extraits de la référence suivante: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) + ## Caractéristiques géométriques  -*Extrait de Larinier, 2002[^Larinier2002]* +*Extrait de Larinier, 2002* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : +Les expériences effectuées par Larinier, 2002 ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +20,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 10% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 15% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs Fatou pour une pente de 20% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs Fatou pour une pente de 20% (Extrait de Larinier, 2002)* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -87,5 +91,3 @@ $$ Z_{r1} = Z_{d1} + \frac{0.3 S - 0.2}{\sqrt{1 + S^2}} $$ ## Cote d'arase minimale des murs latéraux \(Z_m\) $$ Z_m = Z_{r1} + \frac{4 L}{3 \sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/par/theorie_mixte.md b/docs/fr/calculators/par/theorie_mixte.md index 3ae635fd3..6ad5b733a 100644 --- a/docs/fr/calculators/par/theorie_mixte.md +++ b/docs/fr/calculators/par/theorie_mixte.md @@ -1,12 +1,16 @@ # Passe à ralentisseurs mixte ou à chevrons +Tous les concepts et formules sont extraits de la référence suivante: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) +  -*Extrait de Larinier, 2002[^Larinier2002]* +*Extrait de Larinier, 2002* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : +Les expériences effectuées par Larinier, 2002 ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +18,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abaques d'une passe à ralentisseurs mixte pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs mixte pour une pente de 10% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs mixte pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs mixte pour une pente de 15% (Extrait de Larinier, 2002)* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -73,6 +77,3 @@ $$ A_w = h \times L$$ ## Cote de radier amont \(Z_{r1}\) $$ Z_{r1} = Z_{d1} + \frac{3 a S - a}{\sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). - diff --git a/docs/fr/calculators/par/theorie_plans.md b/docs/fr/calculators/par/theorie_plans.md index 795901a3c..1c9838cb3 100644 --- a/docs/fr/calculators/par/theorie_plans.md +++ b/docs/fr/calculators/par/theorie_plans.md @@ -1,14 +1,18 @@ # Passe à ralentisseurs plans (Denil) +Tous les concepts et formules sont extraits de la référence suivante: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) + ## Caractéristiques géométriques  -*Extrait de Larinier, 2002[^Larinier2002]* +*Extrait de Larinier, 2002* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : +Les expériences effectuées par Larinier, 2002 ont permis d'établir des abaques permettant de relier le débit adimensionnel \(Q^*\) : $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$ @@ -16,15 +20,15 @@ $$ Q^* = \dfrac{Q}{\sqrt{g}L^{2,5}} $$  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 10% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 15% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 20% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs plans (Denil) pour une pente de 20% (Extrait de Larinier, 2002)* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous la forme de polynômes dépendant de la pente \(S\). @@ -87,5 +91,3 @@ $$ Z_{r1} = Z_{d1} - D \sin(45° + \arctan(S)) $$ ## Cote d'arase minimale des murs latéraux \(Z_m\) $$ Z_m = Z_{r1} + - H_{min} \sin(45° + \arctan(S)) $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). diff --git a/docs/fr/calculators/par/theorie_suractif.md b/docs/fr/calculators/par/theorie_suractif.md index 1df53028e..466482c38 100644 --- a/docs/fr/calculators/par/theorie_suractif.md +++ b/docs/fr/calculators/par/theorie_suractif.md @@ -1,12 +1,16 @@ # Passe à ralentisseurs à fond suractif +Tous les concepts et formules sont extraits de la référence suivante: + +Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109) +  -*Extrait de Larinier, 2002[^Larinier2002]* +*Extrait de Larinier, 2002* ## Lois hydrauliques issues des abaques -Les expériences effectuées par Larinier, 2002[^Larinier2002] ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : +Les expériences effectuées par Larinier, 2002 ont permis d'établir des abaques permettant de relier le débit adimensionnel \(q^*\) : $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$ @@ -14,11 +18,11 @@ $$ q^* = \dfrac{Q/L}{\sqrt{2g}a^{1,5}} $$  -*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 10% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 10% (Extrait de Larinier, 2002)*  -*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 15% (Extrait de Larinier, 2002[^Larinier2002])* +*Abaques d'une passe à ralentisseurs à fond suractif pour une pente de 15% (Extrait de Larinier, 2002)* Pour effectuer les calculs pour toutes les pentes entre 8% et 22%, les coefficients de polynômes des abaques ci-dessus sont eux-mêmes ajustés sous le forme de polynômes dépendant de la pente \(S\). @@ -73,5 +77,3 @@ $$ A_w = h \times L$$ ## Cote de radier amont \(Z_{r1}\) $$ Z_{r1} = Z_{d1} + \frac{2.6 a S - a}{\sqrt{1 + S^2}} $$ - -[^Larinier2002]: Larinier, M. 2002. “BAFFLE FISHWAYS.†Bulletin Français de La Pêche et de La Pisciculture, no. 364: 83–101. doi:[10.1051/kmae/2002109](https://doi.org/10.1051/kmae/2002109). -- GitLab From 58feeda982fa2e439a0fe843d2dd4acbe3ce4c0c Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 13:39:09 +0000 Subject: [PATCH 04/10] docs(pdf): Use chapters for first level markdown titles --- docs/latex/cassiopee_doc_en.tex | 5 ----- docs/latex/cassiopee_doc_fr.tex | 5 ----- scripts/mkdocs2pdf.py | 2 +- 3 files changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/latex/cassiopee_doc_en.tex b/docs/latex/cassiopee_doc_en.tex index 57ad984e4..429789843 100644 --- a/docs/latex/cassiopee_doc_en.tex +++ b/docs/latex/cassiopee_doc_en.tex @@ -75,18 +75,13 @@ %******************************************************************************* % Contenu de la documentation en anglais, généré par pandoc via mkdocs2pdf.py %******************************************************************************* -\chapter{Documentation} \input{cassiopee_doc_contents_en} - -\chapter{List of figures} \listoffigures \listoftables - % 4ème de couverture \cleartobackcover \input{rapport_inrae/backcover_inrae.tex} - \end{document} diff --git a/docs/latex/cassiopee_doc_fr.tex b/docs/latex/cassiopee_doc_fr.tex index 3004415c4..c6b40bc74 100644 --- a/docs/latex/cassiopee_doc_fr.tex +++ b/docs/latex/cassiopee_doc_fr.tex @@ -76,18 +76,13 @@ %******************************************************************************* % Contenu de la documentation en français, généré par pandoc via mkdocs2pdf.py %******************************************************************************* -\chapter{Documentation} \input{cassiopee_doc_contents_fr} - -\chapter{Table des illustrations} \listoffigures \listoftables - % 4ème de couverture \cleartobackcover \input{rapport_inrae/backcover_inrae.tex} - \end{document} diff --git a/scripts/mkdocs2pdf.py b/scripts/mkdocs2pdf.py index e734e7601..2916026c1 100644 --- a/scripts/mkdocs2pdf.py +++ b/scripts/mkdocs2pdf.py @@ -123,7 +123,7 @@ def exploreAndMerge(docs_dir, nav, output = '', level = 0): def convertMdToTex(filePath): # Convert .md to .tex runCommand( - 'pandoc {0}.md -f markdown -t latex -s -o {0}.tex'.format(filePath) + 'pandoc {0}.md -f markdown -t latex -s -o {0}.tex -V documentclass=report'.format(filePath) ) # Remove header of tex file bContent = False -- GitLab From 3d74c31f511313461a318599cdf1a8085dc3cd53 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 13:40:03 +0000 Subject: [PATCH 05/10] docs(pdf): Get List of Tables and Figures as unumbered chapters present in ToC --- docs/latex/cassiopee_preamble.tex | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/latex/cassiopee_preamble.tex b/docs/latex/cassiopee_preamble.tex index ca5487a12..a6b002392 100644 --- a/docs/latex/cassiopee_preamble.tex +++ b/docs/latex/cassiopee_preamble.tex @@ -60,6 +60,19 @@ \newunicodechar{≤}{\ensuremath{\leq}} \titleformat{\paragraph} - [block] - {\bfseries\sffamily\raggedright} - {\theparagraph}{0.5em}{} + [block] + {\bfseries\sffamily\raggedright} + {\theparagraph}{0.5em}{} + +\makeatletter +\renewcommand\listoftables{% + \chapter*{\listtablename}% + \addcontentsline{toc}{chapter}{\listtablename}% + \@starttoc{lot}% +} +\renewcommand\listoffigures{% + \chapter*{\listfigurename}% + \addcontentsline{toc}{chapter}{\listfigurename}% + \@starttoc{lof}% +} +\makeatother -- GitLab From cccd1d5be3f6854236cb573cb7c5eebf26ad78a4 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 13:43:38 +0000 Subject: [PATCH 06/10] docs: add JP Aubry as co-author of software and documentation --- docs/en/mentions_legales.md | 2 +- docs/fr/mentions_legales.md | 2 +- docs/latex/cassiopee_doc_en.tex | 2 +- docs/latex/cassiopee_doc_fr.tex | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/mentions_legales.md b/docs/en/mentions_legales.md index 59055318f..893b6d2a6 100644 --- a/docs/en/mentions_legales.md +++ b/docs/en/mentions_legales.md @@ -15,7 +15,7 @@ Director of publication: Marcel Kuper, Director of the UMR G-EAU Development Project Manager: David Dorchies -Developers: David Dorchies, François Grand, Mathias Chouet +Developers: David Dorchies, François Grand, Mathias Chouet, Jean-Pascal Aubry Cassiopée is a tool proposed by [OFB (French Office for Biodiversity)](https://ofb.gouv.fr/) within the framework of the OFB-Irstea conventions (Action n°100 of the 2016-2018 convention and Action n°21 of the 2019-2021 convention). diff --git a/docs/fr/mentions_legales.md b/docs/fr/mentions_legales.md index 570947aa0..0b029cf0b 100644 --- a/docs/fr/mentions_legales.md +++ b/docs/fr/mentions_legales.md @@ -17,7 +17,7 @@ Directeur de publication : Marcel Kuper, Directeur de l’UMR G-EAU Responsable du projet de développement : David Dorchies -Développeurs : David Dorchies, François Grand, Mathias Chouet +Développeurs : David Dorchies, François Grand, Mathias Chouet, Jean-Pascal Aubry Cassiopée est un outil proposé par [l'OFB (Office Français de la Biodiversité)](https://ofb.gouv.fr/) dans le cadre des conventions OFB-Irstea (Action n°100 de la convention 2016-2018 et Action n°21 de la convention 2019-2021). diff --git a/docs/latex/cassiopee_doc_en.tex b/docs/latex/cassiopee_doc_en.tex index 429789843..73cf09cff 100644 --- a/docs/latex/cassiopee_doc_en.tex +++ b/docs/latex/cassiopee_doc_en.tex @@ -25,7 +25,7 @@ \newcommand{\sousTitre}{version \cassiopeeversion\\User documentation} %Statut du document [rapport final, rapport intermédiaire] % auteur intellectuel, rédacteur du document, il peut y avoir plusieurs auteurs ; chaque auteur est renseigné sous la forme « Prénom NOM » -\newcommand{\auteur}{David DORCHIES, Mathias CHOUET, François GRAND} +\newcommand{\auteur}{David DORCHIES, Jean-Pascal AUBRY, Mathias CHOUET, François GRAND} % date de validation du document (qui entraine sa diffusion)] \newcommand{\dateValidation}{\today} % Site INRAE diff --git a/docs/latex/cassiopee_doc_fr.tex b/docs/latex/cassiopee_doc_fr.tex index c6b40bc74..0f73c9f9a 100644 --- a/docs/latex/cassiopee_doc_fr.tex +++ b/docs/latex/cassiopee_doc_fr.tex @@ -25,7 +25,7 @@ \newcommand{\sousTitre}{version \cassiopeeversion\\Documentation utilisateur} %Statut du document [rapport final, rapport intermédiaire] % auteur intellectuel, rédacteur du document, il peut y avoir plusieurs auteurs ; chaque auteur est renseigné sous la forme « Prénom NOM » -\newcommand{\auteur}{David DORCHIES, Mathias CHOUET, François GRAND} +\newcommand{\auteur}{David DORCHIES, Jean-Pascal AUBRY, Mathias CHOUET, François GRAND} % date de validation du document (qui entraine sa diffusion)] \newcommand{\dateValidation}{\today} % Site INRAE -- GitLab From a849033787452f4e97a2de7bf40ff2954afaebbf Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 13 Feb 2025 09:38:52 +0100 Subject: [PATCH 07/10] ci: change runner to goldenrunner --- .gitlab-ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8868651a1..f06e36542 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -9,7 +9,7 @@ stages: - releases-version default: - tags: [test] + tags: [goldenrunner] image: $CI_REGISTRY/cassiopee/nghyd:latest variables: -- GitLab From cffde01de9df9798d0b317d7962af7720bd593df Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 14:17:23 +0000 Subject: [PATCH 08/10] docs: convert footnotes to references Refs #655 --- docs/en/calculators/structures/dever_triang.md | 14 ++++++++------ docs/en/calculators/structures/kivi.md | 9 ++++----- docs/en/calculators/structures/villemonte_1947.md | 12 +++++++----- docs/fr/calculators/structures/dever_triang.md | 14 ++++++++------ docs/fr/calculators/structures/kivi.md | 10 ++++++---- docs/fr/calculators/structures/villemonte_1947.md | 12 +++++++----- 6 files changed, 40 insertions(+), 31 deletions(-) diff --git a/docs/en/calculators/structures/dever_triang.md b/docs/en/calculators/structures/dever_triang.md index c1e73dfc5..5fe022b51 100644 --- a/docs/en/calculators/structures/dever_triang.md +++ b/docs/en/calculators/structures/dever_triang.md @@ -2,7 +2,7 @@  -*Perspective view of a triangular weir (from CETMEF, 2005[^CETMEF2005] +*Perspective view of a triangular weir (from CETMEF, 2005 ## Free flow formula @@ -29,16 +29,18 @@ The weir is submerged as soon as \(Z_{2} > Z_{d}\) and [the Villemonte reduction Submergence occurs for \(h_2 / h_1 > 4 / 5\) with \(h_1 = Z_1 - Z_d\) and \(h_2 = Z_2 - Z_d\), and with \(Z_2\) the downstream water elevation. -The reduction coefficient proposed by Bos (1989) [^Bos1989] is then applied: +The reduction coefficient proposed by Bos (1989) is then applied: -![Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^Bos1989])](dever_triang_abaque_bos.png) + -*Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 [^Bos1989])* +*Submergence reduction factor for a V-notch broad-crested weir (from Bos, 1989 )* The abacus is approximated by the following formula: $$K_s = sin(3.9629 (1 - h_2 / h_1)^{0.575})$$ -[^CETMEF2005]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. +## References -[^Bos1989]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. +CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. + +Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. diff --git a/docs/en/calculators/structures/kivi.md b/docs/en/calculators/structures/kivi.md index 5e32fc83e..9cc01eb62 100644 --- a/docs/en/calculators/structures/kivi.md +++ b/docs/en/calculators/structures/kivi.md @@ -6,10 +6,7 @@ The calculation module allows hydraulic calculations to be carried out for sever  -*Perspective view of a rectangular weir with lateral contraction from CETMEF (2005)[^CETMEF2005]* - -[^CETMEF2005]: CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> - +*Perspective view of a rectangular weir with lateral contraction from CETMEF (2005)* Kindsvater-Carter formula corresponds to the classic weir formula: @@ -30,7 +27,7 @@ The coefficients \(\alpha\) and \(\beta\) depend on the ratio between the width  -*Excerpt from CETMEF (2005)[^CETMEF2005]* +*Excerpt from CETMEF (2005)* For a downstream water elevation higher than the elevation of the weir crest, the flow is submerged and a flooding coefficient is applied to the flow coefficient. @@ -44,4 +41,6 @@ With: - \(h_2\) the downstream water level above the weir crest - \(n\) the exponent in free flow relationships (rectangular=1.5, triangular=2.5, parabolic=2) +## References +CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> diff --git a/docs/en/calculators/structures/villemonte_1947.md b/docs/en/calculators/structures/villemonte_1947.md index 31859a4d8..90a8bd657 100644 --- a/docs/en/calculators/structures/villemonte_1947.md +++ b/docs/en/calculators/structures/villemonte_1947.md @@ -1,12 +1,10 @@ # Villemonte 1947 -The "Villemonte (1947)[^Villemonte1947]" equation uses the equation of the [Free weir](seuil_denoye.md) to which the flooding coefficient proposed by Villemonte applies (see explanations below). This flooding coefficient is also used for the triangular and truncated triangular weir formulas. +The "Villemonte (1947)" equation uses the equation of the [Free weir](seuil_denoye.md) to which the flooding coefficient proposed by Villemonte applies (see explanations below). This flooding coefficient is also used for the triangular and truncated triangular weir formulas.  -*Excerpt from CETMEF (2005)[^CETMEF2005]* - -[^CETMEF2005]: CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> +*Excerpt from CETMEF (2005)* For a downstream water elevation higher than the crest elevation of the weir, the flow is flooded and a flooding coefficient is applied to the flow coefficient. @@ -20,4 +18,8 @@ With: - \(h_2\) the downstream water level above the crest of the weir - \(n\) the exponent in free flow relationships (rectangular=1.5, triangular=2.5, parabolic=2) -[^Villemonte1947]: Villemonte, J.R., 1947. Submerged weir discharge studies. Engineering news record 866, 54–57. +## References + +CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> + +Villemonte, J.R., 1947. Submerged weir discharge studies. Engineering news record 866, 54–57. diff --git a/docs/fr/calculators/structures/dever_triang.md b/docs/fr/calculators/structures/dever_triang.md index 0f35fbfdb..8f412b6c9 100644 --- a/docs/fr/calculators/structures/dever_triang.md +++ b/docs/fr/calculators/structures/dever_triang.md @@ -2,7 +2,7 @@  -*Vue en perspective d'un déversoir triangulaire (d'après CETMEF, 2005[^CETMEF2005])* +*Vue en perspective d'un déversoir triangulaire (d'après CETMEF, 2005)* ## Formule du déversoir dénoyé @@ -29,16 +29,18 @@ Le seuil est noyé dès que \(Z_{2} > Z_{d}\) et [le coefficient de réduction d L'ennoiement a lieu pour \(h_2 / h_1 > 4 / 5\) avec \(h_1 = Z_1 - Z_d\) et \(h_2 = Z_2 - Z_d\), et avec \(Z_2\) la cote de l'eau à l'aval du seuil. -Le coefficient de réduction proposé par Bos (1989)[^Bos1989] est alors appliqué: +Le coefficient de réduction proposé par Bos (1989) est alors appliqué: -![Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (d'après Bos, 1989 [^Bos1989])](dever_triang_abaque_bos.png) + -*Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (extrait de Bos, 1989 [^Bos1989])* +*Coefficient d'ennoiement pour un déversoir triangulaire à crête épaisse (extrait de Bos, 1989 )* L'abaque est approché par la formule suivante : $$K_s = sin(3.9629 (1 - h_2 / h_1)^{0.575})$$ -[^CETMEF2005]: CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. +## Références -[^Bos1989]: Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. +CETMEF, 2005. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Centre d’Études Techniques Maritimes Et Fluviales, Compiègne. + +Bos, M.G., 1989. Discharge measurement structures., 3rd edition. ed, Publication. International Institute for Land Reclamation and Improvement, Wageningen, The Netherlands. diff --git a/docs/fr/calculators/structures/kivi.md b/docs/fr/calculators/structures/kivi.md index 4c190a36d..e2663a77c 100644 --- a/docs/fr/calculators/structures/kivi.md +++ b/docs/fr/calculators/structures/kivi.md @@ -7,9 +7,7 @@ Le module de calcul permet d'effectuer des calculs hydrauliques pour plusieurs o  -*Vue en perspective d'un déversoir rectangulaire avec contraction latérale (Extrait de CETMEF, 2005[^CETMEF2005])* - -[^CETMEF2005]: CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> +*Vue en perspective d'un déversoir rectangulaire avec contraction latérale (Extrait de CETMEF, 2005)* La formule de Kindsvater-Carter correspond à la formule classique du déversoir : @@ -30,7 +28,7 @@ Les coefficient \(\alpha\) et \(\beta\) dépendent du rapport entre la largeur d  -*Extrait de CETMEF, 2005[^CETMEF2005]* +*Extrait de CETMEF, 2005* Pour une cote de l'eau aval supérieure à la cote de la crête du déversoir, l'écoulement est noyé et un coefficient de noyage s'applique sur le coefficient de débit. @@ -45,3 +43,7 @@ Avec : - \(n\)l'exposant dans les relations d'écoulement dénoyé (rectangulaire=1.5, triangulaire=2.5, parabolique=2) Voir aussi : [Villemonte 1947](villemonte_1947.md) + +## Références + +CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> \ No newline at end of file diff --git a/docs/fr/calculators/structures/villemonte_1947.md b/docs/fr/calculators/structures/villemonte_1947.md index 6c5f1ac14..689c8609d 100644 --- a/docs/fr/calculators/structures/villemonte_1947.md +++ b/docs/fr/calculators/structures/villemonte_1947.md @@ -1,12 +1,10 @@ # Villemonte 1947 -L'équation "Villemonte (1947)[^Villemonte1947]" utilise l'équation du [seuil dénoyé](seuil_denoye.md) auquel s'applique le coefficient de noyage proposé par Villemonte (cf. explications ci-dessous). Ce coefficient de noyage est aussi utilisé pour les formules de seuil triangulaire et seuil triangulaire tronqué. +L'équation "Villemonte (1947)" utilise l'équation du [seuil dénoyé](seuil_denoye.md) auquel s'applique le coefficient de noyage proposé par Villemonte (cf. explications ci-dessous). Ce coefficient de noyage est aussi utilisé pour les formules de seuil triangulaire et seuil triangulaire tronqué.  -*Extrait de CETMEF, 2005[^CETMEF2005]* - -[^CETMEF2005]: CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> +*Extrait de CETMEF, 2005* Pour une cote de l'eau aval supérieure à la cote de la crête du déversoir, l'écoulement est noyé et un coefficient de noyage s'applique sur le coefficient de débit. @@ -20,4 +18,8 @@ Avec : - \(h_2\), la hauteur d'eau aval au dessus de la crête du déversoir - \(n\), l'exposant dans les relations d'écoulement dénoyé (rectangulaire=1.5, triangulaire=2.5, parabolique=2) -[^Villemonte1947]: Villemonte, J.R., 1947. Submerged weir discharge studies. Engineering news record 866, 54–57. +## Références + +CETMEF. Notice sur les déversoirs : synthèse des lois d’écoulement au droit des seuils et déversoirs. Compiègne: Centre d’Études Techniques Maritimes Et Fluviales, 2005. <http://www.side.developpement-durable.gouv.fr/EXPLOITATION/DEFAULT/doc/IFD/IFD_REFDOC_0513410/notice-sur-les-deversoirs-synthese-des-lois-d-ecoulement-au-droit-des-seuils-et-deversoirs> + +Villemonte, J.R., 1947. Submerged weir discharge studies. Engineering news record 866, 54–57. -- GitLab From b0330713bcae857ad114587948a29d9af4a4d997 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 14:21:33 +0000 Subject: [PATCH 09/10] docs: convert footnotes to references Refs #655 --- docs/en/calculators/pam/concentration.md | 8 +++++--- docs/en/calculators/pam/macrorugo.md | 9 +++++---- docs/fr/calculators/pam/concentration.md | 9 +++++---- docs/fr/calculators/pam/macrorugo.md | 9 +++++---- 4 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/en/calculators/pam/concentration.md b/docs/en/calculators/pam/concentration.md index 9666b3cd5..127f6d1dc 100644 --- a/docs/en/calculators/pam/concentration.md +++ b/docs/en/calculators/pam/concentration.md @@ -13,9 +13,7 @@ It allows to calculate one of the following values:  -*Excerpt from Larinier et al., 2006[^Larinier2006]* - -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 +*Excerpt from Larinier et al., 2006* The spacing between the blocks is then calculated with the following formula: @@ -36,3 +34,7 @@ $$ N = B / ax $$ When calculating the number of blocks, if it is not an integer, upward and downward harmonized numbers of blocks are given along with corresponding concentration values. Tolerance is of the order of a centimetre. + +## References + +Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 diff --git a/docs/en/calculators/pam/macrorugo.md b/docs/en/calculators/pam/macrorugo.md index 0382a13ff..fe107c2a0 100644 --- a/docs/en/calculators/pam/macrorugo.md +++ b/docs/en/calculators/pam/macrorugo.md @@ -4,10 +4,7 @@ The rock-ramp fishpass calculation module makes it possible to calculate the cha  -*Excerpt from Larinier et al., 2006[^Larinier2006]* - -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 - +*Excerpt from Larinier et al., 2006* The tool allows you to calculate one of the following values: @@ -30,3 +27,7 @@ It requires the following values to be entered: # Bed roughness  + +## references + +Larinier, Michel, Courret, D., Gomes, P., 2006. Technical guide for the design of "natural" fish passes, GHAPPE RA Report. Compagnie Nationale du Rhône / Adour Garonne Water Agency. http://dx.doi.org/10.13140/RG.2.1.1834.8562 diff --git a/docs/fr/calculators/pam/concentration.md b/docs/fr/calculators/pam/concentration.md index 18b8c6131..0f73795ea 100644 --- a/docs/fr/calculators/pam/concentration.md +++ b/docs/fr/calculators/pam/concentration.md @@ -13,10 +13,7 @@ L'outil permet de calculer l'une des valeurs suivantes :  -*Extrait de Larinier et al., 2006[^Larinier2006]* - -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 - +*Extrait de Larinier et al., 2006* L'espacement entre les blocs se calcule ensuite avec la formule suivante : @@ -37,3 +34,7 @@ $$ N = B / ax $$ Lors du calcul du nombre de blocs, si celui-ci n'est pas entier, des nombres de blocs harmonisés à la hausse et à la baisse sont proposés accompagnés des valeurs de concentration correspondantes. La tolérance est de l'ordre du centimètre. + +## Références + +Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 diff --git a/docs/fr/calculators/pam/macrorugo.md b/docs/fr/calculators/pam/macrorugo.md index 7fea02f19..fa963b019 100644 --- a/docs/fr/calculators/pam/macrorugo.md +++ b/docs/fr/calculators/pam/macrorugo.md @@ -4,10 +4,7 @@ Le module de calcul passe à macro-rugosités permet de calculer les caractéris  -*Extrait de Larinier et al., 2006[^Larinier2006]* - -[^Larinier2006]: Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 - +*Extrait de Larinier et al., 2006* L'outil permet de calculer l'une des valeurs suivantes : @@ -29,3 +26,7 @@ Il nécessite d'entrer les valeurs suivantes : # Rugosité de fond  + +## Références + +Larinier, Michel, Courret, D., Gomes, P., 2006. Guide technique pour la conception des passes à poissons “naturelles,†Rapport GHAPPE RA. Compagnie Nationale du Rhône / Agence de l’Eau Adour Garonne. http://dx.doi.org/10.13140/RG.2.1.1834.8562 -- GitLab From 598e66af5f48250577006f6bfc9bbc407a879346 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Thu, 27 Feb 2025 15:21:39 +0000 Subject: [PATCH 10/10] fix(docs): bug with CHANGELOG.md integration in documentation --- .gitignore | 1 + docs/en/CHANGELOG.md | 1 - docs/fr/CHANGELOG.md | 1 - scripts/mkdocs2pdf.py | 2 +- scripts/prepare_mkdocs.sh | 1 + 5 files changed, 3 insertions(+), 3 deletions(-) delete mode 120000 docs/en/CHANGELOG.md delete mode 120000 docs/fr/CHANGELOG.md diff --git a/.gitignore b/.gitignore index d484f6a04..c833fc0ed 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ /release /build /docs/pdf_build +/docs/*/CHANGELOG.md # dependencies /node_modules diff --git a/docs/en/CHANGELOG.md b/docs/en/CHANGELOG.md deleted file mode 120000 index 699cc9e7b..000000000 --- a/docs/en/CHANGELOG.md +++ /dev/null @@ -1 +0,0 @@ -../../CHANGELOG.md \ No newline at end of file diff --git a/docs/fr/CHANGELOG.md b/docs/fr/CHANGELOG.md deleted file mode 120000 index 699cc9e7b..000000000 --- a/docs/fr/CHANGELOG.md +++ /dev/null @@ -1 +0,0 @@ -../../CHANGELOG.md \ No newline at end of file diff --git a/scripts/mkdocs2pdf.py b/scripts/mkdocs2pdf.py index 2916026c1..525966734 100644 --- a/scripts/mkdocs2pdf.py +++ b/scripts/mkdocs2pdf.py @@ -145,7 +145,7 @@ def convertMdToTex(filePath): # force figures placement l = l.replace('\\begin{figure}', '\\begin{figure}[ht!]') # make som subsubsections invisible (for CHANGELOG) - l = re.sub(r'(\\subsubsection)({[0-9]+.[0-9]+.[0-9]+)', r'\1*\2', l) + l = re.sub(r'(\\subsection)({[0-9]+.[0-9]+.[0-9]+)', r'\1*\2', l) ls[i] = l with open('{}.tex'.format(filePath), 'w') as f: diff --git a/scripts/prepare_mkdocs.sh b/scripts/prepare_mkdocs.sh index 8cf1a93ca..ac3391257 100644 --- a/scripts/prepare_mkdocs.sh +++ b/scripts/prepare_mkdocs.sh @@ -17,6 +17,7 @@ function prepareMkdocs | sed "/^site_name:/ s/$/ v$VER/" \ | sed "/^docs_dir:/ s/docs_dir: /docs_dir: ..\//" \ | sed "/^site_dir:/ s/site_dir: /site_dir: ..\//" > $BUILD_DIR/mkdocs-$1.yml + cp -f CHANGELOG.md docs/$lang/ } node scripts/extract-nghyd-version.js $VER_FILE -- GitLab