72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# AcouSed
|
|
|
|
**TODO** short description
|
|
|
|
## Getting started
|
|
|
|
### 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.
|
|
|
|
### **TODO** Windows
|
|
|
|
|
|
### 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
|
|
```
|
|
|
|
## **TODO** Documentation
|
|
|
|
## Authors and acknowledgment
|
|
|
|
### Development
|
|
|
|
- Brahim MOUDJED ????-2025 ([INRAE](https://www.inrae.fr/))
|
|
- Pierre-Antoine ROUBY 2025 ([TECC](https://parouby.fr))
|
|
|
|
### **TODO** Funding
|
|
|
|
- [INRAE](https://www.inrae.fr/)
|
|
- CNR
|
|
|
|
## License
|
|
|
|
Copyright (C) ????-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/>.
|