From 16a941e68a7a9910f1e1b3c5876677618f211c89 Mon Sep 17 00:00:00 2001 From: Loic-Lenof <loic.lenof@gmail.com> Date: Wed, 21 Dec 2022 15:59:33 +0100 Subject: [PATCH] READMEs corrections --- README.md | 18 +++++++++--------- audio_examples/README.md | 4 ++-- outputs/README.md | 3 +++ 3 files changed, 14 insertions(+), 11 deletions(-) create mode 100644 outputs/README.md diff --git a/README.md b/README.md index ac13646..2410200 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Description -`PyAVA` is a graphical annotation tool written in Python whose purpose is to provide an esay way to draw contours on vocalisations from audio recordings. It uses [Tkinter](https://docs.python.org/3/library/tkinter.html) for its graphical interface and can be run on any OS. It does not require images (spectrogram), only waveforms from wavefiles, which is its main advantage for easy and efficient annotation. +`PyAVA` is a graphical annotation tool written in Python whose purpose is to provide an esay way to draw contours on vocalisations from audio recordings. It uses [Tkinter](https://docs.python.org/3/library/tkinter.html) for its graphical interface and can be run on any OS. It does not require images (aka spectrogram) to function, only waveforms, which is its main advantage to be an easy and efficient annotation tool.  @@ -24,7 +24,7 @@ ## Requirements -- Ubuntu / Windows / macOS (Though it has only been tested on Ubuntu). +- Ubuntu / Windows / macOS (tested only on Ubuntu but it *should* work on all OS). - Python3 - Packages in `requirements.txt` @@ -33,13 +33,13 @@ Install packages in your python environment with `$ pip install -r requirements. ## Usage -### Code -For classic use, run `$python PyAVA.py -dir myWavefileFolder -out myOutputFolder` in terminal. +### Execution +For classic use, run `$python PyAVA.py -dir myWavefileFolder -out myOutputFolder` in terminal. Run `$python PyAVA.py --help` for details. -The annotations are saved as [JSON](http://www.json.org/) files. Each file contains a dict of contours. For each contour there is a list of points such as point = [time (in sec), frequency (in kHz)]. +The annotations are saved in [JSON](http://www.json.org/) files. Each file contains a dict of contours. For each contour there is a list of points, each point is defined by a list of two elements : [time (in sec), frequency (in kHz)]. -### User +### User interaction - Use the toolbar to interact with the plot. - No toolbar item must be selected in order to annotate. - Left-click on a name in the legend to activate annotation with it. @@ -51,9 +51,9 @@ The annotations are saved as [JSON](http://www.json.org/) files. Each file conta - Add more contours by clicking on the `MORE CONTOURS` button. ### Re-use data -Two functions are available to load and display saved annotations : `load_contours_file` and `display_contours`. +Two functions are available to load and display the saved annotations : `load_contours_file` and `display_contours`. -Run the following lines in python terminal to see an exemple of use : +Run the following lines in a python terminal to see an exemple of use : ```python import os import json @@ -85,4 +85,4 @@ display_contours( ## Support -Please contact [me](loic.lehnhoff@gmail.com) for any question and/or idea. +Please contact [me](mailto:loic.lehnhoff@gmail.com) for any question and/or idea. diff --git a/audio_examples/README.md b/audio_examples/README.md index c2d1b5d..29fc311 100644 --- a/audio_examples/README.md +++ b/audio_examples/README.md @@ -1,4 +1,4 @@ # Audio-examples -These examples were taken from recordings made during the <a href="https://umr-marbec.fr/en/the-projects/dolphinfree/">DOLPHINFREE project</a>. -More information on how this data was collected in <a href="https://doi.org/10.3390/su142013186">*Lehnhoff et al. (2022).*</a>. \ No newline at end of file +These examples were taken from recordings made during the <a href="https://umr-marbec.fr/en/the-projects/dolphinfree/">DOLPHINFREE project</a>. They contain whistles of common dolphins (*Delphinus delphis*) for which annotations were necessary. `PyAVA` was designed primarily to annotate this type of sound. +More information on how this data was collected in <a href="https://doi.org/10.3390/su142013186">*Lehnhoff et al. (2022)*</a>. \ No newline at end of file diff --git a/outputs/README.md b/outputs/README.md new file mode 100644 index 0000000..7b1eb2f --- /dev/null +++ b/outputs/README.md @@ -0,0 +1,3 @@ +# Audio-examples + +These outputs are examples of what can be produced using `PyAVA`. Only a small part of the whistles present in `audio_examples` were annotated. \ No newline at end of file -- GitLab