# AcouSed

AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR.

<p>
  <a href="https://riverhydraulics.riverly.inrae.fr/outils/logiciels-pour-la-mesure/acoused">
    <img src="logos/AcouSed.png" align="center" width=200px>
  </a>
</p>

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](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.

#### Windows

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

```bat
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.

```shell
  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](https://guix.gnu.org/) software
environment, you need Guix installed on your computer and run the
script `guix.sh` to run the program.

```shell
  ./guix.sh

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

## Support files & References

- [ ] [Acoustic inversion method diagram](https://forgemia.inra.fr/theophile.terraz/acoused/-/blob/main/Acoustic_Inversion_theory.pdf?ref_type=heads)
- [ ] [Tutorial AQUAscat software : AQUAtalk](https://forgemia.inra.fr/theophile.terraz/acoused/-/blob/main/Tutorial_AQUAscat_software.pdf?ref_type=heads)


- [ ] [Adrien Vergne thesis (2018)](https://theses.fr/2018GREAU046)
- [ ] [Vergne A., Le Coz J., Berni C., & Pierrefeu G. (2020), Water Resources Research, 56(2)](https://doi.org/10.1029/2019WR024877)
- [ ] [Vergne A., Berni C., Le Coz J., & Tencé F., (2021), Water Resources Research, 57(9)](https://doi.org/10.1029/2021WR029589)

## Authors & Contacts

- Brahim MOUDJED  2022-2025 ([INRAE](https://www.inrae.fr/))
- Pierre-Antoine ROUBY  2025 ([TECC](https://parouby.fr))

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](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).

<p>
  <a href="https://observatoire-sediments-rhone.fr/">
    <img src="logos/OSR.png" align="center" width=200px>
  </a>
</p>

## Industrial partners

<p>
  <a href="https://www.cnr.tm.fr/">
    <img src="logos/CNR.png" align="center" width=200px>
  </a>

  <a href="https://ubertone.com/">
    <img src="logos/Ubertone.jpg" align="center" width=200px>
  </a>

  <a href="https://www.edf.fr/hydraulique-isere-drome">
    <img src="logos/EDF.png" align="center" width=200px>
  </a>
</p>


## License

<p>
  <a href="https://www.inrae.fr/">
    <img src="logos/BlocMarque-INRAE-Inter.jpg" align="center" width=200px>
  </a>
</p>

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/>.
