Go to file
Pierre-Antoine 8418935cd5 Packages: Put a minimal README. 2025-05-06 16:11:03 +02:00
Model SQL: read: Minor change. 2025-05-06 15:02:27 +02:00
Translation Sample data tab is updated with global variables in settings python file. Profiles position and samples position plotted on transect are added in, respectively, signal processing tab and sample data tab. 2023-08-24 10:11:16 +02:00
View Acoused: Close mpl figure at redraw. 2025-05-06 15:33:04 +02:00
icons Start Pierre Antoine - Brahim 2025-03-03 12:01:58 +01:00
logos add/update of logos 2025-03-26 14:19:31 +01:00
packages Packages: Put a minimal README. 2025-05-06 16:11:03 +02:00
virtualenv Git: Simplify 'requirements.txt'. 2025-04-30 17:37:31 +02:00
.editorconfig git: Add '.editorconfig' and update '.gitignore'. 2025-03-03 11:48:14 +01:00
.gitignore gitignore: Add '.exe' files. 2025-03-17 17:26:50 +01:00
ABS_calibration_constant_kt.xlsx Start Pierre Antoine - Brahim 2025-03-03 12:01:58 +01:00
AcouSed_UserManual.pdf Start Pierre Antoine - Brahim 2025-03-03 12:01:58 +01:00
Acoustic_Inversion_theory.odp docs source of aquascat tutorial and inversion theory 2025-03-26 14:40:01 +01:00
Acoustic_Inversion_theory.pdf Start Pierre Antoine - Brahim 2025-03-03 12:01:58 +01:00
LICENSE Add LICENSE 2024-11-26 17:22:22 +01:00
README.md README: Minor change. 2025-05-05 13:30:18 +02:00
Tuto_acoused.odp User Manual is replaced by Tuto acoused 2025-03-26 15:19:49 +01:00
Tuto_acoused.pdf User Manual is replaced by Tuto acoused 2025-03-26 15:19:49 +01:00
Tutorial_AQUAscat_software.odp docs source of aquascat tutorial and inversion theory 2025-03-26 14:40:01 +01:00
Tutorial_AQUAscat_software.pdf Start Pierre Antoine - Brahim 2025-03-03 12:01:58 +01:00
guix.sh git: Add Guix script and manifest. 2025-03-03 11:39:35 +01:00
main.py Notes: Add notes to SQL save file. 2025-04-17 14:00:46 +02:00
manifest.scm git: Minor fix for package license. 2025-04-15 10:32:38 +02:00
settings.py Acoustic data: Add bottom detection setting to SQL and refactoring. 2025-04-17 17:54:44 +02:00
tags.sh git: Add script 'tags.sh' for emacs tags file. 2025-03-03 11:45:37 +01:00
tools.py acoused: Trace 'full_update' method. 2025-03-26 09:16:06 +01:00

README.md

AcouSed

AcouSed for Acoustic Backscattering for Concentration of Suspended Sediments 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
  • Signal preprocessing : acoustic raw signal is preprocessed with filters
  • Sample data : fine and sand sediments samples data are downloaded and visualised
  • Calibration : calibration parameter are computed
  • Inversion : inversion method is calculated to provide fine and sand sediments fields

Installation

Standalone software

AcouSed can be launched with python installation. An executable is available on River Hydraulics 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

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.

Windows

You can use Pypi to get correct software environment and run the program.

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.

  python3 -m venv venv
  source ./venv/bin/activate
  python3 -m pip install -r requirement.txt
  python3 main.py

Linux with Guix

To run Acoused within a GNU Guix software environment, you need Guix installed on your computer and run the script guix.sh to run the program.

  ./guix.sh

  # If you need sqlitebrowser, use this command
  guix shell sqlitebrowser -- ./guix.sh

Support files & References

Authors & Contacts

  • Brahim MOUDJED 2022-2025 (INRAE)
  • Pierre-Antoine ROUBY 2025 (TECC)

If you have any questions or suggestions, please contact us to celine.berni@inrae.fr and/or jerome.lecoz@inrae.fr.

Acknowledgment

This study was conducted within the Rhône Sediment Observatory (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).

Industrial partners

License

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.

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.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.