soundevent is an open-source Python package for the computational biocoustic community, providing standardized tools for sound event analysis and data management.
Project description
soundevent
Warning This package is under active development, use with caution.
soundevent
is an open-source Python package that aims to support the
computational biocoustic community in developing well-tested, coherent, and
standardized software tools for bioacoustic analysis. The main goal of the
package is to provide a flexible yet consistent definition of what a sound event
is in a computational sense, along with a set of tools to easily work with this
definition. The package comprises three key components:
Main features
1. Data Classes for Bioacoustic Analysis
The soundevent
package defines several data classes that conceptualize and
standardize different recurrent objects in bioacoustic analysis. These data
classes establish the relationships between various concepts and specify the
attributes each object possesses. They are designed to be flexible enough to
cover a wide range of use cases in bioacoustic analysis. The package also
includes data validation mechanisms to ensure that the information stored is
valid and meaningful. Specifically, it defines objects related to sound events,
such as user annotations and model predictions.
2. Serialization, Storage, and Reading Functions
To promote standardized data formats for storing annotated datasets and other
information about sounds in recordings, the soundevent
package provides
several
functions
for serialization, storage, and reading of the different data classes offered.
These functions enable easy sharing of information about common objects in
bioacoustic research. By employing a consistent data format, researchers can
exchange data more efficiently and collaborate seamlessly.
3. Handling Functions for Sound Events
The soundevent
package also includes a variety of functions that facilitate
the handling of sound event objects. These functions serve multiple purposes,
such as matching sound events for model prediction evaluation, transforming
sound events, and managing metadata and labels. By offering a comprehensive set
of handling functions, the package aims to streamline the analysis workflow for
bioacoustic researchers, providing them with powerful tools to manipulate and
extract insights from their data.
Installation
You can install soundevent
using pip:
pip install soundevent
Documentation
For detailed information on how to use the package, please refer to the documentation.
Example Usage
To see practical examples of how to use soundevent, you can explore the collection of examples provided in the documentation's gallery.
Contributing
We welcome contributions from the community to make soundevent
even better. If
you would like to contribute, please refer to the contribution guidelines.
License
soundevent
is released under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for soundevent-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4648523e51f030c2c56b25aa188e447906cd5ee76bb6b5bd87eaa763ebbaab7 |
|
MD5 | 26c714483baa2a4ccf0dc1ee4a5bcc21 |
|
BLAKE2b-256 | 2cdb971006d82b44cdfb128a4694887ae5a88076c8642f5e9f928b077fde9890 |