Metadata-Version: 2.4
Name: biosonic
Version: 0.1.3
Summary: The biosonic package contains tools for bioacoustic analysis.
License-Expression: BSD-3-Clause
License-File: LICENSE.md
Keywords: bioacoustics,signal,sound synthesis,biology,singal processing
Author: Lena Gies
Author-email: lena.gies@univie.ac.at
Maintainer: Lena Gies
Maintainer-email: lena.gies@univie.ac.at
Requires-Python: >=3.11
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Provides-Extra: plot
Provides-Extra: praat
Requires-Dist: matplotlib ; extra == "plot"
Requires-Dist: numpy (>=2.4.0,<3.0.0)
Requires-Dist: pandas (>=2.3.3,<3.0.0)
Requires-Dist: praat-textgrids ; extra == "praat"
Requires-Dist: scipy (>=1.16.3,<2.0.0)
Project-URL: Bug Tracker, https://github.com/lenag23/biosonic/issues
Project-URL: Documentation, https://biosonic.readthedocs.io
Project-URL: Homepage, https://github.com/lenag23/biosonic.git
Project-URL: Repository, https://github.com/lenag23/biosonic.git
Description-Content-Type: text/markdown

# BioSonic
A python package for bioacoustics

**This package is in active development. If you want to work with it, be aware that it is prone to bugs and the functionality might change. If you would like to collaborate, please reach out to us! We would love for this to become a comprehensive package for bioacoustics and a collaborative project.**


## Description

BioSonic is a python package for bioacoustics analysis. It's goal is to provide a solution for common workflows from normalization of files and basic acoustic feature extraction to extracting features commonly used in ML pipelines as well as pitch tracking with a user friendy function based structure and parametrization.


## Getting Started

### Dependencies

BioSonic is written to be lightweight and only relies on numpy, scipy, and pandas for it's basic functionality. If you want plotting, this can be specified during pip installing:

```
pip install biosonic[plots]
```

For full functionality, the current dependencies are:

- matplotlib>=3.9.4
- numpy>=1.26.4
- pandas>=2.3.0
- scipy>=1.12
- praat-textgrids>=1.4.0

Python 3.10 and above are supported. Python 3.9 may be prone to some errors due to type checking but can be used with caution.

### Installing

For now, clone the repository and run this command inside its root:
```
pip install -e .
```

### Executing

See the jupyter notebook `example_usage.ipynb` for demonstrations of different functionalities.

## Authors

- Lena Gies (a12113965@unet.univie.ac.at)
- Tecumseh Fitch (tecumseh.fitch@unet.univie.ac.at)
- Yannick Jadoul (yannick.jadoul@uniroma1.it)

## Acknowledgments and References

* Anikin A. 2019. Soundgen: an open-source tool for synthesizing nonverbal vocalizations. Behavior Research Methods, 51(2), 778-792.
* Boersma P. (1993) Accurate short-term analysis of the fundamental frequency and the harmonics-to-noise ratio of a sampled sound. IFA Proceedings 17, 97–110.
* Childers DG, Skinner DP, Kemerait RC. (1977) The cepstrum: A guide to processing. Proc. IEEE 65, 1428–1443. https://doi.org/10.1109/PROC.1977.10747
* Klapuri A, Davy M. (2006) Signal processing methods for music transcription. New York: Springer. p.136
* Shannon C. E. (1948) A mathematical theory of communication. The Bell System Technical Journal XXVII.
* Sueur, J. (2018). Sound Analysis and Synthesis with R (Springer International Publishing). https://doi.org/10.1007/978-3-319-77647-7.
* Pauli Virtanen, Ralf Gommers, Travis E. Oliphant, Matt Haberland, Tyler Reddy, David Cournapeau, Evgeni Burovski, Pearu Peterson, Warren Weckesser, Jonathan Bright, Stéfan J. van der Walt, Matthew Brett, Joshua Wilson, K. Jarrod Millman, Nikolay Mayorov, Andrew R. J. Nelson, Eric Jones, Robert Kern, Eric Larson, CJ Carey, İlhan Polat, Yu Feng, Eric W. Moore, Jake VanderPlas, Denis Laxalde, Josef Perktold, Robert Cimrman, Ian Henriksen, E.A. Quintero, Charles R Harris, Anne M. Archibald, Antônio H. Ribeiro, Fabian Pedregosa, Paul van Mulbregt, and SciPy 1.0 Contributors. (2020) SciPy 1.0: Fundamental Algorithms for Scientific Computing in Python. Nature Methods, 17(3), 261-272. https://doi.org/10.1038/s41592-019-0686-2.


* https://de.mathworks.com/help/signal/ref/spectralentropy.html accessed January 13th, 2025. 18:34 pm
* https://docs.scipy.org/doc/scipy-1.15.2/reference/generated/scipy.stats.entropy.html accessed May 20th 2025, 11:32 am

