Installation

Hint

All methods below require you to have pip installed. Check if pip is installed by typing the following in a terminal window. If working in a virtual environment, make sure you see (venv) before your username in your terminal:

pip --version

If you do not see a version number, please follow these instructions to install pip.

Installing through PyPI (recommended)

thebeat is available through PyPI, and can be installed by typing the following in a command window or terminal:

pip install thebeat

Note that if you want use thebeat’s functionality for plotting musical notation, you have to install it using:

pip install 'thebeat[music_notation]'

This will install thebeat with the dependencies needed for plotting musical notation. These dependencies are abjad and Lilypond.

You can now import thebeat in your preferred editor using:

import thebeat

Try thebeat directly via Binder

If you don’t use a lot of Python, and the above instructions are a bit too much, you can try thebeat directly in your browser via Binder. Follow this link to do so.

Installing development version from GitHub

Open up a terminal and run:

pip install git+https://github.com/jellevanderwerff/thebeat.git@main#egg=thebeat