Update README.md

dev-brahim
MOUDJED Brahim 2025-03-19 15:47:37 +01:00
parent b99e950a8e
commit 887a152fff
1 changed files with 46 additions and 6 deletions

View File

@ -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 lEau 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 lEau 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.