From de54303e0ba9fa76031cb4aad635b8103ae48d34 Mon Sep 17 00:00:00 2001 From: Pierre-Antoine Rouby Date: Wed, 12 Mar 2025 11:17:16 +0100 Subject: [PATCH] README.md: Minor change. --- README.md | 42 +++++++++++++++++++----------------------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 1721292..00d3114 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,23 @@ # AcouSed -AcouSed for **Acou**stic Backscattering for Concentration of Suspended **Sed**iments in Rivers is a software developped by INRAE, in collaboation with CNR. +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) -It is divided in six tabs: -- Acoustic data : acoustic raw data are downloaded and visualised +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 +- 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 -## Software documentation - -### Installation +## Installation 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. -## Development documentation - ### **TODO** Windows ### Linux @@ -49,16 +45,15 @@ script `guix.sh` to run the program. guix shell sqlitebrowser -- ./guix.sh ``` -## License +## Support files & References -AcouSed -Copyright (C) 2024 - INRAE +- [ ] [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) -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 . +- [ ] [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 @@ -68,15 +63,16 @@ You should have received a copy of the GNU General Public License along with thi If you have any questions or suggestions, please contact us to celine.berni@inrae.fr and/or jerome.lecoz@inrae.fr. ## Acknowledgment (Funding) -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. -## Support files & References +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. -- [ ] [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) +## License +AcouSed +Copyright (C) 2024-2025 - INRAE -- [ ] [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) +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 .