Skip to content

New stable release : v1.4.0
Compare
Choose a tag to compare
@shaupert shaupert released this 15 Jun 16:46
· 57 commits to production since this release
1.4.0
2eab961
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

This new release adheres to the guidelines for a more robust, stable, and responsive package, aiming to enhance performance and enable more reproducible scientific research.

We now integrate a continuous integration and continuous development process to ensure that scikit-maad is supported on different operating systems (UNIX, Windows and MacOSX) with different versions of Python.

With this update, we can easily track deprecated functions and anticipate future releases of the required packages.

Additionally, we have addressed all the detected bugs and made necessary fixes.

In particular, we have added the following functionalities:

New features
Template matching: new spectrogram template matching function to easily find stereotyped signals in audio recordings.
Acoustic features: new functions to compute robust spectral (peak frequency, spectral quantiles, bandwidth) and temporal features (duration, temporal_quantile) on audio signals.

Documentation
The updated documentation with new functions is still here: scikit-maad.github.io

Fixed bugs
Ensured swift integration with latest versions of scipy, numpy, pandas and scikit-image.

Enhancements
We worked to meet all of the standards listed on pyOpenSci

  • Advances in packaging best practices to ensure continuous integration and continuous development
  • Shifted to project.toml for packaging
  • CONTRIBUTING.md file: helps newcomers understand the project's contribution process and encourages active participation.
  • Github workflows for testing on multiple platforms and multiple versions of Python
  • Templates for reporting issues on GitHub
  • Community guidelines including contribution guidelines in the CONTRIBUTING.md file

Test
We improved the test coverage by adding tests for most of the main functions: spectrogram, alpha_indices, shape_features, and more. We used both, pytest with specific tests and doctest that tests the examples provided for each function in the documentation.

Note
Be aware that the v1.4.0 may be not compatible with older versions of Python (<=3.7).

Contributors
We would like to extend our sincere gratitude to all the contributors who have taken the time to submit issues and provide advice. Your valuable input and feedback have been instrumental in improving our software and ensuring its continued development. Thank you for your support and for helping us create a better experience for all users. In particular, we would like to thank:

Assets 2