diff --git a/README.md b/README.md index e992b2ffa0a045a19c850a9acf7e0b76c0efe41f..e15636baded9462123dad41070963a228b825449 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,27 @@ Identification of Signature whistles in the DOLPHINFREE dataset. Using an original mehtod (DTW + HDBSCAN + manual verification), this repo analyses the whistle contour types (WCTs) and Signature Whistle Types (SWTs) of short-beaked common dolphins during the DOLPHINFREE experiments. +See article (in preparation) for more details. + ## Description ```bash . ├── README.md -├── WCT_analysis_utils.py # Functions/classes for analyses +├── WCT_analysis_utils.py # Functions/classes for analyses ├── dtw_hdbscan_categorisation.py # Categorisation of contours into WCTs -├── WCT_analysis.ipynb # Overview and statistics on WCTs and SWTs -├── artwarp-comparison # Categorisation of contours with ARTwarp -│ ├── artwarp-custom # ARTwarp modified for octave +├── WCT_analysis.ipynb # Overview and statistics on WCTs and SWTs +├── artwarp-comparison # Categorisation of contours with ARTwarp +│ ├── artwarp-custom # ARTwarp modified for octave │ ├── ARTwarp_automation.py # Python script to run ARTwarp on all contours │ ├── WCT_verification.py # Python script for manual verification -│ └── artwarp_hdbscan_comparison # Overview and comparison of WCTs obtained from 2 methods -├── resources # Inputs and outputs of python scripts -│ ├── ARTwarp_outputs # octave and json files -│ ├── DF-whistles # whistle features and json files -│ └── dtw_resources # hdbscan categorisation results -└── drafts # Folder containing unused scripts +│ └── artwarp_hdbscan_comparison # Overview and comparison of WCTs obtained from 2 methods +├── resources # Inputs and outputs of python scripts +│ ├── ARTwarp_outputs # octave and json files +│ ├── DF-whistles # Whistle features and json files +│ └── dtw_resources # hdbscan categorisation results +└── drafts # Folder containing unused scripts ``` ## What to use