Commit 74472c91 authored by Nadir Dalla Pozza's avatar Nadir Dalla Pozza
Browse files

README update

parent 63412452
...@@ -31,7 +31,7 @@ pip install -r requirements.txt ...@@ -31,7 +31,7 @@ pip install -r requirements.txt
## Usage ## Usage
Once the libraries are installed, you should customise the configuration file `config.yaml`. Once the libraries are installed, you should customise the configuration file `config.yaml`.
There are nine required parameters: There are six required parameters:
1. `WORKING_PATH` that specifies the working path where all input files are stored and where all output files will be saved; 1. `WORKING_PATH` that specifies the working path where all input files are stored and where all output files will be saved;
2. `FILES_NAME` that specifies the name of the Preservation Audio File to be considered. Use an empty string 2. `FILES_NAME` that specifies the name of the Preservation Audio File to be considered. Use an empty string
to plot filter frequency response; to plot filter frequency response;
...@@ -112,6 +112,16 @@ python3 tapeAudioRestoration.py ...@@ -112,6 +112,16 @@ python3 tapeAudioRestoration.py
``` ```
Useful log information will be displayed during execution, requiring occasional interaction. Useful log information will be displayed during execution, requiring occasional interaction.
To enable integration in more complex workflows, it is also possible to launch the *Tape Audio Restoration* with command line arguments:
```
python3 tapeAudioRestoration.py [-h] -w WORKING_PATH -f FILES_NAME -ew EQUALIZATION_W -sw SPEED_W -er EQUALIZATION_R -sr SPEED_R
```
If you use the `-h` flag:
```
python3 tapeAudioRestoration.py -h
```
all instructions will be displayed.
## Support ## Support
If you require additional information or have any problem, you can contact us at: If you require additional information or have any problem, you can contact us at:
* Nadir Dalla Pozza (nadir.dallapozza@unipd.it); * Nadir Dalla Pozza (nadir.dallapozza@unipd.it);
......
#!/usr/bin/env python #!./venv/bin/activate
""" """
MPAI CAE-ARP Tape Audio Restoration. MPAI CAE-ARP Tape Audio Restoration.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment