search

dolphin-acoustics-vip / artwarp

MATLAB program for automated categorisation of tonal animal sounds
https://github.com/dolphin-acoustics-vip/artwarp/wiki
GNU Lesser General Public License v3.0
6 stars 9 forks source link

Provide minimal tests and instructions #5

Open olexandr-konovalov opened 2 years ago

olexandr-konovalov commented 2 years ago

To start with, we need to have some minimal test files and instructions how to run them.

olexandr-konovalov commented 2 years ago

For example, this can be placed on Wiki here https://github.com/vmjanik/artwarp/wiki

olexandr-konovalov commented 2 years ago

Wiki now is at https://github.com/dolphin-acoustics-vip/artwarp/wiki and has some initial instructions based on an earlier text by @RohanK22

olexandr-konovalov commented 1 year ago

@vmjanik are there any .ctr files that we can put here as a demo? I think that may eventually be useful if we want to run automated tests as suggested in #11.

vmjanik commented 1 year ago

Yes, definitely. Let's find some good examples from the VIP. This is a task for the biology students. Will mention it in the next session. Also, I foud a really old version of ARTWARP. Are you still "collecting" those?

olexandr-konovalov commented 1 year ago

Alternative (for testing) could be to have this files downloadable from somewhere during the test run - but that may be less sustainable than placing a demo folder in the repository.

I think at this point old versions are hard to insert into the repository - the process described at https://github.com/dolphin-acoustics-vip/artwarp/wiki/Restoring-the-history was meant to be run once. I am keeping the three older versions used for it "for the history", so if you pass to me another one, can put it next to them :) Just in case we might need to track something back.