From 887a152fff4436545446976f9dc8778503a7c708 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:47:37 +0100 Subject: [PATCH 01/11] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 00d3114..c5306e4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR. -![](icons/Logo-INRAE.jpg) +![](logos/AcouSed.png) It is divided in six tabs: - Acoustic data : acoustic raw data are downloaded and visualised @@ -13,14 +13,39 @@ It is divided in six tabs: ## Installation +### Standalone software + +AcouSed can be launched with python installation. An executable is available on [River Hydraulics](https://riverhydraulics.riverly.inrae.fr/outils/logiciels-pour-la-mesure/acoused) teams website. +The user needs to download the folder "acoused-packaging" including : +- icons and logos folder +- _internal folder (python packages) +- executable file +- calibration constant file +- documentation + +Acoused.exe file must be launched from this folder. +Test data can be dowloaded from the [INRAE nextcloud](https://nextcloud.inrae.fr/s/3zZdieztrx7nwYa) + +### Python environment + Acoused is developped for Linux and Windows on Python version 3.8 or greater. By default, Acoused is developped with Pypi package dependencies, but is also possible to use Guix package manager to run Acoused. -### **TODO** Windows +#### Windows -### Linux +You can use Pypi to get correct software environment and run the +program. + +```shell +python -m venv env +env\Scripts\activate.bat +python -m pip install -U -r ..\virtualenv\requirements.txt +python main.py +``` + +#### Linux You can use Pypi to get correct software environment and run the program. @@ -32,7 +57,7 @@ program. python3 main.py ``` -### Linux with Guix +#### Linux with Guix To run Acoused within a [GNU Guix](https://guix.gnu.org/) software environment, you need Guix installed on your computer and run the @@ -62,15 +87,30 @@ script `guix.sh` to run the program. If you have any questions or suggestions, please contact us to celine.berni@inrae.fr and/or jerome.lecoz@inrae.fr. -## Acknowledgment (Funding) +## Acknowledgment -This study was conducted within the [Rhône Sediment Observatory](https://observatoire-sediments-rhone.fr/) (OSR), a multi-partner research program funded through the Plan Rhône by the European Regional Development Fund (ERDF), Agence de l’Eau RMC, CNR, EDF and three regional councils (Auvergne-Rhône-Alpes, PACA and Occitanie). It was also support by CNR. +This study was conducted within the [Rhône Sediment Observatory](https://observatoire-sediments-rhone.fr/) (OSR), a multi-partner research program funded through the Plan Rhône by the European Regional Development Fund (ERDF), Agence de l’Eau RMC, CNR, EDF and three regional councils (Auvergne-Rhône-Alpes, PACA and Occitanie). + +![](logos/OSR.png) + +## Industrial partners + +[CNR](https://www.cnr.tm.fr/) +![](logos/CNR.png) + +[UBERTONE](https://ubertone.com/) +![](logos/Ubertone.jpeg) + +[EDF](https://www.edf.fr/hydraulique-isere-drome) +![](logos/EDF.png) ## License AcouSed Copyright (C) 2024-2025 - INRAE +![](logos/BlocMarque-INRAE-Inter.jpg) + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. From 9e7f34238ec49f7da42bc2919e2c13a3b8f3de07 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:49:25 +0100 Subject: [PATCH 02/11] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c5306e4..22c6db8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR. +
![](logos/AcouSed.png) +
It is divided in six tabs: - Acoustic data : acoustic raw data are downloaded and visualised From a877cf86d75a266eb78558bcf373aab0a6fe3716 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:50:12 +0100 Subject: [PATCH 03/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 22c6db8..b9693e7 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR.
-![](logos/AcouSed.png) +
It is divided in six tabs: From f1b196dba27ce1218c1bbaeb1a51922b8fb06b6c Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:50:41 +0100 Subject: [PATCH 04/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b9693e7..217f814 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR.
- +
It is divided in six tabs: From d3afd2900e9db9659588cdb03d8fd9ac1cae593b Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:51:59 +0100 Subject: [PATCH 05/11] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 217f814..65e3a19 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR. -
- -
+

+ +

It is divided in six tabs: - Acoustic data : acoustic raw data are downloaded and visualised From 0eb10fea10c479c7769df1656e4611f80c4094c0 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:55:03 +0100 Subject: [PATCH 06/11] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 65e3a19..6e0527a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR. -

- +

+

It is divided in six tabs: From 089a7657ab7fbfad3c56341abc1add8ebce2756a Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:57:59 +0100 Subject: [PATCH 07/11] Update README.md --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e0527a..73c2f27 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR.

- +

It is divided in six tabs: @@ -93,25 +93,39 @@ If you have any questions or suggestions, please contact us to celine.berni@inra This study was conducted within the [Rhône Sediment Observatory](https://observatoire-sediments-rhone.fr/) (OSR), a multi-partner research program funded through the Plan Rhône by the European Regional Development Fund (ERDF), Agence de l’Eau RMC, CNR, EDF and three regional councils (Auvergne-Rhône-Alpes, PACA and Occitanie). -![](logos/OSR.png) +

+ +

## Industrial partners [CNR](https://www.cnr.tm.fr/) -![](logos/CNR.png) + +

+ +

[UBERTONE](https://ubertone.com/) -![](logos/Ubertone.jpeg) + +

+ +

+ [EDF](https://www.edf.fr/hydraulique-isere-drome) -![](logos/EDF.png) +

+ +

+ ## License AcouSed Copyright (C) 2024-2025 - INRAE -![](logos/BlocMarque-INRAE-Inter.jpg) +

+ +

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. From 43d586bf052de7bfcc64a57ffededabc5e6fe984 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:58:55 +0100 Subject: [PATCH 08/11] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 73c2f27..07987e0 100644 --- a/README.md +++ b/README.md @@ -102,19 +102,19 @@ This study was conducted within the [Rhône Sediment Observatory](https://observ [CNR](https://www.cnr.tm.fr/)

- +

[UBERTONE](https://ubertone.com/)

- +

[EDF](https://www.edf.fr/hydraulique-isere-drome)

- +

@@ -124,7 +124,7 @@ AcouSed Copyright (C) 2024-2025 - INRAE

- +

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. From fbc46f334463ec78b7befe20c2d613938a0190d8 Mon Sep 17 00:00:00 2001 From: MOUDJED Brahim Date: Wed, 19 Mar 2025 15:59:21 +0100 Subject: [PATCH 09/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 07987e0..7d5b31d 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ If you have any questions or suggestions, please contact us to celine.berni@inra This study was conducted within the [Rhône Sediment Observatory](https://observatoire-sediments-rhone.fr/) (OSR), a multi-partner research program funded through the Plan Rhône by the European Regional Development Fund (ERDF), Agence de l’Eau RMC, CNR, EDF and three regional councils (Auvergne-Rhône-Alpes, PACA and Occitanie).

- +

## Industrial partners From 1fffdc714ec8898ae35b866aff20dd03dafe87ec Mon Sep 17 00:00:00 2001 From: brahim Date: Wed, 19 Mar 2025 16:14:25 +0100 Subject: [PATCH 10/11] scripts to generate acoused release --- packages/debug.bat | 5 +++++ packages/windows.bat | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 packages/debug.bat create mode 100644 packages/windows.bat diff --git a/packages/debug.bat b/packages/debug.bat new file mode 100644 index 0000000..c192c4c --- /dev/null +++ b/packages/debug.bat @@ -0,0 +1,5 @@ + +@ECHO OFF + +start cmd /c test3\Acoused.exe + diff --git a/packages/windows.bat b/packages/windows.bat new file mode 100644 index 0000000..baa4d32 --- /dev/null +++ b/packages/windows.bat @@ -0,0 +1,32 @@ + +@ECHO OFF + +rem Python environment (-U = update python packages / -r = texte file) +python -m pip install -U -r ..\virtualenv\requirements.txt + +rem Build windows version +mkdir acoused_packaging +pyinstaller --name "acoused" ..\main.py -y + +rem Icons +mkdir acoused_packaging\icons +copy /y ..\icons\*.png acoused_packaging\icons + +rem Logos +mkdir acoused_packaging\logos +copy /y ..\logos\* acoused_packaging\logos + +rem Doc +copy /y ..\ABS_calibration_constant_kt.xlsx acoused_packaging +copy /y ..\AcouSed_UserManual.pdf acoused_packaging +copy /y ..\Acoustic_Inversion_theory.pdf acoused_packaging +copy /y ..\Tutorial_AQUAscat_software.pdf acoused_packaging + +rem move exe +move /y dist\AcouSed\acoused.exe acoused_packaging +move /y dist\acoused\_internal acoused_packaging +copy debug.bat acoused_packaging +rmdir /s /q build +rmdir /s /q dist +del /q AcouSed.spec + From 1e9116bd0d6e6ef1fd644b3658366e404923d9d2 Mon Sep 17 00:00:00 2001 From: brahim Date: Thu, 20 Mar 2025 10:06:00 +0100 Subject: [PATCH 11/11] File requirements.txt and folder vritual_env are deleted --- requirements.txt | 13 ------------- virtual_env/requirements.txt | 33 --------------------------------- 2 files changed, 46 deletions(-) delete mode 100644 requirements.txt delete mode 100644 virtual_env/requirements.txt diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 10a565e..0000000 --- a/requirements.txt +++ /dev/null @@ -1,13 +0,0 @@ -matplotlib==3.6.3 -numpy==1.23.5 -pandas==1.5.3 -PyQt5==5.15.9 -PyQt5-Qt5==5.15.2 -PyQt5-sip==12.11.0 -python-dateutil==2.8.2 -scikit-learn==1.2.1 -scipy==1.10.0 -pyqt-file-list-widget==0.0.1 -qtrangeslider==0.1.5 -astropy==6.1.7 -odfpy==1.4.1 diff --git a/virtual_env/requirements.txt b/virtual_env/requirements.txt deleted file mode 100644 index bbca5cf..0000000 --- a/virtual_env/requirements.txt +++ /dev/null @@ -1,33 +0,0 @@ -contourpy==1.0.7 -cycler==0.11.0 -defusedxml==0.7.1 -et-xmlfile==1.1.0 -fonttools==4.38.0 -importlib-resources==5.12.0 -joblib==1.2.0 -kiwisolver==1.4.4 -llvmlite==0.39.1 -matplotlib==3.6.3 -numba==0.56.4 -numpy==1.23.5 -odfpy==1.4.1 -openpyxl==3.0.10 -packaging==23.0 -pandas==1.5.3 -Pillow==9.4.0 -profilehooks==1.12.0 -pyparsing==3.0.9 -pyqt-checkbox-table-widget==0.0.14 -PyQt5==5.15.9 -PyQt5-Qt5==5.15.2 -PyQt5-sip==12.11.0 -python-dateutil==2.8.2 -pytz==2022.7.1 -scikit-learn==1.2.1 -scipy==1.10.0 -six==1.16.0 -threadpoolctl==3.1.0 -utm==0.7.0 -xlrd==2.0.1 -xmltodict==0.13.0 -zipp==3.15.0