diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e2981b58d5834f82ab66faad329f000afc0f0eff..c90b23b70625a2c7a904c305eccba4c95b2c49a0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -100,4 +100,4 @@ release-android: - web script: - npm run release-android - - find release -name "cassiopee-*.apk" -exec scp "{}" nghyd@aubes:/var/www/cassiopee-production/cassiopee-releases/android-nightly.zip \; + - find release -name "cassiopee-*.apk" -exec scp "{}" nghyd@aubes:/var/www/cassiopee-production/cassiopee-releases/android-nightly.apk \; diff --git a/CHANGELOG.md b/CHANGELOG.md index f676f48259a6d10ac4758ea2384f72f562e2cafc..eae65b32750004f2bf8c2f12042dd9e544b9a75d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,15 @@ # Historique des versions -## 4.9.0 - 2020-01-15 (On Fusionne Bien) +### 4.9.0 - 2020-01-15 (On Fusionne Bien) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Nouveau module "Concentration de blocs" ([jalhyd#185](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/185)) * Lechapt-Calmon : ajout des pertes de charge singulières ([nghyd#352](https://gitlab.irstea.fr/cassiopee/nghyd/issues/352), [jalhyd#172](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/172)) * Simplification du code des Formulaires ([nghyd#353](https://gitlab.irstea.fr/cassiopee/nghyd/issues/353)) * Passage de l'AFB à l'OFB : changement de logo, de nom, d'URL -### Documentation +#### Documentation * Documentation utilisateurs en anglais ([nghyd#321](https://gitlab.irstea.fr/cassiopee/nghyd/issues/321)) * Réorganisation de la documentation utilisateurs ([nghyd#355](https://gitlab.irstea.fr/cassiopee/nghyd/issues/355)) * Documentation développeurs ([nghyd#317](https://gitlab.irstea.fr/cassiopee/nghyd/issues/317)) @@ -17,14 +17,14 @@ * Diagramme de classes simplifié de JaLHyd -### Mises à jour de dépendances +#### Mises à jour de dépendances * Jasmine 3.5 * Karma 4.4 -## 4.8.1 - 2019-12-20 +### 4.8.1 - 2019-12-20 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Dever: Ajout d'un avertissement si la cote de radier d'un ouvrage est sous la cote de fond du lit ([jalhyd#179](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/179)) * Strickler: Ajout d'une aide contextuelle ([nghyd#332](https://gitlab.irstea.fr/cassiopee/nghyd/issues/332)) * Grille: permettre les calculs partiels ([nghyd#336](https://gitlab.irstea.fr/cassiopee/nghyd/issues/336)) @@ -47,7 +47,7 @@ * MacroRugo: transition douce entre régime émergent et régime submergé ([jalhyd#191](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/191)) -### Correction de bogues +#### Correction de bogues * Parfois, lorsque le débit varie, la PAB n'a pas d'eau à l'aval pour certaines valeurs de débit ([jalhyd#187](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/187)) * Lorsqu'on vide un champ, si on change de page, au retour le champ est à nouveau rempli ([nghyd#343](https://gitlab.irstea.fr/cassiopee/nghyd/issues/343)) * Impact de chute: Erreur de calcul de la chute nécessaire pour atteindre l'abscisse d'impact ([jalhyd#183](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/183)) @@ -56,16 +56,16 @@ * MacroRugoCompound: radier incliné - changer la répartition des cellules ([jalhyd#173](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/173)) -## 4.8.0 - 2019-11-26 (Affine et forte à la fois, par amour du remous) +### 4.8.0 - 2019-11-26 (Affine et forte à la fois, par amour du remous) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Module Fonction affine ([jalhyd#160](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/160), [nghyd#319](https://gitlab.irstea.fr/cassiopee/nghyd/issues/319)) * Module Trigonométrie ([jalhyd#161](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/161)) * Module Somme et produit de puissances ([jalhyd#162](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/162)) * Loi Déversoir noyé ([jalhyd#165](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/165), [nghyd#318](https://gitlab.irstea.fr/cassiopee/nghyd/issues/318)) * Logo animé lors du chargement de l'application ([nghyd#322](https://gitlab.irstea.fr/cassiopee/nghyd/issues/322)) -### Correction de bogues +#### Correction de bogues * MacroRugo: définition de la valeur par défaut de Cd0 à 1.2 ([jalhyd#166](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/166)) * Échec du calcul en chaîne dans certains cas ([nghyd#325](https://gitlab.irstea.fr/cassiopee/nghyd/issues/325)) * Remous : suppression de LargeurBerge dans le log ([nghyd#326](https://gitlab.irstea.fr/cassiopee/nghyd/issues/326)) @@ -75,38 +75,38 @@ * Calcul en chaîne : ERR inopiné dans le tableau de résultats fixes ([nghyd#329](https://gitlab.irstea.fr/cassiopee/nghyd/issues/329)) -## 4.7.0 - 2019-10-29 (AGB - Agence Grolandaise pour la Biodiversité) +### 4.7.0 - 2019-10-29 (AGB - Agence Grolandaise pour la Biodiversité) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Solveur multi-modules ([jalhyd#152](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/152), [nghyd#301](https://gitlab.irstea.fr/cassiopee/nghyd/issues/301)) * Nouvelle loi d'ouvrage: Orifice Dénoyé ([jalhyd#156](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/156), [nghyd#311](https://gitlab.irstea.fr/cassiopee/nghyd/issues/311)) * Script de déploiement d'une nouvelle version (sur Aubes) ([cassiopee2-integration#9](https://gitlab.irstea.fr/cassiopee/cassiopee2-integration/issues/9)) * Documentation lois d'ouvrages CEM88 V et D ([nghyd#315](https://gitlab.irstea.fr/cassiopee/nghyd/issues/315)) * Remous: connecter le ressaut sur un seul point lorsque le ressaut est court (une seule abscisse) ([nghyd#312](https://gitlab.irstea.fr/cassiopee/nghyd/issues/312)) -### Correction de bogues +#### Correction de bogues * Lois d'ouvrages: bug à l'affichage des résultats variés lorsque le calcul échoue ([jalhyd#163](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/163)) * PAB : problème de cotes sur les cloisons ([jalhyd#158](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/158)) * Calcul en chaîne: stopper la chaîne si une erreur survient ([jalhyd#155](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/155)) * Diagramme de Jet / de Section : problème de rafraîchissement ([nghyd#308](https://gitlab.irstea.fr/cassiopee/nghyd/issues/308)) * Remous : il manque parfois une abscisse ([jalhyd#147](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/147)) -### Mises à jour de dépendances +#### Mises à jour de dépendances * chartjs-plugin-zoom 0.7.4 -## 4.6.1 - 2019-10-15 +### 4.6.1 - 2019-10-15 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Suivi des comportements des utilisateurs à l'aide de Matomo (sur Aubes) ([nghyd#306](https://gitlab.irstea.fr/cassiopee/nghyd/issues/306)) * Documentation: faciliter l'accès à l'application plutôt qu'à GitLab ([nghyd#307](https://gitlab.irstea.fr/cassiopee/nghyd/issues/307)) -### Mises à jour de dépendances +#### Mises à jour de dépendances * chartjs-plugin-zoom 0.7.4 -## 4.6.0 - 2019-10-14 (Bluefish délavé) +### 4.6.0 - 2019-10-14 (Bluefish délavé) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Ajout du module Bief ([jalhyd#55](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/55), [nghyd#299](https://gitlab.irstea.fr/cassiopee/nghyd/issues/299)) * Ajout du module Grille ([jalhyd#114](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/114), [nghyd#289](https://gitlab.irstea.fr/cassiopee/nghyd/issues/289)) * Ajout du module Impact de Jet ([jalhyd#112](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/112), [nghyd#287](https://gitlab.irstea.fr/cassiopee/nghyd/issues/287)) @@ -122,7 +122,7 @@ * Préférences: applicaton de "precision" et "newtonMaxIter" à la Session en cours ([jalhyd#40](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/40), [nghyd#286](https://gitlab.irstea.fr/cassiopee/nghyd/issues/286)) * Lorsqu'un paramètre varie, ajout dans le log global d'un résumé des erreurs/avertissements ([jalhyd#140](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/140)) -### Correction de bogues +#### Correction de bogues * MacroRugo: écart des débits en submergé ([jalhyd#154](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/154)) * MacroRugo: non convergence du calcul pour les faibles profondeurs ([jalhyd#144](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/144)) * Remous : crash avec paramètre lié à un résultat non calculé ([jalhyd#151](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/151)) @@ -134,14 +134,14 @@ * Lois d'Ouvrages: les logs ne s'affichent pas ([jalhyd#120](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/120), [nghyd#284](https://gitlab.irstea.fr/cassiopee/nghyd/issues/284)) * Lois d'ouvrages: calculer un paramètre enfant en variant la cote aval fait planter les résultats ([nghyd#285](https://gitlab.irstea.fr/cassiopee/nghyd/issues/285)) -### Mises à jour de dépendances +#### Mises à jour de dépendances * chartjs-plugin-zoom 0.7.4 * ngx-markdown 8.2.1 * electron 6.0.10 -## 4.5.0 - 2019-09-09 (Fish ramps that rock!) +### 4.5.0 - 2019-09-09 (Fish ramps that rock!) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Passe à macro-rugosité complexe ([jalhyd#35](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/35), [nghyd#271](https://gitlab.irstea.fr/cassiopee/nghyd/issues/271)) * Réorganisation des onglets par glisser-déposer ([nghyd#206](https://gitlab.irstea.fr/cassiopee/nghyd/issues/206)) * Raccourcis clavier ([nghyd#192](https://gitlab.irstea.fr/cassiopee/nghyd/issues/192)) @@ -152,7 +152,7 @@ * Amélioration de la précision d'affichage ([nghyd#281](https://gitlab.irstea.fr/cassiopee/nghyd/issues/281), [nghyd#29](https://gitlab.irstea.fr/cassiopee/nghyd/issues/29)) * Ouverture d'un fichier de session pour chargement : prévenir si le fichier est vide ou mal formé ([nghyd#264](https://gitlab.irstea.fr/cassiopee/nghyd/issues/264)) -### Correction de bogues +#### Correction de bogues * Lechapt-Calmon : le sélecteur de matériaux n'a plus de sélection par défaut ([nghyd#276](https://gitlab.irstea.fr/cassiopee/nghyd/issues/276)) * Lechapt-Calmon : enregistrement de la propriété "matériaux" ([jalhyd#138](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/138)) * Lois d'ouvrages: plantage sur deux paramètres qui varient ([nghyd#273](https://gitlab.irstea.fr/cassiopee/nghyd/issues/273)) @@ -160,9 +160,9 @@ * Passe à bassins: il manque l'édition de la cote de radier de la cloison aval ([nghyd#277](https://gitlab.irstea.fr/cassiopee/nghyd/issues/277)) * Résultats fixés: l'unité des paramètres calculés n'est pas affichée ([nghyd#274](https://gitlab.irstea.fr/cassiopee/nghyd/issues/274)) -## 4.4.2 - 2019-08-06 +### 4.4.2 - 2019-08-06 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Boutons d'aide sur tous les éléments graphiques ([nghyd#157](https://gitlab.irstea.fr/cassiopee/nghyd/issues/157)) * Chargement de session: ouverture automatique du premier module nouvellement chargé * Touche Tab dans un champ de saisie: le texte est surligné ([nghyd#259](https://gitlab.irstea.fr/cassiopee/nghyd/issues/259)) @@ -172,7 +172,7 @@ * Erreur au chargement de session avec lien sur des paramètres calculés ([nghyd#263](https://gitlab.irstea.fr/cassiopee/nghyd/issues/263)) * Enregistrement de session partielle avec liens tronqués: enregistrer les valeurs courantes des paramètres ([jalhyd#133](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/133)) -### Correction de bogues +#### Correction de bogues * Documentation de la passe à Macrorugosités * Enregistrement de session: dédoublonner les messages concernant les dépendances * nodeType est lu depuis la Section et plus depuis le Nub parent ([jalhyd#124](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/124)) @@ -182,9 +182,9 @@ * Remous : l'itérateur d'abscisses est en retard sur le dessin du graphe ([nghyd#267](https://gitlab.irstea.fr/cassiopee/nghyd/issues/267)) -## 4.4.1 - 2019-07-30 +### 4.4.1 - 2019-07-30 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Passe à bassins : ajouter un accès rapide aux différents panneaux (table, résultats, graphiques...) pour éviter de faire défiler péniblement ([nghyd#237](https://gitlab.irstea.fr/cassiopee/nghyd/issues/237)) * Passe à bassins : permettre d'ajouter / dupliquer un ouvrage pour plusieurs cloisons à la fois ([nghyd#243](https://gitlab.irstea.fr/cassiopee/nghyd/issues/243)) * Passe à bassins : ajouter la nature du jet ([nghyd#245](https://gitlab.irstea.fr/cassiopee/nghyd/issues/245)) @@ -192,7 +192,7 @@ * Lois d'ouvrages: Ajouter le type de jet dans les résultats complémentaires des ouvrages ([jalhyd#92](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/92)) * Amélioration du titre et de l'icône de l'application ([nghyd#257](https://gitlab.irstea.fr/cassiopee/nghyd/issues/257)) -### Correction de bogues +#### Correction de bogues * Ne pas exposer les paramètres de cloisons pour les rendre liables ([nghyd#247](https://gitlab.irstea.fr/cassiopee/nghyd/issues/247), [jalhyd#111](https://gitlab.irstea.fr/cassiopee/jalhyd/issues/111)) * Passe à macro-rugosités : erreur de calcul ([nghyd#247](https://gitlab.irstea.fr/cassiopee/nghyd/issues/247)) @@ -208,14 +208,14 @@ * Paramètre varié : le champ d'édition de la liste de valeurs s'affiche mal ([nghyd#244](https://gitlab.irstea.fr/cassiopee/nghyd/issues/244)) * Paramètres liables : parfois le mat-select est trop étroit et on ne sait pas ce qu'on est en train de choisir ([nghyd#248](https://gitlab.irstea.fr/cassiopee/nghyd/issues/248)) -### Mises à jour de dépendances +#### Mises à jour de dépendances * Angular 8.1.2 -## 4.4.0 - 2019-07-16 (Basse à Sapins) +### 4.4.0 - 2019-07-16 (Basse à Sapins) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Module "Passe à bassins" * Plusieurs paramètres peuvent varier simultanément @@ -236,7 +236,7 @@ * Option pour désactiver les notifications à l'écran * Nouveaux tests -### Correction de bogues +#### Correction de bogues * Correction erreur de calcul de ZDV * Corrections d'erreurs liées au cycle de vie d'Angular @@ -247,9 +247,9 @@ * Nettoyage de code * Limitation de la précision numérique à différents endroits -## 4.3.0 - 2019-04-12 (Éditions LLL) +### 4.3.0 - 2019-04-12 (Éditions LLL) -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * Module "Passe à bassin : chute" * Module "Passe à bassin : nombre de bassins" @@ -262,15 +262,15 @@ * La touche TAB permet de passer directement d'un champ de saisie à un autre * Le bouton "+" disparaît sur la page d'accueil -### Correction de bogues +#### Correction de bogues * Divers bogues autour des paramètres liés * Mise à jour intempestive des paramètres calculés dans le formulaire de saisie * Précision d'affichage des données dans les infobulles -## 4.2.0 - 2019-03-11 +### 4.2.0 - 2019-03-11 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * titres courts pour les modules, suffixe numérique automatique * Lechapt-Calmon : amélioration du sélecteur de matériau @@ -281,7 +281,7 @@ * paramètres variables : courbe d'évolution * graphiques de résultats : choix libre de l'abscisse et de l'ordonnée -### Correction de bogues +#### Correction de bogues * déplacement de la sérialisation au niveau du modèle (JaLHyd) * nouvelle gestion des langues: plus robuste, charge moins de fichiers inutiles, ajout d'un cache @@ -297,9 +297,9 @@ * conservation du type de graphe lorsqu'on change de module * ajout de tests exhaustifs sur le calcul des paramètres et le clonage des modules -## 4.1.0 - 2019-02-20 +### 4.1.0 - 2019-02-20 -### Nouvelles fonctionnalités +#### Nouvelles fonctionnalités * interface : angular-material, angular-flex, charte graphique Irstea * nouvelle page de liste, modules groupés par thèmes @@ -316,7 +316,7 @@ * ajout de tests e2e avec Protractor * limitation de la précision dans les graphiques -### Correction de bogues +#### Correction de bogues * redirection des URL invalides vers /list * chargement de paramètres liés @@ -327,7 +327,7 @@ * renommage et simplification de classes * amélioration de la traduction -### Mises à jour de dépendances +#### Mises à jour de dépendances * Angular 7.2 * Compodoc @@ -336,4 +336,4 @@ * suppression de MDBootstrap * suppression de FontAwesome -## 4.0.0 - 2018-07-23 +### 4.0.0 - 2018-07-23 diff --git a/README.md b/README.md index 6c2ae08118ff38d1f1adb466d0f69f70befb5868..dfa6eb7ee2b3cf4ce998741d6696cf3bc013fc40 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,21 @@ See also [developers documentation](DEVELOPERS.md) (in french) * [jalhyd](https://gitlab.irstea.fr/cassiopee/jalhyd) * npm * python3 + * pandoc ^2 (optional, for PDF documentation only) + * texlive (optional, for PDF documentation only) -Building the documentation requires MkDocs and some extensions: +Building the HTML documentation requires MkDocs and some extensions: ```sh sudo apt install python3-pip python3-setuptools python3 -m pip install mkdocs python-markdown-math mkdocs-material ``` + +Building the PDF documentation requires pandoc and a LaTeX distribution (for ex. texlive) with a few packages: + +```sh +sudo apt install pandoc texlive latexmk texlive-latex-extra texlive-bibtex-extra +``` ### Install dependencies @@ -35,6 +43,7 @@ Then in `nghyd` folder, run : npm install ``` + ### Compile and get a deployable Web app ```sh @@ -42,6 +51,13 @@ npm run build ``` +### Compile and get a deployable Web app (without PDF doc) +Use this if you don't want to install LaTeX dependencies. +```sh +npm run build-no-pdf +``` + + ### Compile in dev (watch) mode ```sh @@ -178,15 +194,12 @@ npm run mkdocs ``` -### Create PDF documentation from HTML documentation +### Generate PDF documentation ```sh - sudo apt-get install texlive texlive-lang-french texlive-latex-extra pandoc +npm run mkdocs2pdf ``` -```sh -python3 mkdocs2pdf.py -``` ### Generate compodoc diff --git a/docs/en/calculators/hsl/courbe_remous.md b/docs/en/calculators/hsl/courbe_remous.md index 044e75d2708f21fb4fcec9a18a26e5c6167372c4..774c3bb635e26b5f97bc1774243a6fc5d3cadef4 100644 --- a/docs/en/calculators/hsl/courbe_remous.md +++ b/docs/en/calculators/hsl/courbe_remous.md @@ -30,12 +30,16 @@ If we take the example of a rectangular channel, [the proposed scilab code examp K=50; If=0.005; Q=0.01; - function z=DQ(y);z=Q-K*(b*y)^(5/3)/(b+2*y)^(2/3)*sqrt(If); endfunction + function z=DQ(y); + z=Q-K*(b*y)^(5/3)/(b+2*y)^(2/3)*sqrt(If); + endfunction yn=fsolve(0.5,DQ); tmax=0; t0=10; dt=-0.5; - function z=f(y,t);z=(If-Q^2*(b+2*y)^(4/3)/(K^2*(b*y)^(10/3)))/(1-Q^2/(9.81*b^2*y^3)); endfunction + function z=f(y,t); + z=(If-Q^2*(b+2*y)^(4/3)/(K^2*(b*y)^(10/3)))/(1-Q^2/(9.81*b^2*y^3)); + endfunction y0=0.12; ``` diff --git a/docs/en/calculators/hsl/strickler.md b/docs/en/calculators/hsl/strickler.md index 222842624eccaed7141e4ba41182fb2ab82fa6ff..d53965646c8c6edede6a5385a3b536e50b960ba2 100644 --- a/docs/en/calculators/hsl/strickler.md +++ b/docs/en/calculators/hsl/strickler.md @@ -15,952 +15,109 @@ with: The Strickler coefficient \(K_s\) varies from 20 (rough stone and rough surface) to 80 (smooth concrete and cast iron). +Manning's coefficient \(n\) is obtained by : + +$$n = \frac{1}{K_s}$$ + ## Chow's table (1959) -<table> -<thead> -<tr> -<th></th> -<th colspan="3">Strickler coefficient KS</th> -<th colspan="3">Manning coefficient n</th> -</tr> -</thead> -<tbody> -<tr> -<td>Type of channel and description</td> -<td>Minimum</td> -<td>Normal</td> -<td>Maximum</td> -<td>Minimum</td> -<td>Normal</td> -<td>Maximum</td> -</tr> -<tr> -<td colspan="7">Natural streams - minor streams (top width at floodstage < 30 m / 100 ft) -</td> -</tr> -<tr> -<td>1. Main channels</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  a. clean, straight, full stage, no rifts or deep pools -</td> -<td>40</td> -<td>33</td> -<td>30</td> -<td>0,025</td> -<td>0,03</td> -<td>0,033</td> -</tr> -<tr> -<td>  b. same as above, but more stones and weeds -</td> -<td>33</td> -<td>29</td> -<td>25</td> -<td>0,03</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td> c. clean, winding, some pools and shoals -</td> -<td>30</td> -<td>25</td> -<td>22</td> -<td>0,033</td> -<td>0,04</td> -<td>0,045</td> -</tr> -<tr> -<td>  d. same as above, but some weeds and stones -</td> -<td>29</td> -<td>22</td> -<td>20</td> -<td>0,035</td> -<td>0,045</td> -<td>0,05</td> -</tr> -<tr> -<td>  e. same as above, lower stages, more ineffective slopes and sections -</td> -<td>25</td> -<td>21</td> -<td>18</td> -<td>0,04</td> -<td>0,048</td> -<td>0,055</td> -</tr> -<tr> -<td>  f. same as "d" with more stones -</td> -<td>22</td> -<td>20</td> -<td>17</td> -<td>0,045</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>  g. sluggish reaches, weedy, deep pools -</td> -<td>20</td> -<td>14</td> -<td>13</td> -<td>0,05</td> -<td>0,07</td> -<td>0,08</td> -</tr> -<tr> -<td>  h. very weedy reaches, deep pools, or floodways  with heavy stand of timber and underbrush</td> -<td>13</td> -<td>10</td> -<td>7</td> -<td>0,075</td> -<td>0,1</td> -<td>0,15</td> -</tr> -<tr> -<td colspan="7">2. Mountain streams, no vegetation in channel, banks usually steep, trees and brush along banks submerged at high stages </td> -</tr> -<tr> -<td>  a. bottom: gravels, cobbles, and few boulders -</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>  b. bottom: cobbles with large boulders -</td> -<td>25</td> -<td>20</td> -<td>14</td> -<td>0,04</td> -<td>0,05</td> -<td>0,07</td> -</tr> -<tr> -<td colspan="7">3. Floodplains -</td> -</tr> -<tr> -<td>  a. Pasture, no brush -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. short grass</td> -<td>40</td> -<td>33</td> -<td>29</td> -<td>0,025</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td>2. high grass</td> -<td>33</td> -<td>29</td> -<td>20</td> -<td>0,03</td> -<td>0,035</td> -<td>0,05</td> -</tr> -<tr> -<td>b. Cultivated areas</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td> 1. no crop -</td> -<td>50</td> -<td>33</td> -<td>25</td> -<td>0,02</td> -<td>0,03</td> -<td>0,04</td> -</tr> -<tr> -<td>  2. mature row crops -</td> -<td>40</td> -<td>29</td> -<td>22</td> -<td>0,025</td> -<td>0,035</td> -<td>0,045</td> -</tr> -<tr> -<td>  3. mature field crops -</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>c. Brush</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. scattered brush, heavy weeds -</td> -<td>29</td> -<td>20</td> -<td>14</td> -<td>0,035</td> -<td>0,05</td> -<td>0,07</td> -</tr> -<tr> -<td>  2. light brush and trees, in winter -</td> -<td>29</td> -<td>20</td> -<td>17</td> -<td>0,035</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>  3. light brush and trees, in summer -</td> -<td>25</td> -<td>17</td> -<td>13</td> -<td>0,04</td> -<td>0,06</td> -<td>0,08</td> -</tr> -<tr> -<td>  4. medium to dense brush, in winter -</td> -<td>22</td> -<td>14</td> -<td>9</td> -<td>0,045</td> -<td>0,07</td> -<td>0,11</td> -</tr> -<tr> -<td>  5. medium to dense brush, in summer -</td> -<td>14</td> -<td>10</td> -<td>6</td> -<td>0,07</td> -<td>0,1</td> -<td>0,16</td> -</tr> -<tr> -<td>    d. Trees -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. dense willows, summer, straight -</td> -<td>9</td> -<td>7</td> -<td>5</td> -<td>0,11</td> -<td>0,15</td> -<td>0,2</td> -</tr> -<tr> -<td>  2. cleared land with tree stumps, no sprouts -</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>  3. same as above, but with heavy growth of sprouts -</td> -<td>20</td> -<td>17</td> -<td>13</td> -<td>0,05</td> -<td>0,06</td> -<td>0,08</td> -</tr> -<tr> -<td>  4. heavy stand of timber, a few down trees, little undergrowth, flood stage below branches </td> -<td>20</td> -<td>21</td> -<td>22</td> -<td>0,08</td> -<td>0,1</td> -<td>0,12</td> -</tr> -<tr> -<td>  5. same as 4. with flood stage reaching  branches -</td> -<td>10</td> -<td>8</td> -<td>6</td> -<td>0,1</td> -<td>0,12</td> -<td>0,16</td> -</tr> -<tr> -<td colspan="7">4. Excavated or Dredged Channels -</td> -</tr> -<tr> -<td>a. Earth, straight, and uniform -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. clean, recently completed</td> -<td>63</td> -<td>56</td> -<td>50</td> -<td>0,016</td> -<td>0,018</td> -<td>0,02</td> -</tr> -<tr> -<td> 2. clean, after weathering -</td> -<td>56</td> -<td>45</td> -<td>40</td> -<td>0,018</td> -<td>0,022</td> -<td>0,025</td> -</tr> -<tr> -<td>3. gravel, uniform section, clean</td> -<td>45</td> -<td>40</td> -<td>33</td> -<td>0,022</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td> 4. with short grass, few weeds -</td> -<td>45</td> -<td>37</td> -<td>30</td> -<td>0,022</td> -<td>0,027</td> -<td>0,033</td> -</tr> -<tr> -<td>b. Earth winding and sluggish -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. no vegetation</td> -<td>43</td> -<td>40</td> -<td>33</td> -<td>0,023</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td> 2. grass, some weeds -</td> -<td>40</td> -<td>33</td> -<td>30</td> -<td>0,025</td> -<td>0,03</td> -<td>0,033</td> -</tr> -<tr> -<td> 3. dense weeds or aquatic plants in deep channels -</td> -<td>33</td> -<td>29</td> -<td>25</td> -<td>0,03</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td> 4. earth bottom and rubble sides -</td> -<td>36</td> -<td>33</td> -<td>29</td> -<td>0,028</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td> 5. stony bottom and weedy banks -</td> -<td>40</td> -<td>29</td> -<td>25</td> -<td>0,025</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td> 6. cobble bottom and clean sides -</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>c. Dragline-excavated or dredged -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. no vegetation</td> -<td>40</td> -<td>36</td> -<td>30</td> -<td>0,025</td> -<td>0,028</td> -<td>0,033</td> -</tr> -<tr> -<td> 2. light brush on banks -</td> -<td>29</td> -<td>20</td> -<td>17</td> -<td>0,035</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>d. Rock cuts -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. smooth and uniform</td> -<td>40</td> -<td>29</td> -<td>25</td> -<td>0,025</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td> 2. jagged and irregular -</td> -<td>29</td> -<td>25</td> -<td>20</td> -<td>0,035</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>e. Channels not maintained, weeds and brush uncut -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. dense weeds, high as flow depth -</td> -<td>20</td> -<td>13</td> -<td>8</td> -<td>0,05</td> -<td>0,08</td> -<td>0,12</td> -</tr> -<tr> -<td>  2. clean bottom, brush on sides -</td> -<td>25</td> -<td>20</td> -<td>13</td> -<td>0,04</td> -<td>0,05</td> -<td>0,08</td> -</tr> -<tr> -<td>  3. same as above, highest stage of flow -</td> -<td>22</td> -<td>14</td> -<td>9</td> -<td>0,045</td> -<td>0,07</td> -<td>0,11</td> -</tr> -<tr> -<td>  4. dense brush, high stage -</td> -<td>13</td> -<td>10</td> -<td>7</td> -<td>0,08</td> -<td>0,1</td> -<td>0,14</td> -</tr> -<tr> -<td colspan="7">5. Lined or Constructed Channels -</td> -</tr> -<tr> -<td>a. Cement -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td> 1.  neat surface -</td> -<td>100</td> -<td>91</td> -<td>77</td> -<td>0,01</td> -<td>0,011</td> -<td>0,013</td> -</tr> -<tr> -<td> 2. mortar -</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>b. Wood -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td> 1. planed, untreated -</td> -<td>100</td> -<td>83</td> -<td>71</td> -<td>0,01</td> -<td>0,012</td> -<td>0,014</td> -</tr> -<tr> -<td> 2.  planed, creosoted -</td> -<td>91</td> -<td>83</td> -<td>67</td> -<td>0,011</td> -<td>0,012</td> -<td>0,015</td> -</tr> -<tr> -<td> 3. unplaned -</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td> 4. plank with battens -</td> -<td>83</td> -<td>67</td> -<td>56</td> -<td>0,012</td> -<td>0,015</td> -<td>0,018</td> -</tr> -<tr> -<td> 5. lined with roofing paper -</td> -<td>100</td> -<td>71</td> -<td>59</td> -<td>0,01</td> -<td>0,014</td> -<td>0,017</td> -</tr> -<tr> -<td>c. Concrete -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td> 1. trowel finish -</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>  2. float finish -</td> -<td>77</td> -<td>67</td> -<td>63</td> -<td>0,013</td> -<td>0,015</td> -<td>0,016</td> -</tr> -<tr> -<td>  3. finished, with gravel on bottom -</td> -<td>67</td> -<td>59</td> -<td>50</td> -<td>0,015</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>  4. unfinished -</td> -<td>71</td> -<td>59</td> -<td>50</td> -<td>0,014</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>  5. gunite, good section -</td> -<td>63</td> -<td>53</td> -<td>43</td> -<td>0,016</td> -<td>0,019</td> -<td>0,023</td> -</tr> -<tr> -<td>  6. gunite, wavy section -</td> -<td>56</td> -<td>45</td> -<td>40</td> -<td>0,018</td> -<td>0,022</td> -<td>0,025</td> -</tr> -<tr> -<td>  7. on good excavated rock -</td> -<td>59</td> -<td>50</td> -<td></td> -<td>0,017</td> -<td>0,02</td> -<td></td> -</tr> -<tr> -<td>  8. on irregular excavated rock -</td> -<td>45</td> -<td>37</td> -<td></td> -<td>0,022</td> -<td>0,027</td> -<td></td> -</tr> -<tr> -<td>d. Concrete bottom float finish with sides of: -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. dressed stone in mortar -</td> -<td>67</td> -<td>59</td> -<td>50</td> -<td>0,015</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>  2. random stone in mortar -</td> -<td>59</td> -<td>50</td> -<td>42</td> -<td>0,017</td> -<td>0,02</td> -<td>0,024</td> -</tr> -<tr> -<td>  3. cement rubble masonry, plastered -</td> -<td>63</td> -<td>50</td> -<td>42</td> -<td>0,016</td> -<td>0,02</td> -<td>0,024</td> -</tr> -<tr> -<td>  4. cement rubble masonry -</td> -<td>50</td> -<td>40</td> -<td>33</td> -<td>0,02</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>  5. dry rubble or riprap -</td> -<td>50</td> -<td>33</td> -<td>29</td> -<td>0,02</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td>e. Gravel bottom with sides of: -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. formed concrete -</td> -<td>59</td> -<td>50</td> -<td>40</td> -<td>0,017</td> -<td>0,02</td> -<td>0,025</td> -</tr> -<tr> -<td>  2. random stone mortar -</td> -<td>50</td> -<td>43</td> -<td>38</td> -<td>0,02</td> -<td>0,023</td> -<td>0,026</td> -</tr> -<tr> -<td>  3. dry rubble or riprap -</td> -<td>43</td> -<td>30</td> -<td>28</td> -<td>0,023</td> -<td>0,033</td> -<td>0,036</td> -</tr> -<tr> -<td>f. Brick -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. glazed -</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>  2. in cement mortar -</td> -<td>83</td> -<td>67</td> -<td>56</td> -<td>0,012</td> -<td>0,015</td> -<td>0,018</td> -</tr> -<tr> -<td>g. Masonry -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. cemented rubble -</td> -<td>59</td> -<td>40</td> -<td>33</td> -<td>0,017</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>  2. dry rubble -</td> -<td>43</td> -<td>31</td> -<td>29</td> -<td>0,023</td> -<td>0,032</td> -<td>0,035</td> -</tr> -<tr> -<td>h. Dressed ashlar/stone paving -</td> -<td>77</td> -<td>67</td> -<td>59</td> -<td>0,013</td> -<td>0,015</td> -<td>0,017</td> -</tr> -<tr> -<td>i. Asphalt -</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>  1. smooth -</td> -<td>77</td> -<td>77</td> -<td></td> -<td>0,013</td> -<td>0,013</td> -<td></td> -</tr> -<tr> -<td>  2. rough -</td> -<td>63</td> -<td>63</td> -<td></td> -<td>0,016</td> -<td>0,016</td> -<td></td> -</tr> -<tr> -<td>j. Vegetal lining -</td> -<td>33</td> -<td></td> -<td>2</td> -<td>0,03</td> -<td></td> -<td>0,5</td> -</tr> -</tbody> -</table> \ No newline at end of file +| Type of channel and description | \(K_S\) min. | \(K_S\) normal | \(K_S\) max. | +|------------------------------------------|----------:|----------:|----------:| +| **1\. Main channels** | | | | +| a\. clean, straight, full stage, no rifts or deep pools | 30 | 33 | 40 | +| b\. same as above, but more stones and weeds | 25 | 29 | 33 | +| c\. clean, winding, some pools and shoals | 22 | 25 | 30 | +| d\. same as above, but some weeds and stones | 20 | 22 | 29 | +| e\. same as above, lower stages, more ineffective slopes and sections | 18 | 21 | 25 | +| f\. same as "d" with more stones | 17 | 20 | 22 | +| g\. sluggish reaches, weedy, deep pools | 13 | 14 | 20 | +| h\. very weedy reaches, deep pools, or floodways with heavy stand of timber and underbrush | 7 | 10 | 13 | +| **2\. Mountain streams, no vegetation in channel, banks usually steep, trees and brush along banks submerged at high stages** | +| a\. bottom: gravels, cobbles, and few boulders | 20 | 25 | 33 | +| b\. bottom: cobbles with large boulders | 14 | 20 | 25 | +| **3\. Floodplains** | +| *a\. Pasture, no brush* | | | | +| 1\. short grass | 29 | 33 | 40 | +| 2\. high grass | 20 | 29 | 33 | +| *b\. Cultivated areas* | | | | +| 1\. no crop | 25 | 33 | 50 | +| 2\. mature row crops | 22 | 29 | 40 | +| 3\. mature field crops | 20 | 25 | 33 | +| *c\. Brush* | | | | +| 1\. scattered brush, heavy weeds | 14 | 20 | 29 | +| 2\. light brush and trees, in winter | 17 | 20 | 29 | +| 3\. light brush and trees, in summer | 13 | 17 | 25 | +| 4\. medium to dense brush, in winter | 9 | 14 | 22 | +| 5\. medium to dense brush, in summer | 6 | 10 | 14 | +| *d\. Trees* | | | | +| 1\. dense willows, summer, straight | 5 | 7 | 9 | +| 2\. cleared land with tree stumps, no sprouts | 20 | 25 | 33 | +| 3\. same as above, but with heavy growth of sprouts | 13 | 17 | 20 | +| 4\. heavy stand of timber, a few down trees, little undergrowth, flood stage below branches | 22 | 21 | 20 | +| 5\. same as 4\. with flood stage reaching branches | 6 | 8 | 10 | +| **4\. Excavated or Dredged Channels** | +| *a\. Earth, straight, and uniform* | | | | +| 1\. clean, recently completed | 50 | 56 | 63 | +| 2\. clean, after weathering | 40 | 45 | 56 | +| 3\. gravel, uniform section, clean | 33 | 40 | 45 | +| 4\. with short grass, few weeds | 30 | 37 | 45 | +| *b\. Earth winding and sluggish* | | | | +| 1\. no vegetation | 33 | 40 | 43 | +| 2\. grass, some weeds | 30 | 33 | 40 | +| 3\. dense weeds or aquatic plants in deep channels | 25 | 29 | 33 | +| 4\. earth bottom and rubble sides | 29 | 33 | 36 | +| 5\. stony bottom and weedy banks | 25 | 29 | 40 | +| 6\. cobble bottom and clean sides | 20 | 25 | 33 | +| *c\. Dragline\-excavated or dredged* | | | | +| 1\. no vegetation | 30 | 36 | 40 | +| 2\. light brush on banks | 17 | 20 | 29 | +| *d\. Rock cuts* | | | | +| 1\. smooth and uniform | 25 | 29 | 40 | +| 2\. jagged and irregular | 20 | 25 | 29 | +| *e\. Channels not maintained, weeds and brush uncut* | | | | +| 1\. dense weeds, high as flow depth | 8 | 13 | 20 | +| 2\. clean bottom, brush on sides | 13 | 20 | 25 | +| 3\. same as above, highest stage of flow | 9 | 14 | 22 | +| 4\. dense brush, high stage | 7 | 10 | 13 | +| **5\. Lined or Constructed Channels** | +| *a\. Cement* | | | | +| 1\. neat surface | 77 | 91 | 100 | +| 2\. mortar | 67 | 77 | 91 | +| *b\. Wood* | | | | +| 1\. planed, untreated | 71 | 83 | 100 | +| 2\. planed, creosoted | 67 | 83 | 91 | +| 3\. unplaned | 67 | 77 | 91 | +| 4\. plank with battens | 56 | 67 | 83 | +| 5\. lined with roofing paper | 59 | 71 | 100 | +| *c\. Concrete* | | | | +| 1\. trowel finish | 67 | 77 | 91 | +| 2\. float finish | 63 | 67 | 77 | +| 3\. finished, with gravel on bottom | 50 | 59 | 67 | +| 4\. unfinished | 50 | 59 | 71 | +| 5\. gunite, good section | 43 | 53 | 63 | +| 6\. gunite, wavy section | 40 | 45 | 56 | +| 7\. on good excavated rock | | 50 | 59 | +| 8\. on irregular excavated rock | | 37 | 45 | +| *d\. Concrete bottom float finish with sides of:* | | | | +| 1\. dressed stone in mortar | 50 | 59 | 67 | +| 2\. random stone in mortar | 42 | 50 | 59 | +| 3\. cement rubble masonry, plastered | 42 | 50 | 63 | +| 4\. cement rubble masonry | 33 | 40 | 50 | +| 5\. dry rubble or riprap | 29 | 33 | 50 | +| *e\. Gravel bottom with sides of:* | | | | +| 1\. formed concrete | 40 | 50 | 59 | +| 2\. random stone mortar | 38 | 43 | 50 | +| 3\. dry rubble or riprap | 28 | 30 | 43 | +| *f\. Brick* | | | | +| 1\. glazed | 67 | 77 | 91 | +| 2\. in cement mortar | 56 | 67 | 83 | +| *g\. Masonry* | | | | +| 1\. cemented rubble | 33 | 40 | 59 | +| 2\. dry rubble | 29 | 31 | 43 | +| *h\. Dressed ashlar/stone paving* | 59 | 67 | 77 | +| *i\. Asphalt* | | | | +| 1\. smooth | | 77 | 77 | +| 2\. rough | | 63 | 63 | +| *j\. Vegetal lining* | 2 | | 33 | + +Table: Chow's table (1959) diff --git a/docs/en/calculators/hyd_en_charge/lechapt-calmon.md b/docs/en/calculators/hyd_en_charge/lechapt-calmon.md index 35ed86198ba7266e574bd50212296c5a96b8ac38..4f42f1ab60dd086dfc7244f635ae288c8184f808 100644 --- a/docs/en/calculators/hyd_en_charge/lechapt-calmon.md +++ b/docs/en/calculators/hyd_en_charge/lechapt-calmon.md @@ -18,8 +18,8 @@ The error made with respect to the Colebrook formula is less than 3% for speeds The correlation table of the coefficients is as follows: -| Matériau | ϵ (mm) | \(L\) | \(M\) | \(N\) | -|----------|-------------:|----:|----:|-----:| +| Material | ϵ (mm) | \(L\) | \(M\) | \(N\) | +|------------------------------------------------|-------------:|----:| | Uncoated cast iron or steel - Coarse concrete (corrosive water) | 2 | 1.863 | 2 | 5.33 | | Uncoated cast iron or steel - Coarse concrete (low corrosive water) | 1 | 1.601 | 1.975 | 5.25 | | Cast iron or steel with cement coating | 0.5 | 1.40 | 1.96 | 5.19 | diff --git a/docs/en/calculators/structures/fente_noyee.md b/docs/en/calculators/structures/fente_noyee.md index f03a00ac199a8a7169d93a4555842c60e04d66db..fc77817d5f45b67540b6654cff0c573b4dad65b8 100644 --- a/docs/en/calculators/structures/fente_noyee.md +++ b/docs/en/calculators/structures/fente_noyee.md @@ -14,4 +14,4 @@ With: * *H<sub>1</sub>* the head on the slot m * *μ* the discharge coefficient (equal to 0.65 by default). -The discharge coefficient *μ* may vary from 0.65 for a sharp-edged slot to more than 0.85 when the slot profile is rounded. \ No newline at end of file +The discharge coefficient *μ* may vary from 0.65 for a sharp-edged slot to more than 0.85 when the slot profile is rounded. diff --git a/docs/en/calculators/structures/kivi.md b/docs/en/calculators/structures/kivi.md index 83c9f3c485e9041893a64df4c7c6c2fb84b989c2..80e05c0c2aa7aceaa3d88a77c993a72da301e3cb 100644 --- a/docs/en/calculators/structures/kivi.md +++ b/docs/en/calculators/structures/kivi.md @@ -2,7 +2,7 @@ The calculation module allows hydraulic calculations to be carried out for several structures in parallel. -## Kindsvater-Carter formula (1957) +## Kindsvater-Carter formula (1957)  diff --git a/docs/en/calculators/structures/liste.md b/docs/en/calculators/structures/liste.md index 1ef7626b65aeaa8e26651d20c3596f907818dacb..99662c99d6cae5b880823d64033e0ef79f0fc101 100644 --- a/docs/en/calculators/structures/liste.md +++ b/docs/en/calculators/structures/liste.md @@ -1,7 +1,7 @@ # Stage-discharge equations list | Equation | Default discharge coefficient | Available in | -|---|---|---| +|---------------------------|----------------:|-------------------------------| | [Weir / orifice Cemagref 88](./cem_88_d.md) | 0.4 | Parallel Structures | | [Weir / undershot gate Cemagref 88](./cem_88_v.md) | 0.6 | Parallel Structures | | [Cunge 80](./cunge_80.md) | 0.6 | Parallel Structures | @@ -10,11 +10,13 @@ | [Free flow weir](./seuil_denoye.md) | 0.4 | Parallel Structures, Free flow weir stage-discharge laws | | [Submerged weir](./seuil_noye.md) | 0.9 | Parallel Structures | | [Submerged slot (Larinier 1992)](./fente_noyee.md) | 0.75 | Parallel Structures, Cross walls, Downwall | -| [Kindsvater-Carter and Villemonte](./kivi.md) | α=0.4, β=0.001 | Parallel Structures | +| [Kindsvater-Carter and Villemonte](./kivi.md) | \(\alpha\)=0.4, \(\beta\)=0.001 | Parallel Structures | | [Triangular weir (Villemonte)](./dever_triang.md) | 1.36 | Parallel Structures, Free flow weir stage-discharge laws, Cross walls, Downwall | | [Truncated triangular weir (Villemonte)](./dever_triang_tronque.md) | 1.36 | Parallel Structures, Free flow weir stage-discharge laws, Cross walls, Downwall | | [Submerged orifice](./orifice_noye.md) | 0.7 | Parallel Structures, Cross walls, Downwall | | [Free orifice](./orifice_denoye.md) | 0.7 | Parallel Structures | | [Villemonte 1947](./villemonte_1947.md) | 0.4 | Parallel Structures, Cross walls, Downwall | | [Regulated notch (Villemonte 1957)](../pab/pab.md#the-downstream-partition) | 0.4 | Downwall | -| [Regulated submerged slot (Larinier 1992)](../pab/pab.md#the-downstream-partition) | 0.75 | Downwall | \ No newline at end of file +| [Regulated submerged slot (Larinier 1992)](../pab/pab.md#the-downstream-partition) | 0.75 | Downwall | + +Table: Stage-discharge equations list diff --git a/docs/en/calculators/structures/seuil_noye.md b/docs/en/calculators/structures/seuil_noye.md index 7aebe9cf51186b5663e2e962b2970ce3568e5bed..2fb05939afdd09c8d8d942d86c3779b76c7b5be4 100644 --- a/docs/en/calculators/structures/seuil_noye.md +++ b/docs/en/calculators/structures/seuil_noye.md @@ -1,10 +1,11 @@ + # Submerged weir formula  *Excerpt from: Rajaratnam, N., Muralidhar, D., 1969. Flow below deeply submerged rectangular weirs. Journal of Hydraulic Research 7, 355–374.* -In submerged flow, the flow rate depends on the upstream water level \(h_{amont}\) and the downstream water level \(h_{aval}\): +In submerged flow, the flow rate depends on the upstream water level \(h_{amont}\) and the downstream water level \(h_{aval}\) (Rajaratnam et al., 1969): $$Q = Cd \sqrt{2g} Lh_{aval} \sqrt{h_{amont}-h_{aval}}$$ @@ -16,3 +17,5 @@ With: * *C<sub>d</sub>* the discharge coefficient (equal to 0.9 by default). This formula is not recommended for flooding below 80%. + +*Rajaratnam, N., Muralidhar, D., 1969. Flow below deeply submerged rectangular weirs. Journal of Hydraulic Research 7, 355–374.* diff --git a/docs/en/calculators/structures/vanne_denoyee_schema.png b/docs/en/calculators/structures/vanne_denoyee_schema.png index 1868e850d243f507d159827d895587b7c9c554df..37b61e24b1589831f622e7d4406f79db7f521986 100644 Binary files a/docs/en/calculators/structures/vanne_denoyee_schema.png and b/docs/en/calculators/structures/vanne_denoyee_schema.png differ diff --git a/docs/en/calculators/structures/vanne_noyee_schema.png b/docs/en/calculators/structures/vanne_noyee_schema.png index 29427f1e7b74d104f0063fdfd787c3ef90fc4d21..506cab28f5ed684b9e8e76c79c8f9363864e06d5 100644 Binary files a/docs/en/calculators/structures/vanne_noyee_schema.png and b/docs/en/calculators/structures/vanne_noyee_schema.png differ diff --git a/docs/en/general/principe_fonctionnement_grandeurs.png b/docs/en/general/principe_fonctionnement_grandeurs.png index 8c40f20fc07ac5f9168a895aec04858d5b55b38d..431c4690461e74eae41484ab0d13d1ccf224dbd0 100644 Binary files a/docs/en/general/principe_fonctionnement_grandeurs.png and b/docs/en/general/principe_fonctionnement_grandeurs.png differ diff --git a/docs/en/general/principe_fonctionnement_resultat_fix.png b/docs/en/general/principe_fonctionnement_resultat_fix.png index 5dad10b2da6ec52c81fd196d59822934fa04882e..98076414edfd095d19e6cf7a1b384815e9d56ae7 100644 Binary files a/docs/en/general/principe_fonctionnement_resultat_fix.png and b/docs/en/general/principe_fonctionnement_resultat_fix.png differ diff --git a/docs/en/general/principe_fonctionnement_resultat_var.png b/docs/en/general/principe_fonctionnement_resultat_var.png index 6215f87e5995b6c6065a5d437e4af12ec8dbfd46..32f5b35f9ba6ba56a0717a67c155b1c8e93968e1 100644 Binary files a/docs/en/general/principe_fonctionnement_resultat_var.png and b/docs/en/general/principe_fonctionnement_resultat_var.png differ diff --git a/docs/en/general/principe_fonctionnement_varie_liste.png b/docs/en/general/principe_fonctionnement_varie_liste.png index 95440f2ae06ce205c201c0c2b56141c051bc61de..e8a9107902bce7f88e6e223323f4877c2d0de6a1 100644 Binary files a/docs/en/general/principe_fonctionnement_varie_liste.png and b/docs/en/general/principe_fonctionnement_varie_liste.png differ diff --git a/docs/en/general/principe_fonctionnement_varie_pas.png b/docs/en/general/principe_fonctionnement_varie_pas.png index b258a9816b12c549e71689eff07d73083503d6ec..7b14514802841fa277b3b24cb217efa5b6902c29 100644 Binary files a/docs/en/general/principe_fonctionnement_varie_pas.png and b/docs/en/general/principe_fonctionnement_varie_pas.png differ diff --git a/docs/en/index.md b/docs/en/index.md index 3da57228160870a569759e971f81670416c28928..e0c5902a3b0e09c34a37014b7eb969150063a92a 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -14,3 +14,7 @@ Cassiopée is a software dedicated to rivers hydraulics with especially some hel ## Pre-requisites - installation Cassiopée does not require any installation. It is available online using an up-to-date browser (tested with Firefox, Chrome and Chromium) by navigating to the following address: [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr) + +## Documentation + +Download [documentation in PDF format](https://cassiopee.g-eau.fr/assets/docs/pdf/cassiopee_doc_en.pdf) diff --git a/docs/en/methodes_numeriques/rk4.md b/docs/en/methodes_numeriques/rk4.md index 0b6579bc8faae8cef2a16ebcad5b7f25ad191350..88616fd1d7d4129cb6b8cfacd458ee2e6661d0cb 100644 --- a/docs/en/methodes_numeriques/rk4.md +++ b/docs/en/methodes_numeriques/rk4.md @@ -36,7 +36,8 @@ N=(tmax-t0)/dt; ii=1:N+1; t=(ii-1)*dt; // time vector -t2=0:tmax; // time vector with a finer step, for the exact solution +// time vector with a finer step, for the exact solution +t2=0:tmax; // Solution by Euler method, noted ye ye(1)=y0; // boundary condition diff --git a/docs/fr/calculators/hsl/courbe_remous.md b/docs/fr/calculators/hsl/courbe_remous.md index 71635ff22060bd42985b34fd920142bfb61490eb..46c735105c909fdc2d03c4cef4d24640230647fe 100644 --- a/docs/fr/calculators/hsl/courbe_remous.md +++ b/docs/fr/calculators/hsl/courbe_remous.md @@ -29,12 +29,16 @@ Si on prend l'exemple d'un canal rectangulaire, [l'exemple de code scilab propos K=50; If=0.005; Q=0.01; - function z=DQ(y);z=Q-K*(b*y)^(5/3)/(b+2*y)^(2/3)*sqrt(If); endfunction + function z=DQ(y); + z=Q-K*(b*y)^(5/3)/(b+2*y)^(2/3)*sqrt(If); + endfunction yn=fsolve(0.5,DQ); tmax=0; t0=10; dt=-0.5; - function z=f(y,t);z=(If-Q^2*(b+2*y)^(4/3)/(K^2*(b*y)^(10/3)))/(1-Q^2/(9.81*b^2*y^3)); endfunction + function z=f(y,t); + z=(If-Q^2*(b+2*y)^(4/3)/(K^2*(b*y)^(10/3)))/(1-Q^2/(9.81*b^2*y^3)); + endfunction y0=0.12; ``` diff --git a/docs/fr/calculators/hsl/strickler.md b/docs/fr/calculators/hsl/strickler.md index 5527ee21311332591b384465390a6d9d243dd49a..9dd996798eb5413fc11bf6ca8038fd65cc531cc9 100644 --- a/docs/fr/calculators/hsl/strickler.md +++ b/docs/fr/calculators/hsl/strickler.md @@ -15,868 +15,109 @@ avec : Le coefficient de Strickler \(K_s\) varie de 20 (pierre brute et surface rugueuse) à 80 (béton lisse et fonte). +Le coefficient de Manning \(n\) est obtenu par : + +$$n = \frac{1}{K_s}$$ + ## Tableau de Chow (1959) -<table> -<thead> -<tr> -<th></th> -<th colspan="3">Coefficient de Strickler KS</th> -<th colspan="3">Coefficient de Manning n</th> -</tr> -</thead> -<tbody> -<tr> -<td>Type de chenal et description</td> -<td>Minimum</td> -<td>Normal</td> -<td>Maximum</td> -<td>Minimum</td> -<td>Normal</td> -<td>Maximum</td> -</tr> -<tr> -<td colspan="7">Cours d'eau naturels - petits cours d'eau (largeur au plein bord < 30 m / 100 pieds)</td> -</tr> -<tr> -<td>1. Lits mineurs</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>a. propres, rectilignes, bien remplis d'eau, sans failles ni mouilles profondes</td> -<td>40</td> -<td>33</td> -<td>30</td> -<td>0,025</td> -<td>0,03</td> -<td>0,033</td> -</tr> -<tr> -<td>b. comme ci-dessus, mais plus de pierres et d'herbiers</td> -<td>33</td> -<td>29</td> -<td>25</td> -<td>0,03</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td>c. propres, sinueux, quelques mouilles et hauts-fonds</td> -<td>30</td> -<td>25</td> -<td>22</td> -<td>0,033</td> -<td>0,04</td> -<td>0,045</td> -</tr> -<tr> -<td>d. comme ci-dessus, mais quelques herbiers et pierres</td> -<td>29</td> -<td>22</td> -<td>20</td> -<td>0,035</td> -<td>0,045</td> -<td>0,05</td> -</tr> -<tr> -<td>e. comme ci-dessus, hauteurs d'eau plus faibles, avec des pentes et tronçons plus inefficaces</td> -<td>25</td> -<td>21</td> -<td>18</td> -<td>0,04</td> -<td>0,048</td> -<td>0,055</td> -</tr> -<tr> -<td>f. identiques à d avec plus de pierres</td> -<td>22</td> -<td>20</td> -<td>17</td> -<td>0,045</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>g. tronçons mollassons, herbeux, mouilles profondes</td> -<td>20</td> -<td>14</td> -<td>13</td> -<td>0,05</td> -<td>0,07</td> -<td>0,08</td> -</tr> -<tr> -<td>h. tronçons très herbeux, mouilles profondes, ou lits moyens encombrés de bois et sous-bois</td> -<td>13</td> -<td>10</td> -<td>7</td> -<td>0,075</td> -<td>0,1</td> -<td>0,15</td> -</tr> -<tr> -<td colspan="7">2. Cours d'eau de montagne, pas de végétation dans le lit, berges généralement abruptes, arbres et broussailles le long des berges immergées en hautes eaux</td> -</tr> -<tr> -<td>a. fond : graviers, pavés, et quelques rochers</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>b. fond : pavés avec de gros rochers</td> -<td>25</td> -<td>20</td> -<td>14</td> -<td>0,04</td> -<td>0,05</td> -<td>0,07</td> -</tr> -<tr> -<td colspan="7">3. Lits majeurs</td> -</tr> -<tr> -<td>a. Prairie, sans broussailles</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. herbe rase</td> -<td>40</td> -<td>33</td> -<td>29</td> -<td>0,025</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td>2. herbe haute</td> -<td>33</td> -<td>29</td> -<td>20</td> -<td>0,03</td> -<td>0,035</td> -<td>0,05</td> -</tr> -<tr> -<td>b. Surfaces cultivées</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. aucune culture</td> -<td>50</td> -<td>33</td> -<td>25</td> -<td>0,02</td> -<td>0,03</td> -<td>0,04</td> -</tr> -<tr> -<td>2. cultures matures en rang</td> -<td>40</td> -<td>29</td> -<td>22</td> -<td>0,025</td> -<td>0,035</td> -<td>0,045</td> -</tr> -<tr> -<td>3. cultures matures en champ</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>c. Broussailles</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. broussailles dispersées, herbes denses</td> -<td>29</td> -<td>20</td> -<td>14</td> -<td>0,035</td> -<td>0,05</td> -<td>0,07</td> -</tr> -<tr> -<td>2. broussailles aérées et arbres, en hiver</td> -<td>29</td> -<td>20</td> -<td>17</td> -<td>0,035</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>3. broussailles aérées et arbres, en été</td> -<td>25</td> -<td>17</td> -<td>13</td> -<td>0,04</td> -<td>0,06</td> -<td>0,08</td> -</tr> -<tr> -<td>4. broussailles moyennes à denses, en hiver</td> -<td>22</td> -<td>14</td> -<td>9</td> -<td>0,045</td> -<td>0,07</td> -<td>0,11</td> -</tr> -<tr> -<td>5. broussailles moyennes à denses, en été</td> -<td>14</td> -<td>10</td> -<td>6</td> -<td>0,07</td> -<td>0,1</td> -<td>0,16</td> -</tr> -<tr> -<td>d. Arbres</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. saules denses, en été, alignés</td> -<td>9</td> -<td>7</td> -<td>5</td> -<td>0,11</td> -<td>0,15</td> -<td>0,2</td> -</tr> -<tr> -<td>2. terres défrichées avec des souches d'arbres, pas de pousses</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>3. comme ci-dessus, mais avec fort développement de pousses</td> -<td>20</td> -<td>17</td> -<td>13</td> -<td>0,05</td> -<td>0,06</td> -<td>0,08</td> -</tr> -<tr> -<td>4. dense présence de bois, quelques arbres couchés,un peu de sous-bois, hautes eaux sous les branches </td> -<td>20</td> -<td>21</td> -<td>22</td> -<td>0,08</td> -<td>0,1</td> -<td>0,12</td> -</tr> -<tr> -<td>5. comme le 4., les hautes eaux atteignant les branches</td> -<td>10</td> -<td>8</td> -<td>6</td> -<td>0,1</td> -<td>0,12</td> -<td>0,16</td> -</tr> -<tr> -<td colspan="7">4. Chenaux creusés ou dragués</td> -</tr> -<tr> -<td>a. En terre, droits, et uniformes</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. propres, récemment achevés</td> -<td>63</td> -<td>56</td> -<td>50</td> -<td>0,016</td> -<td>0,018</td> -<td>0,02</td> -</tr> -<tr> -<td>2. propres, après exposition aux intempéries</td> -<td>56</td> -<td>45</td> -<td>40</td> -<td>0,018</td> -<td>0,022</td> -<td>0,025</td> -</tr> -<tr> -<td>3. graviers, tronçon uniforme, propre</td> -<td>45</td> -<td>40</td> -<td>33</td> -<td>0,022</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>4. herbe rase, peu d'herbiers</td> -<td>45</td> -<td>37</td> -<td>30</td> -<td>0,022</td> -<td>0,027</td> -<td>0,033</td> -</tr> -<tr> -<td>b. En terre, sinueux, et ralentis</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. pas de végétation</td> -<td>43</td> -<td>40</td> -<td>33</td> -<td>0,023</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>2. herbe, quelques herbiers</td> -<td>40</td> -<td>33</td> -<td>30</td> -<td>0,025</td> -<td>0,03</td> -<td>0,033</td> -</tr> -<tr> -<td>3. herbiers denses ou plantes aquatiques dans les chenaux profonds</td> -<td>33</td> -<td>29</td> -<td>25</td> -<td>0,03</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td>4. fond en terre et bords en déblais</td> -<td>36</td> -<td>33</td> -<td>29</td> -<td>0,028</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td>5. fond pierreux et berges herbeuses</td> -<td>40</td> -<td>29</td> -<td>25</td> -<td>0,025</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td>6. fond en galets et bords propres</td> -<td>33</td> -<td>25</td> -<td>20</td> -<td>0,03</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>c. Excavé par dragline ou dragué</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. pas de végétation</td> -<td>40</td> -<td>36</td> -<td>30</td> -<td>0,025</td> -<td>0,028</td> -<td>0,033</td> -</tr> -<tr> -<td>2. broussailles aérées sur les berges</td> -<td>29</td> -<td>20</td> -<td>17</td> -<td>0,035</td> -<td>0,05</td> -<td>0,06</td> -</tr> -<tr> -<td>d. Tranchées dans la roche</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. lisses et uniformes</td> -<td>40</td> -<td>29</td> -<td>25</td> -<td>0,025</td> -<td>0,035</td> -<td>0,04</td> -</tr> -<tr> -<td>2. déchiquetées et irrégulières</td> -<td>29</td> -<td>25</td> -<td>20</td> -<td>0,035</td> -<td>0,04</td> -<td>0,05</td> -</tr> -<tr> -<td>e. Chenaux pas entretenus, herbiers et broussailles non coupées</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. herbiers denses, sur toute la hauteur d'écoulement</td> -<td>20</td> -<td>13</td> -<td>8</td> -<td>0,05</td> -<td>0,08</td> -<td>0,12</td> -</tr> -<tr> -<td>2. fond propre, broussailles sur les bords</td> -<td>25</td> -<td>20</td> -<td>13</td> -<td>0,04</td> -<td>0,05</td> -<td>0,08</td> -</tr> -<tr> -<td>3. comme ci-dessus, plus hautes eaux</td> -<td>22</td> -<td>14</td> -<td>9</td> -<td>0,045</td> -<td>0,07</td> -<td>0,11</td> -</tr> -<tr> -<td>4. broussailles denses, hautes eaux</td> -<td>13</td> -<td>10</td> -<td>7</td> -<td>0,08</td> -<td>0,1</td> -<td>0,14</td> -</tr> -<tr> -<td colspan="7">5. Chenaux rectifiés ou construits</td> -</tr> -<tr> -<td>a. Ciment</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. surface nette</td> -<td>100</td> -<td>91</td> -<td>77</td> -<td>0,01</td> -<td>0,011</td> -<td>0,013</td> -</tr> -<tr> -<td>2. mortier</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>b. Bois</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. raboté, non traité</td> -<td>100</td> -<td>83</td> -<td>71</td> -<td>0,01</td> -<td>0,012</td> -<td>0,014</td> -</tr> -<tr> -<td>2. raboté, créosoté</td> -<td>91</td> -<td>83</td> -<td>67</td> -<td>0,011</td> -<td>0,012</td> -<td>0,015</td> -</tr> -<tr> -<td>3. non raboté</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>4. planche avec tasseaux</td> -<td>83</td> -<td>67</td> -<td>56</td> -<td>0,012</td> -<td>0,015</td> -<td>0,018</td> -</tr> -<tr> -<td>5. recouvert de textile imperméabilisant</td> -<td>100</td> -<td>71</td> -<td>59</td> -<td>0,01</td> -<td>0,014</td> -<td>0,017</td> -</tr> -<tr> -<td>c. Béton</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. finition à la truelle</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>2. finition à l'aplanissoir</td> -<td>77</td> -<td>67</td> -<td>63</td> -<td>0,013</td> -<td>0,015</td> -<td>0,016</td> -</tr> -<tr> -<td>3. avec finition, avec du gravier sur le fond</td> -<td>67</td> -<td>59</td> -<td>50</td> -<td>0,015</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>4. sans finition</td> -<td>71</td> -<td>59</td> -<td>50</td> -<td>0,014</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>5. gunite, bonne section</td> -<td>63</td> -<td>53</td> -<td>43</td> -<td>0,016</td> -<td>0,019</td> -<td>0,023</td> -</tr> -<tr> -<td>6. gunite, section ondulée</td> -<td>56</td> -<td>45</td> -<td>40</td> -<td>0,018</td> -<td>0,022</td> -<td>0,025</td> -</tr> -<tr> -<td>7. sur de la bonne roche excavée</td> -<td>59</td> -<td>50</td> -<td></td> -<td>0,017</td> -<td>0,02</td> -<td></td> -</tr> -<tr> -<td>8. sur de la roche excavée irrégulière</td> -<td>45</td> -<td>37</td> -<td></td> -<td>0,022</td> -<td>0,027</td> -<td></td> -</tr> -<tr> -<td>d. Fond en béton, finition à l'aplanissoir, avec bords en :</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. pierre de taille liée au mortier</td> -<td>67</td> -<td>59</td> -<td>50</td> -<td>0,015</td> -<td>0,017</td> -<td>0,02</td> -</tr> -<tr> -<td>2. pierre brute liée au mortier</td> -<td>59</td> -<td>50</td> -<td>42</td> -<td>0,017</td> -<td>0,02</td> -<td>0,024</td> -</tr> -<tr> -<td>3. maçonnerie de ciment moellons, enduit</td> -<td>63</td> -<td>50</td> -<td>42</td> -<td>0,016</td> -<td>0,02</td> -<td>0,024</td> -</tr> -<tr> -<td>4. maçonnerie de ciment moellons</td> -<td>50</td> -<td>40</td> -<td>33</td> -<td>0,02</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>5. moellons non liés ou enrochements</td> -<td>50</td> -<td>33</td> -<td>29</td> -<td>0,02</td> -<td>0,03</td> -<td>0,035</td> -</tr> -<tr> -<td>e. Fond en graviers, avec bords en :</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. béton coffré</td> -<td>59</td> -<td>50</td> -<td>40</td> -<td>0,017</td> -<td>0,02</td> -<td>0,025</td> -</tr> -<tr> -<td>2. mortier de pierre brute</td> -<td>50</td> -<td>43</td> -<td>38</td> -<td>0,02</td> -<td>0,023</td> -<td>0,026</td> -</tr> -<tr> -<td>3. déblais non liés ou enrochements</td> -<td>43</td> -<td>30</td> -<td>28</td> -<td>0,023</td> -<td>0,033</td> -<td>0,036</td> -</tr> -<tr> -<td>f. Brique</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. brique vernissée</td> -<td>91</td> -<td>77</td> -<td>67</td> -<td>0,011</td> -<td>0,013</td> -<td>0,015</td> -</tr> -<tr> -<td>2. liée au mortier de ciment</td> -<td>83</td> -<td>67</td> -<td>56</td> -<td>0,012</td> -<td>0,015</td> -<td>0,018</td> -</tr> -<tr> -<td>g. Maçonnerie</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. moellons cimentés</td> -<td>59</td> -<td>40</td> -<td>33</td> -<td>0,017</td> -<td>0,025</td> -<td>0,03</td> -</tr> -<tr> -<td>2. moellons non liés</td> -<td>43</td> -<td>31</td> -<td>29</td> -<td>0,023</td> -<td>0,032</td> -<td>0,035</td> -</tr> -<tr> -<td>h. Pierre de taille / dallage en pierre</td> -<td>77</td> -<td>67</td> -<td>59</td> -<td>0,013</td> -<td>0,015</td> -<td>0,017</td> -</tr> -<tr> -<td>i. Asphalte</td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -<td></td> -</tr> -<tr> -<td>1. lisse</td> -<td>77</td> -<td>77</td> -<td></td> -<td>0,013</td> -<td>0,013</td> -<td></td> -</tr> -<tr> -<td>2. rugueux</td> -<td>63</td> -<td>63</td> -<td></td> -<td>0,016</td> -<td>0,016</td> -<td></td> -</tr> -<tr> -<td>j. Revêtement végétal</td> -<td>33</td> -<td></td> -<td>2</td> -<td>0,03</td> -<td></td> -<td>0,5</td> -</tr> -</tbody> -</table> \ No newline at end of file +| Type de chenal et description | \(K_S\) min. | \(K_S\) normal | \(K_S\) max. | +|------------------------------------------|----------:|----------:|----------:| +| **1\. Lits mineurs** | | | | +| a\. propres, rectilignes, bien remplis d'eau, sans failles ni mouilles profondes | 30 | 33 | 40 | +| b\. comme ci\-dessus, mais plus de pierres et d'herbiers | 25 | 29 | 33 | +| c\. propres, sinueux, quelques mouilles et hauts\-fonds | 22 | 25 | 30 | +| d\. comme ci\-dessus, mais quelques herbiers et pierres | 20 | 22 | 29 | +| e\. comme ci\-dessus, hauteurs d'eau plus faibles, avec des pentes et tronçons plus inefficaces | 18 | 21 | 25 | +| f\. identiques à d avec plus de pierres | 17 | 20 | 22 | +| g\. tronçons mollassons, herbeux, mouilles profondes | 13 | 14 | 20 | +| h\. tronçons très herbeux, mouilles profondes, ou lits moyens encombrés de bois et sous\-bois | 7 | 10 | 13 | +| **2\. Cours d'eau de montagne, pas de végétation dans le lit, berges généralement abruptes, arbres et broussailles le long des berges immergées en hautes eaux** | +| a\. fond : graviers, pavés, et quelques rochers | 20 | 25 | 33 | +| b\. fond : pavés avec de gros rochers | 14 | 20 | 25 | +| **3\. Lits majeurs** | +| *a\. Prairie, sans broussailles* | | | | +| 1\. herbe rase | 29 | 33 | 40 | +| 2\. herbe haute | 20 | 29 | 33 | +| *b\. Surfaces cultivées* | | | | +| 1\. aucune culture | 25 | 33 | 50 | +| 2\. cultures matures en rang | 22 | 29 | 40 | +| 3\. cultures matures en champ | 20 | 25 | 33 | +| *c\. Broussailles* | | | | +| 1\. broussailles dispersées, herbes denses | 14 | 20 | 29 | +| 2\. broussailles aérées et arbres, en hiver | 17 | 20 | 29 | +| 3\. broussailles aérées et arbres, en été | 13 | 17 | 25 | +| 4\. broussailles moyennes à denses, en hiver | 9 | 14 | 22 | +| 5\. broussailles moyennes à denses, en été | 6 | 10 | 14 | +| *d\. Arbres* | | | | +| 1\. saules denses, en été, alignés | 5 | 7 | 9 | +| 2\. terres défrichées avec des souches d'arbres, pas de pousses | 20 | 25 | 33 | +| 3\. comme ci\-dessus, mais avec fort développement de pousses | 13 | 17 | 20 | +| 4\. dense présence de bois, quelques arbres couchés,un peu de sous\-bois, hautes eaux sous les branches | 22 | 21 | 20 | +| 5\. comme le 4\., les hautes eaux atteignant les branches | 6 | 8 | 10 | +| **4\. Chenaux creusés ou dragués** | +| *a\. En terre, droits, et uniformes* | | | | +| 1\. propres, récemment achevés | 50 | 56 | 63 | +| 2\. propres, après exposition aux intempéries | 40 | 45 | 56 | +| 3\. graviers, tronçon uniforme, propre | 33 | 40 | 45 | +| 4\. herbe rase, peu d'herbiers | 30 | 37 | 45 | +| *b\. En terre, sinueux, et ralentis* | | | | +| 1\. pas de végétation | 33 | 40 | 43 | +| 2\. herbe, quelques herbiers | 30 | 33 | 40 | +| 3\. herbiers denses ou plantes aquatiques dans les chenaux profonds | 25 | 29 | 33 | +| 4\. fond en terre et bords en déblais | 29 | 33 | 36 | +| 5\. fond pierreux et berges herbeuses | 25 | 29 | 40 | +| 6\. fond en galets et bords propres | 20 | 25 | 33 | +| *c\. Excavé par dragline ou dragué* | | | | +| 1\. pas de végétation | 30 | 36 | 40 | +| 2\. broussailles aérées sur les berges | 17 | 20 | 29 | +| *d\. Tranchées dans la roche* | | | | +| 1\. lisses et uniformes | 25 | 29 | 40 | +| 2\. déchiquetées et irrégulières | 20 | 25 | 29 | +| *e\. Chenaux pas entretenus, herbiers et broussailles non coupées* | | | | +| 1\. herbiers denses, sur toute la hauteur d'écoulement | 8 | 13 | 20 | +| 2\. fond propre, broussailles sur les bords | 13 | 20 | 25 | +| 3\. comme ci\-dessus, plus hautes eaux | 9 | 14 | 22 | +| 4\. broussailles denses, hautes eaux | 7 | 10 | 13 | +| **5\. Chenaux rectifiés ou construits** | +| *a\. Ciment* | | | | +| 1\. surface nette | 77 | 91 | 100 | +| 2\. mortier | 67 | 77 | 91 | +| *b\. Bois* | | | | +| 1\. raboté, non traité | 71 | 83 | 100 | +| 2\. raboté, créosoté | 67 | 83 | 91 | +| 3\. non raboté | 67 | 77 | 91 | +| 4\. planche avec tasseaux | 56 | 67 | 83 | +| 5\. recouvert de textile imperméabilisant | 59 | 71 | 100 | +| *c\. Béton* | | | | +| 1\. finition à la truelle | 67 | 77 | 91 | +| 2\. finition à l'aplanissoir | 63 | 67 | 77 | +| 3\. avec finition, avec du gravier sur le fond | 50 | 59 | 67 | +| 4\. sans finition | 50 | 59 | 71 | +| 5\. gunite, bonne section | 43 | 53 | 63 | +| 6\. gunite, section ondulée | 40 | 45 | 56 | +| 7\. sur de la bonne roche excavée | | 50 | 59 | +| 8\. sur de la roche excavée irrégulière | | 37 | 45 | +| *d\. Fond en béton, finition à l'aplanissoir, avec bords en :* | | | | +| 1\. pierre de taille liée au mortier | 50 | 59 | 67 | +| 2\. pierre brute liée au mortier | 42 | 50 | 59 | +| 3\. maçonnerie de ciment moellons, enduit | 42 | 50 | 63 | +| 4\. maçonnerie de ciment moellons | 33 | 40 | 50 | +| 5\. moellons non liés ou enrochements | 29 | 33 | 50 | +| *e\. Fond en graviers, avec bords en :* | | | | +| 1\. béton coffré | 40 | 50 | 59 | +| 2\. mortier de pierre brute | 38 | 43 | 50 | +| 3\. déblais non liés ou enrochements | 28 | 30 | 43 | +| *f\. Brique* | | | | +| 1\. brique vernissée | 67 | 77 | 91 | +| 2\. liée au mortier de ciment | 56 | 67 | 83 | +| *g\. Maçonnerie* | | | | +| 1\. moellons cimentés | 33 | 40 | 59 | +| 2\. moellons non liés | 29 | 31 | 43 | +| *h\. Pierre de taille / dallage en pierre* | 59 | 67 | 77 | +| *i\. Asphalte* | | | | +| 1\. lisse | | 77 | 77 | +| 2\. rugueux | | 63 | 63 | +| *j\. Revêtement végétal* | 2 | | 33 | + +Table: Tableau de Chow (1959) diff --git a/docs/fr/calculators/hyd_en_charge/cond_distri.md b/docs/fr/calculators/hyd_en_charge/cond_distri.md index fda6e002f0f378d58bd362f3e7540f0e0266bbd8..47336d57aea370f64d7b71e5daa71fc5c72225f0 100644 --- a/docs/fr/calculators/hyd_en_charge/cond_distri.md +++ b/docs/fr/calculators/hyd_en_charge/cond_distri.md @@ -2,7 +2,7 @@ Relation analytique pour le calcul direct des pertes de charge en conduite distribuant un débit de façon homogène établi à partir de la formule de Blasius. -## Hypothèses +## Hypothèses  @@ -10,7 +10,7 @@ On suppose une conduite de longueur \(L\), diamètre intérieur \(D\), avec un d $$\lambda \simeq a Re^{-0.25}$$ -## Développement analytique +## Développement analytique On note \(x\) la position depuis l'aval de la conduite. Le débit est supposé varier linéairement avec \(x\), et s'écrit alors: @@ -46,7 +46,7 @@ $$\Delta H=a \nu ^{0.25} \frac{(4/\pi)^{1.75}Q^{1.75}}{2g D^{4.75}}\frac{L}{2.75 $$\Delta H=a \nu ^{0.25} \frac{4^{1.75}}{5.5g \pi^{1.75}}\frac{Q^{1.75}L}{D^{4.75}}$$ -## Application numérique +## Application numérique Pour une eau à 20°C: \(\nu\simeq 10^{-6}\) m<sup>2</sup>/s, ce qui donne diff --git a/docs/fr/calculators/hyd_en_charge/lechapt-calmon.md b/docs/fr/calculators/hyd_en_charge/lechapt-calmon.md index e08f37eed8f0390b0983e28655399fa8bb079b56..9e7fcc66835aa6d833b3ca8df16a6199a237e004 100644 --- a/docs/fr/calculators/hyd_en_charge/lechapt-calmon.md +++ b/docs/fr/calculators/hyd_en_charge/lechapt-calmon.md @@ -18,8 +18,8 @@ L'erreur commise par rapport à la formule de Colebrook est inférieure à 3&nbs Le tableau de correspondance des coefficients est le suivant : -| Matériau | ϵ (mm) | \(L\) | \(M\) | \(N\) | -|----------|-------------:|----:|----:|-----:| +| Matériau | ϵ (mm) | \(L\) | \(M\) | \(N\) | +|------------------------------------------------|-------------:|----:|----:|-----:| | Fonte ou acier non revêtus - Béton grossier (eau corrosive) | 2 | 1.863 | 2 | 5.33 | | Fonte ou acier non revêtus - Béton grossier (eau peu corrosive) | 1 | 1.601 | 1.975 | 5.25 | | Fonte ou acier revêtement ciment | 0.5 | 1.40 | 1.96 | 5.19 | diff --git a/docs/fr/calculators/structures/fente_noyee.md b/docs/fr/calculators/structures/fente_noyee.md index 2f2a202d287e07961303c794e8d0b7ef471221bb..efd3dcf9819d330ebb6dcbc3a2b293bf81b4a1e3 100644 --- a/docs/fr/calculators/structures/fente_noyee.md +++ b/docs/fr/calculators/structures/fente_noyee.md @@ -14,4 +14,4 @@ Avec : * *H<sub>1</sub>* la charge sur la fente m * *μ* le coefficient de débit (égal à 0.65 par défaut). -Le coefficient de débit *μ* peut varier de 0.65 pour une fente à arêtes vives à plus de 0.85 lorsque le profil de la fente est arrondi. \ No newline at end of file +Le coefficient de débit *μ* peut varier de 0.65 pour une fente à arêtes vives à plus de 0.85 lorsque le profil de la fente est arrondi. diff --git a/docs/fr/calculators/structures/kivi.md b/docs/fr/calculators/structures/kivi.md index 2d00fc7e150094d45555c25d379b83997f5987c2..a50e3c33b0632ad68b8425757cf2181b3b527138 100644 --- a/docs/fr/calculators/structures/kivi.md +++ b/docs/fr/calculators/structures/kivi.md @@ -3,7 +3,7 @@ Le module de calcul permet d'effectuer des calculs hydrauliques pour plusieurs ouvrages en parallèle. -## Formule de Kindsvater-Carter (1957) +## Formule de Kindsvater-Carter (1957)  diff --git a/docs/fr/calculators/structures/liste.md b/docs/fr/calculators/structures/liste.md index 4dfb3ccb681b9f177a1e48fa66431091faedb9fe..878a45b6f4e0b1c7c21850e10f58164cb864a403 100644 --- a/docs/fr/calculators/structures/liste.md +++ b/docs/fr/calculators/structures/liste.md @@ -1,7 +1,7 @@ # Liste des équations d'ouvrages | Équation | Coefficient de débit par défaut | Disponible dans | -|---|---|---| +|---------------------------|----------------:|-------------------------------| | [Dévesoir / orifice Cemagref 88](./cem_88_d.md) | 0.4 | Lois d'ouvrages | | [Dévesoir / vanne de fond Cemagref 88](./cem_88_v.md) | 0.6 | Lois d'ouvrages | | [Cunge 80](./cunge_80.md) | 0.6 | Lois d'ouvrages | @@ -10,11 +10,13 @@ | [Seuil dénoyé](./seuil_denoye.md) | 0.4 | Lois d'ouvrages, Lois de déversoirs dénoyés | | [Seuil noyé](./seuil_noye.md) | 0.9 | Lois d'ouvrages | | [Fente noyée (Larinier 1992)](./fente_noyee.md) | 0.75 | Lois d'ouvrages, Cloisons, Cloison aval | -| [Kindsvater-Carter et Villemonte](./kivi.md) | α=0.4, β=0.001 | Lois d'ouvrages | +| [Kindsvater-Carter et Villemonte](./kivi.md) | \(\alpha\)=0.4, \(\beta\)=0.001 | Lois d'ouvrages | | [Déversoir triangulaire (Villemonte)](./dever_triang.md) | 1.36 | Lois d'ouvrages, Lois de déversoirs dénoyés, Cloisons, Cloison aval | | [Déversoir triangulaire tronqué (Villemonte)](./dever_triang_tronque.md) | 1.36 | Lois d'ouvrages, Lois de déversoirs dénoyés, Cloisons, Cloison aval | | [Orifice noyé](./orifice_noye.md) | 0.7 | Lois d'ouvrages, Cloisons, Cloison aval | | [Orifice dénoyé](./orifice_denoye.md) | 0.7 | Lois d'ouvrages | | [Villemonte 1947](./villemonte_1947.md) | 0.4 | Lois d'ouvrages, Cloisons, Cloison aval | | [Échancrure régulée (Villemonte 1957)](../pab/pab.md#la-cloison-aval) | 0.4 | Cloison aval | -| [Fente noyée régulée (Larinier 1992)](../pab/pab.md#la-cloison-aval) | 0.75 | Cloison aval | \ No newline at end of file +| [Fente noyée régulée (Larinier 1992)](../pab/pab.md#la-cloison-aval) | 0.75 | Cloison aval | + +Table: Liste des équations d'ouvrages diff --git a/docs/fr/calculators/structures/seuil_denoye.md b/docs/fr/calculators/structures/seuil_denoye.md index f129fb7adbc2cdc45d946a4c7fdb697cbacfe9e2..9923c71419c8764e182b0b7b1937a94985553a82 100644 --- a/docs/fr/calculators/structures/seuil_denoye.md +++ b/docs/fr/calculators/structures/seuil_denoye.md @@ -1,3 +1,4 @@ + # Formule du déversoir dénoyé La formule est dérivée de la formule originale de Poleni (1717). diff --git a/docs/fr/calculators/structures/seuil_noye.md b/docs/fr/calculators/structures/seuil_noye.md index 784e10abb9bc52ee53766affcdc1f9426ff6c468..6e572057e9545f679ca10883cc83fe49025016b5 100644 --- a/docs/fr/calculators/structures/seuil_noye.md +++ b/docs/fr/calculators/structures/seuil_noye.md @@ -2,9 +2,7 @@  -*Extrait de: Rajaratnam, N., Muralidhar, D., 1969. Flow below deeply submerged rectangular weirs. Journal of Hydraulic Research 7, 355–374.* - -En régime noyé, le débit dépend de la hauteur d'eau amont \(h_{amont}\) et de la hauteur aval \(h_{aval}\) : +En régime noyé, le débit dépend de la hauteur d'eau amont \(h_{amont}\) et de la hauteur aval \(h_{aval}\) (Rajaratnam et al., 1969) : $$Q = Cd \sqrt{2g} Lh_{aval} \sqrt{h_{amont}-h_{aval}}$$ @@ -15,4 +13,6 @@ Avec : * *h<sub>aval</sub>* la charge sur le seuil à l'aval en m * *C<sub>d</sub>* le coefficient de débit (égal à 0.9 par défaut). -Cette formule n'est pas conseillée pour un ennoiement inférieur à 80%. \ No newline at end of file +Cette formule n'est pas conseillée pour un ennoiement inférieur à 80%. + +*Rajaratnam, N., Muralidhar, D., 1969. Flow below deeply submerged rectangular weirs. Journal of Hydraulic Research 7, 355–374.* diff --git a/docs/fr/calculators/structures/vanne_denoyee_schema.png b/docs/fr/calculators/structures/vanne_denoyee_schema.png index 1868e850d243f507d159827d895587b7c9c554df..37b61e24b1589831f622e7d4406f79db7f521986 100644 Binary files a/docs/fr/calculators/structures/vanne_denoyee_schema.png and b/docs/fr/calculators/structures/vanne_denoyee_schema.png differ diff --git a/docs/fr/calculators/structures/vanne_noyee_schema.png b/docs/fr/calculators/structures/vanne_noyee_schema.png index 29427f1e7b74d104f0063fdfd787c3ef90fc4d21..506cab28f5ed684b9e8e76c79c8f9363864e06d5 100644 Binary files a/docs/fr/calculators/structures/vanne_noyee_schema.png and b/docs/fr/calculators/structures/vanne_noyee_schema.png differ diff --git a/docs/fr/general/principe_fonctionnement_grandeurs.png b/docs/fr/general/principe_fonctionnement_grandeurs.png index 2c31247c318f1dd031a5e8876cdecd78cdcb6b38..d68c53552c21a0f5ae1f837a8b7e572e0646fbb2 100644 Binary files a/docs/fr/general/principe_fonctionnement_grandeurs.png and b/docs/fr/general/principe_fonctionnement_grandeurs.png differ diff --git a/docs/fr/general/principe_fonctionnement_resultat_fix.png b/docs/fr/general/principe_fonctionnement_resultat_fix.png index b46e4068b11cec103675745be1caf305713a29ad..677e647887cc61ce7a09b87c4c86ef9c36f55bd5 100644 Binary files a/docs/fr/general/principe_fonctionnement_resultat_fix.png and b/docs/fr/general/principe_fonctionnement_resultat_fix.png differ diff --git a/docs/fr/general/principe_fonctionnement_resultat_var.png b/docs/fr/general/principe_fonctionnement_resultat_var.png index 3f7e62ec17ec320b75438536f596b6c1975b325e..cb98864ce02a9d86a734f2d081ead453e40dd140 100644 Binary files a/docs/fr/general/principe_fonctionnement_resultat_var.png and b/docs/fr/general/principe_fonctionnement_resultat_var.png differ diff --git a/docs/fr/general/principe_fonctionnement_varie_liste.png b/docs/fr/general/principe_fonctionnement_varie_liste.png index 7dde883a31561ab88a7a96b24511bf8901f6d804..30d9bb1f289389c589eeb1b0dcfec409417e2fc3 100644 Binary files a/docs/fr/general/principe_fonctionnement_varie_liste.png and b/docs/fr/general/principe_fonctionnement_varie_liste.png differ diff --git a/docs/fr/general/principe_fonctionnement_varie_pas.png b/docs/fr/general/principe_fonctionnement_varie_pas.png index 39040f28a6f32fbd349a1c5b8edd1434e7d695f3..ca6341bd7ddf2b08eae2fcb2e0cd1aecb376109b 100644 Binary files a/docs/fr/general/principe_fonctionnement_varie_pas.png and b/docs/fr/general/principe_fonctionnement_varie_pas.png differ diff --git a/docs/fr/index.md b/docs/fr/index.md index 514879164bc87233e1311ef6db6520a7e737005a..75db703e4cb958e8759a89ca0ca7ea030d2e1d7e 100644 --- a/docs/fr/index.md +++ b/docs/fr/index.md @@ -14,3 +14,7 @@ Cassiopée est un logiciel consacré à l'hydraulique des rivières avec notamme ## Pré-requis - installation Cassiopée ne nécessite aucune installation. Il est disponible en ligne à partir d'un navigateur récent (testé sous Firefox, Chrome et Chromium) en se rendant à l'adresse suivante : [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr) + +## Documentation + +Télécharger [la documentation au format PDF](https://cassiopee.g-eau.fr/assets/docs/pdf/cassiopee_doc_fr.pdf) diff --git a/docs/fr/mentions_legales.md b/docs/fr/mentions_legales.md index 86d88fd02252b3b74bcf884142a0e6128e3efdeb..d73b7d36cda3005f3b23b3db1950d5ebcc60c81d 100644 --- a/docs/fr/mentions_legales.md +++ b/docs/fr/mentions_legales.md @@ -87,7 +87,7 @@ Les contenus produits par Cassiopée (Résultats de calculs, tableaux, graphique La documentation de Cassiopée est publiée sous [Licence CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode.fr) qui autorise à copier, distribuer, communiquer tout ou partie de la documentation par tous moyens et tous formats à condition de la créditer, d'intégrer un lien vers la licence, de ne pas en faire un usage commercial, et de ne pas l'avoir modifiée. -## Logiciels libres +## Logiciels libres ### Licence du module de calcul de Cassiopée diff --git a/docs/fr/methodes_numeriques/rk4.md b/docs/fr/methodes_numeriques/rk4.md index 202c488ce7ccb0d542075d1891622de4227b71f3..3280312da4f08ab07963dacbbb0e579fbd524c90 100644 --- a/docs/fr/methodes_numeriques/rk4.md +++ b/docs/fr/methodes_numeriques/rk4.md @@ -36,7 +36,8 @@ N=(tmax-t0)/dt; ii=1:N+1; t=(ii-1)*dt; // vecteur temps -t2=0:tmax; // vecteur temps avec un pas plus fin, pour la solution exacte +// vecteur temps avec un pas plus fin, pour la solution exacte +t2=0:tmax; // Solution par méthode d'Euler, notée ye ye(1)=y0; // condition à la limite diff --git a/docs/latex/cassiopee_doc_en.tex b/docs/latex/cassiopee_doc_en.tex new file mode 100644 index 0000000000000000000000000000000000000000..043c819d085df1f82daa5e6ea43efa3fc9a03f3b --- /dev/null +++ b/docs/latex/cassiopee_doc_en.tex @@ -0,0 +1,122 @@ +%******************************************************************************* +% @file cassiopee_doc_en.tex +% Modèle de documentation en anglais de Cassiopée, basé sur le modèle de rapport pour INRAE. +% À utiliser avec le modèle https://gitlab.irstea.fr/david.dorchies/latex_models +% @author David Dorchies, Mathias Chouet (INRAE Montpellier) +% @date Jan 2020 +%******************************************************************************* +\documentclass[12pt,a4paper,titlepage,twoside]{report} + +\usepackage[export]{adjustbox} +\usepackage{longtable} + +% Insertion des différents préambules au document +\input{rapport/english/preambule_rapport_english} +\input{rapport_inrae/preambule_inrae} + + +%******************************************************************************* +%Données de titre et d'auteur pour la page de garde, les entêtes et pieds de page +%******************************************************************************* +% Le titre doit être relativement court mais assez explicite +\newcommand{\service}{UMR G-EAU} +\newcommand{\titre}{Cassiopée 4 software} +\newcommand{\sousTitre}{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} +% date de validation du document (qui entraine sa diffusion)] +\newcommand{\dateValidation}{\today} +% Site INRAE +\newcommand{\site}{ + UMR G-EAU + + INRAE Montpellier +} +% Adresse du site +\newcommand{\adresse}{361 rue J-F Breton - BP 5095\\34196 Montpellier cedex 5} +% Téléphone et télécopie +\newcommand{\telephone}{tél. : +33(0)4670400} +% Sites internet +\newcommand{\website}{\url{www.g-eau.fr}\\\url{www.inrae.fr}} + + +% ******************* FOR PANDOC V2+ ************************* + +\usepackage{fancyvrb} +\newcommand{\VerbBar}{|} +\newcommand{\VERB}{\Verb[commandchars=\\\{\}]} +\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}} +% Add ',fontsize=\small' for more characters per line +\newenvironment{Shaded}{}{} +\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}} +\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}} +\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\BuiltInTok}[1]{#1} +\newcommand{\CharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textit{#1}}} +\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}} +\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}} +\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}} +\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}} +\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}} +\newcommand{\ExtensionTok}[1]{#1} +\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}} +\newcommand{\ImportTok}[1]{#1} +\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}} +\newcommand{\NormalTok}[1]{#1} +\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} +\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}} +\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.74,0.48,0.00}{#1}} +\newcommand{\RegionMarkerTok}[1]{#1} +\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}} +\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}} +\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} + + +%******************************************************************************* + +\begin{document} +%Supprime les veuves et orphelines +\widowpenalty=10000 +\clubpenalty=10000 +\raggedbottom + +% Integre la page de garde +%\input{title.tex} +\input{rapport_inrae/cover_inrae} +\input{rapport/headfoot_content} + +\cleardoublepage + +% Table des matières +\cleardoublepage +\tableofcontents + + +%******************************************************************************* +% 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 new file mode 100644 index 0000000000000000000000000000000000000000..095e37c436eeecd44f0baecd1385eaf04f3f4312 --- /dev/null +++ b/docs/latex/cassiopee_doc_fr.tex @@ -0,0 +1,122 @@ +%******************************************************************************* +% @file cassiopee_doc_fr.tex +% Modèle de documentation en français de Cassiopée, basé sur le modèle de rapport pour INRAE. +% À utiliser avec le modèle https://gitlab.irstea.fr/david.dorchies/latex_models +% @author David Dorchies, Mathias Chouet (INRAE Montpellier) +% @date Jan 2020 +%******************************************************************************* +\documentclass[12pt,a4paper,titlepage,twoside]{report} + +\usepackage[export]{adjustbox} +\usepackage{longtable} + +% Insertion des différents préambules au document +\input{rapport/francais/preambule_rapport_francais} +\input{rapport_inrae/preambule_inrae} + + +%******************************************************************************* +%Données de titre et d'auteur pour la page de garde, les entêtes et pieds de page +%******************************************************************************* +% Le titre doit être relativement court mais assez explicite +\newcommand{\service}{UMR G-EAU} +\newcommand{\titre}{Logiciel Cassiopée 4} +\newcommand{\sousTitre}{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} +% date de validation du document (qui entraine sa diffusion)] +\newcommand{\dateValidation}{\today} +% Site INRAE +\newcommand{\site}{ + UMR G-EAU + + INRAE Montpellier +} +% Adresse du site +\newcommand{\adresse}{361 rue J-F Breton - BP 5095\\34196 Montpellier cedex 5} +% Téléphone et télécopie +\newcommand{\telephone}{tél. : +33(0)4670400} +% Sites internet +\newcommand{\website}{\url{www.g-eau.fr}\\\url{www.inrae.fr}} + + +% ******************* FOR PANDOC V2+ ************************* + +\usepackage{fancyvrb} +\newcommand{\VerbBar}{|} +\newcommand{\VERB}{\Verb[commandchars=\\\{\}]} +\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}} +% Add ',fontsize=\small' for more characters per line +\newenvironment{Shaded}{}{} +\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}} +\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}} +\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\BuiltInTok}[1]{#1} +\newcommand{\CharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textit{#1}}} +\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}} +\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}} +\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}} +\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}} +\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}} +\newcommand{\ExtensionTok}[1]{#1} +\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}} +\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}} +\newcommand{\ImportTok}[1]{#1} +\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} +\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}} +\newcommand{\NormalTok}[1]{#1} +\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}} +\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}} +\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.74,0.48,0.00}{#1}} +\newcommand{\RegionMarkerTok}[1]{#1} +\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}} +\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}} +\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}} +\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}} + + +%******************************************************************************* + +\begin{document} +%Supprime les veuves et orphelines +\widowpenalty=10000 +\clubpenalty=10000 +\raggedbottom + +% Integre la page de garde +%\input{title.tex} +\input{rapport_inrae/cover_inrae} +\input{rapport/headfoot_content} + +\cleardoublepage + +% Table des matières +\cleardoublepage +\tableofcontents + + +%******************************************************************************* +% 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/docs/latex/logo_pole.png b/docs/latex/logo_pole.png new file mode 100644 index 0000000000000000000000000000000000000000..8c1038067c2e83d700a7161574829742dd2e321b Binary files /dev/null and b/docs/latex/logo_pole.png differ diff --git a/docs/latex/logos.tex b/docs/latex/logos.tex new file mode 100644 index 0000000000000000000000000000000000000000..7e5bc30689dce23851298f8e64acc97899ccdab5 --- /dev/null +++ b/docs/latex/logos.tex @@ -0,0 +1,14 @@ +% Example of logos layout for page "cover_inrae.tex" + +\hfill +\includegraphics[width=8cm]{logo_pole.png} + +\vspace{3mm} + +\hfill +\includegraphics[width=4cm]{rapport_inrae/logo_inrae_couv_haut.png} + +\vspace{3mm} + +\hfill +\includegraphics[width=4cm]{rapport_inrae/logo_geau.png} diff --git a/mkdocs2pdf.py b/mkdocs2pdf.py index d25414e10148f7bbb8fcd24db79309d3469c8677..67f0e73683db49cc57a144b5207640c58b859f79 100644 --- a/mkdocs2pdf.py +++ b/mkdocs2pdf.py @@ -14,17 +14,32 @@ # - python3 ./mkdocs2pdf.py # -outputDir = 'docs/fr/pdf' -filename = 'cassiopee_docs-fr' +import os +import sys +import yaml +import re +import shutil +baseDir = os.getcwd(); + +buildDir = os.path.join(baseDir, 'docs/pdf_build') +outputDir = os.path.join(baseDir, 'src/assets/docs/pdf') + +latexModelDir = 'latex_models' +modelDir = os.path.join(buildDir, latexModelDir) + +mergedDocFilenamePrefix = 'cassiopee_doc_contents_' +filenamePrefix = 'cassiopee_doc_' + +latexModelRepository = 'https://gitlab.irstea.fr/david.dorchies/latex_models.git' + +# Reads an MkDocs configuration file def readConfig(sYAML): f = open(sYAML, 'r') with f: try: - import yaml dMkdocsYaml = yaml.load(f, Loader=yaml.SafeLoader) except yaml.YAMLError as e: - import sys sys.exit("ERROR on YAML loading {}: {}".format(sYAML, str(e))) return dMkdocsYaml @@ -32,8 +47,6 @@ def getMdHeader(title, level): return "#" * level + " " + title + "\n" def shiftMdHeaders(mdContent, level): - import re - if level == 0: return mdContent @@ -44,20 +57,21 @@ def shiftMdHeaders(mdContent, level): lMd[i] = ("#" * level) + item return "\n".join(lMd) -def explore(docs_dir, nav, output = '', level = 0): +# Browses MkDocs configuration file and merges .md files +def exploreAndMerge(docs_dir, nav, output = '', level = 0): """ @param docs_dir path to the mkdocs content files - @param dictionnary with the structure to explore + @param nav dictionnary with the structure to explore @param output markdown files content already merged """ - import os, re if type(nav) is str: nav = [nav] for d in nav: if type(d) is str: filepath = os.path.join(docs_dir, d) f = open(filepath, 'r') - path = os.path.join('..', os.path.dirname(filepath)) + # Triple "../" because file will be compiled from pdf_build/latex_models + path = os.path.join('../../..', os.path.dirname(filepath)) s = f.read() + "\n" # Modification of image and links paths s = re.sub(r'(\!\[.+\]\()(.+)(\))', r'\1'+path+r'/\2\3', s) @@ -70,31 +84,22 @@ def explore(docs_dir, nav, output = '', level = 0): for key, value in d.items(): if type(value) is list: output += "\n" + getMdHeader(key, level) + "\n" - output = explore(docs_dir, value, output, level) + output = exploreAndMerge(docs_dir, value, output, level) + else: + output = exploreAndMerge(docs_dir, value, output, level-1) # do not dig level when sub-chapter has only one entry (alias) level -= 1 return output - -if __name__ == '__main__': - - # Read config - dMkdocsYaml = readConfig('mkdocs.yml') - # Create string with merged MarkDown - s = explore(dMkdocsYaml['docs_dir'], dMkdocsYaml['nav']) - # Save the md file - import os - os.makedirs(outputDir, exist_ok=True) - OutputPath = os.path.join(outputDir, filename) - with open('{}.md'.format(OutputPath), 'w') as f: - f.writelines(s) - # Convert to tex format +# Creates a filePath.tex LaTeX contents file based on filePath.md +def convertMdToTex(filePath): + # Convert .md to .tex os.system( - 'pandoc {0}.md -f markdown -t latex -s -o {0}.tex'.format(OutputPath) + 'pandoc {0}.md -f markdown -t latex -s -o {0}.tex'.format(filePath) ) # Remove header of tex file bContent = False ls = [] - with open('{}.tex'.format(OutputPath), 'r') as f: + with open('{}.tex'.format(filePath), 'r') as f: for line in f: if line.strip() == '\\end{document}': bContent = False @@ -103,12 +108,111 @@ if __name__ == '__main__': ls.append(line) if line.strip() == '\\begin{document}': bContent = True + # Adjust generated content for i, line in enumerate(ls): - ls[i] = line.replace('\\includegraphics', '\\includegraphics[max size={\\textwidth}{0.9\\textheight}]') + l = line + # adjust images max width/height + l = l.replace('\\includegraphics', '\\includegraphics[max size={\\textwidth}{0.9\\textheight}]') + # force figures placement + l = l.replace('\\begin{figure}', '\\begin{figure}[h!]') + # make som subsubsections invisible (for CHANGELOG) + l = re.sub(r'(\\subsubsection)({[0-9]+.[0-9]+.[0-9]+)', r'\1*\2', l) + ls[i] = l - with open('{}.tex'.format(OutputPath), 'w') as f: + with open('{}.tex'.format(filePath), 'w') as f: f.writelines(ls) +def getLatexModel(): + # Clone Git repository + os.chdir(buildDir) + os.system( + 'git clone {} {}'.format(latexModelRepository, latexModelDir) + ) + # back to original working drectory + os.chdir(baseDir) + +# Inject generated merged documentation and necessary resources (template, logos…) +# into LaTeX models directory by symlinking them +def injectContentIntoModel(mergedDocFilenameTex, lang): + """ + @param mergedDocFilenameTex filename of the generated LaTeX merged doc, with its .tex extension, without directory + @param lang language; used to inject content in the right template + """ + # Symlink necessary resources + os.chdir(modelDir) + relPathToMergedTexDoc = os.path.join('..', mergedDocFilenameTex) + os.system( + 'ln -s {} .'.format(relPathToMergedTexDoc) + ) + latexTemplate = 'cassiopee_doc_' + lang + '.tex' + relPathToLatexTemplate = os.path.join('../../latex', latexTemplate) + os.system( + 'ln -s {} .'.format(relPathToLatexTemplate) + ) + os.system( + 'ln -s ../../latex/logo_pole.png .' + ) + os.system( + 'rm rapport_inrae/logos.tex' + ) + os.system( + 'ln -s ../../../latex/logos.tex rapport_inrae/' + ) + # back to original working drectory + os.chdir(baseDir) + +# Build a PDF file from the LaTeX source +def buildPDF(lang): + # Compile LaTeX source + os.chdir(modelDir) + sourceTexFile = 'cassiopee_doc_' + lang + '.tex' + outputPdfFile = 'cassiopee_doc_' + lang + '.pdf' + os.system( + 'latexmk -f -pdf -interaction=nonstopmode {} > /dev/null 2>&1'.format(sourceTexFile) + ) + # copy generated PDF to release directory + shutil.copy(outputPdfFile, outputDir) + # back to original working drectory + os.chdir(baseDir) + +# Creates the PDF documentation file for the given language +def buildDocForLang(lang): + + # Prepare temporary build directory + os.makedirs(buildDir, exist_ok=True) + # Prepare output directory + os.makedirs(outputDir, exist_ok=True) + + # Read config + yamlPath = 'mkdocs-' + lang + '.yml' + dMkdocsYaml = readConfig(yamlPath) + + # Create string with merged MarkDown + s = exploreAndMerge(dMkdocsYaml['docs_dir'], dMkdocsYaml['nav']) + # Save the merged .md file + mergedDocFilename = mergedDocFilenamePrefix + lang + mergedDocOutputPath = os.path.join(buildDir, mergedDocFilename) + # remove internal links @TODO convert them to hyperref ? + s = re.sub(r'\[([^/]+)\]\([^ ]+\.md\)', r'\1', s) + with open('{}.md'.format(mergedDocOutputPath), 'w') as f: + f.writelines(s) + + # Convert to tex format + convertMdToTex(mergedDocOutputPath) + + # Get INRAE report LaTeX model and inject merged content inside + getLatexModel() + injectContentIntoModel(mergedDocFilename + '.tex', lang) + + # Build PDF from LaTeX source + buildPDF(lang) + + # Clean build dir + shutil.rmtree(buildDir) + + +if __name__ == '__main__': -# latexmk -f -pdf -interaction=nonstopmode rapport_inrae.tex -# latexmk -c \ No newline at end of file + for l in ['fr', 'en']: + print('building PDF doc for language "{}"'.format(l)) + buildDocForLang(l) diff --git a/package.json b/package.json index c023111df18825e71de0d5ef2ebbddc1bd16454c..15b7c763e59013137450c6454a661375a3ef9314 100644 --- a/package.json +++ b/package.json @@ -13,21 +13,22 @@ "e2e": "npm run preprocess && npm run ng -- e2e", "e2equick": "npm run ng -- e2e --dev-server-target=", "mkdocs": "node scripts/python3.js -m mkdocs build -f mkdocs-fr.yml && node scripts/python3.js -m mkdocs build -f mkdocs-en.yml && node scripts/mkdocs-postprocess.js", + "mkdocs2pdf": "node scripts/python3.js mkdocs2pdf.py", "preprocess": "node scripts/preprocessors.js && npm run mkdocs", "start": "npm run preprocess && npm run ng serve -- --host 0.0.0.0 --poll 5000", - "prod": "npm run preprocess && npm run ng serve -- --host 0.0.0.0 --prod", - "build": "npm run preprocess && npm run ng build -- --prod --build-optimizer=false", + "build-no-pdf": "npm run preprocess && npm run ng build -- --prod --build-optimizer=false", + "build": "npm run preprocess && npm run mkdocs2pdf && npm run ng build -- --prod --build-optimizer=false", "update-dist-index-mimetypes": "node scripts/update-dist-index-mimetypes.js", - "build-cordova": "npm run preprocess && npm run build && npm run update-dist-index-mimetypes && node scripts/add-cordova-script.js", + "build-cordova": "npm run build-no-pdf && npm run update-dist-index-mimetypes && node scripts/add-cordova-script.js", "release-android": "npm run build-cordova && \"node_modules/.bin/cordova\" platform add android; node scripts/remove-duplicate-sitemap.js && \"node_modules/.bin/cordova\" build android && node scripts/move-cordova-release.js", "electron": "npm run update-dist-index-mimetypes && \"node_modules/.bin/electron\" .", "release-linux-nocompile": "npm run update-dist-index-mimetypes && \"node_modules/.bin/electron-builder\"", - "release-linux": "npm run build && npm run release-linux-nocompile", + "release-linux": "npm run build-no-pdf && npm run release-linux-nocompile", "release-mac-nocompile": "npm run update-dist-index-mimetypes && \"node_modules/.bin/electron-builder\" --mac", - "release-mac": "npm run build && npm run release-mac-nocompile", + "release-mac": "npm run build-no-pdf && npm run release-mac-nocompile", "release-windows-nocompile": "npm run update-dist-index-mimetypes && \"node_modules/.bin/electron-builder\" --win", - "release-windows": "npm run build && npm run release-windows-nocompile", - "release-all": "node scripts/clean_release.js && npm run build && npm run update-dist-index-mimetypes && \"node_modules/.bin/electron-builder\" && \"node_modules/.bin/electron-builder\" --mac && \"node_modules/.bin/electron-builder\" --win && npm run release-android", + "release-windows": "npm run build-no-pdf && npm run release-windows-nocompile", + "release-all": "node scripts/clean_release.js && npm run build-no-pdf && npm run update-dist-index-mimetypes && \"node_modules/.bin/electron-builder\" && \"node_modules/.bin/electron-builder\" --mac && \"node_modules/.bin/electron-builder\" --win && npm run release-android", "compodoc": "node \"node_modules/@compodoc/compodoc/bin/index-cli.js\" -p src/tsconfig.app.json -s --language fr-FR -d compodoc-fr", "viz": "tsviz -recursive src/ nghyd_class_diagram.png" },