sing4me 1.4.0rc0

Python package for online and laboratory singing experiments

sing4me — Singing Experiments

Computational Auditory Perception Group
Max Planck Institute for Empirical Aesthetics

sing4me is a Python package for running singing experiments in laboratory and online settings. It installs two modules:

1. sing4me: signal-processing code for singing extraction, plus the bundled Praat syllable_extract.praat script.
2. sing_experiments: helpers for running singing experiments — methods to generate and transform melodies, prescreening tests, parameter presets, and questionnaires.

Quick Links

• Source code
• Issues

Installation

Prerequisites

• Python 3.9 or newer (tested with 3.9–3.13)
• macOS (primary testing platform)

Setting up a Virtual Environment

pip3 install virtualenv virtualenvwrapper

export WORKON_HOME=$HOME/.virtualenvs
mkdir -p $WORKON_HOME
export VIRTUALENVWRAPPER_PYTHON=$(which python3)
source $(which virtualenvwrapper.sh)

mkvirtualenv sing4me --python $(which python3)

The virtual environment is now active. To activate it later:

workon sing4me

Installing sing4me

To install the published package from PyPI:

pip install sing4me

To install from a source checkout in editable mode (this also installs the runtime dependencies declared in pyproject.toml):

git clone [e-mail]:computational-audition-lab/sing4me.git
cd sing4me
pip install -e .

Optional extras:

• dev — pytest, flake8, black
• notebook — jupyter, sounddevice, soundfile (needed for the demo notebooks)
• psynet — pulls in PsyNet; only required if you import sing_experiments.questionnaire or sing_experiments.resources (the rest of sing_experiments and all of sing4me works without PsyNet)

Install an extra with, e.g.:

pip install -e ".[dev]"

Verify installation

sing4me --version

Tests

The unit tests live in sing_experiments/test/ and run with pytest:

pip install -e ".[dev]"
pytest -v

Note: the directory sing4me/tests/ in the source checkout contains a large collection of sample .wav / .png / .txt files used for manual / pilot inspection (not pytest tests). Those samples are kept in the repository for development but are not shipped with the PyPI distribution (they would exceed PyPI's per-file limits). To use them, work from a source checkout.

Running Demos

The demo notebooks in demos/ rely on the local input/ directory of sample audio. Like the manual test samples, those audio assets are not shipped with the PyPI distribution — clone the repository if you want to run the demos:

git clone [e-mail]:computational-audition-lab/sing4me.git
cd sing4me
pip install -e ".[notebook]"
jupyter notebook

Then open one of:

• demos/iterated_singing_demo.ipynb
• demos/debug_singing_extract.ipynb
• demos/debug_singing_extract-with-singing.ipynb

License

MIT License