Re-structuration + Update README

+ modified "audio_f" paths
+ added text to README.md

BBPs/1-BBP_detection.py

@@ -22,7 +22,7 @@ print("Importation of packages done!")
 #%% Parameters
 # Paths
 print("\rSetting up parameters...", end="\r")
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"  # Path to recordings 
+audio_f = "./../Audio_data"  # Path to recordings 
 csv_f = "./../CSV_data"      # Path to data in csv
 save_f = "./Results"         # Path to results
 

BBPs/2-manual_verification.py

@@ -23,7 +23,7 @@ print("Importation of packages done!")
 #%% Parameters
 print("\rSetting up parameters...", end="\r")
 # Paths
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"   # Path to recordings
+audio_f = "./../Audio_data"  # Path to recordings 
 csv_f = "./../CSV_data"      # Path to data in csv
 save_f = "./Results"         # Path to results
 

Clicks/1-detection_of_clicks.py

@@ -20,7 +20,7 @@ print("Importation of packages done!")
 #%% Parameters
 # Paths
 print("\rSetting up parameters...", end="\r")
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"  # Path to audio data
+audio_f = "./../Audio_data"             # Path to recordings 
 csv_f = "./../CSV_data"                 # Path to csv data
 save_f = "./Results/peaks_02052022"     # Path to save results
 

Clicks/3-projection_3features.py

@@ -24,7 +24,7 @@ print("Importation of packages done!")
 
 #%% Parameters
 print("\rSetting up parameters...", end="\r")
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"          # Path to audio data
+audio_f = "./../Audio_data"                             # Path to recordings 
 csv_f = "./../CSV_data"                                 # Path to csv data
 res_f = "./Results"                                     # Path to save results
 peaks_f = "peaks_02052022"                              # Path to save results

README.md

 # Scripts-DOLPHINFREE
- Scripts used for mdpi article
+A repository containing scripts and data used in *Lehnhoff et al, 2022* (in submission process).
+
+## Description
+This repository contains the files used to analyse data obtained during the <a href="https://umr-marbec.fr/en/the-projects/dolphinfree/">DOLPHINFREE project</a>. The goal was to detect and identify clicks and whisltes in audio recordings of common dolphins. 
+
+"BBPs", "Clicks" and "Whisltes" folders each treat a type of signal emitted by dolphins.   
+- Each folder contains numbered scripts for step-by-step execution. 
+- ___Utils.py files contain the functions necessary to the execution of the other scripts
+- "Results" and other subfolders contain... results and other outputs (surprise surprise).  
+
+"Stats" folder contains the files used to carry on a statistical analysis of extracted data.   
+"CSV_data" folder contains the visual observations made during experiments.  
+"Audio_data" folder is empty. Files cannot be made available publicly due to the presence of copyrighted elements.
+
+## Get Started
+.py files were developped using Python 3.9.7.  
+If needed, you can add missing packages to your environement using: 
+```bash
+$ pip install name-package
+```
+
+.matlab files can be executed in matlab or octave.
+
+## Contact
+Feel free to contact me if you have questions, tips or anything else to say. I'd really appreciate it!
+
+Loïc Lehnhoff - <loic.lehnhoff@gmail.com>
+
+## Publication
+**IN SUBMISSION PROCESS:** Lehnhoff, L.; Glotin, H.; Bernard, S.; Dabin, W.; Le Gall, Y.; Menut, E.; Meheust, E.; Peltier, H.; Pochat, A.; Pochat, K.; Rimaud, T.; Sourget, Q.; Spitz, J.; Van Canneyt, O.; Mérigot, B. *Behavioural response of common *dolphins Delphinus* delphis to a bio-inspired acoustic device for limiting fishery by-catch.* Sustainability **2022**, 1, 0
\ No newline at end of file

Whistles/1-Identification_of_whistles.py

@@ -22,7 +22,7 @@ print("Importation of packages complete!")
 #%% Parameters
 # Paths
 print("\rSetting up parameters...", end="\r")
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"  # Path to recordings 
+audio_f = "./../Audio_data"  # Path to recordings  
 csv_f = "./../CSV_data"      # Path to data in csv
 save_f = "./Trajectories"	 # Path were
 

Whistles/2-get_stats_of_whistles.py

@@ -22,7 +22,7 @@ print("Importation of packages complete!")
 
 #%% Parameters
 print("\rSetting up parameters...", end="\r")
-audio_f = "/media/loic/DOLPHINFREE/Acoustique"  # Path to recordings 
+audio_f = "./../Audio_data" 	# Path to recordings 
 csv_f = "./../CSV_data"         # Path to data in csv
 save_f = "./Trajectories"		# Path were
 results_f = "./Evaluation"