A core package for acoustic communication research in Python.
VocalPy is a Python library for researchers studying how animals communicate with sound. It is the core package of the VocalPy community.
Useful links: Installation | Source code | Issue tracker | Report a bug or request a feature | Forum
Getting started
New to VocalPy? Check out the Getting Started section. It will tell you how to install VocalPy, introduce you to VocalPy’s key concepts, and give you links to additional tutorials.
User guide
The user guide provides more in-depth tutorials, as well as how-to’s that walk you through achieving specific tasks. This guide also provides in-depth information on the concepts of VocalPy, with useful background information and explanation.
API reference
The API reference guide contains a detailed description of the functions, modules, and objects included in VocalPy. This reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.
Contributor’s guide
Want to add to the codebase? Can help add translation or a flowchart to the documentation? The contributing guidelines will guide you through the process of improving VocalPy.
Support#
To report a bug or request a feature (such as a new annotation format),
please use the issue tracker on GitHub:
vocalpy/vocalpy#issues
To ask a question about vocalpy, discuss its development,
or share how you are using it,
please start a new topic on the VocalPy forum
with the vocalpy tag:
https://forum.vocalpy.org/
Contribute#
Issue Tracker: vocalpy/vocalpy#issues
Source Code: vocalpy/vocalpy
License#
The project is licensed under the BSD license.
CHANGELOG#
You can see project history and work in progress in the CHANGELOG.
Citation#
If you use vocalpy, please cite the DOI:
