Installation¶

Get SuperCollider¶

Supriya uses SuperCollider as its synthesis engine. SuperCollider is available on OSX, Linux and Windows.

You can download SuperCollider from https://supercollider.github.io/.

Get Supriya¶

Install Supriya from PyPI via pip, or from its GitHub repository via git and pip:

josephine@laptop$ pip install supriya

josephine@laptop:~$ git clone https://github.com/supriya-project/supriya.git
josephine@laptop:~$ cd supriya
josephine@laptop:~/supriya$ pip install -e .

Optional dependencies¶

With Sphinx and IPython support:

josephine@laptop:~$ pip install supriya[docs]

josephine@laptop:~$ git clone https://github.com/supriya-project/supriya.git
josephine@laptop:~$ cd supriya
josephine@laptop:~/supriya$ pip install -e .[docs]

With linting and testing dependencies:

josephine@laptop:~$ pip install supriya[test]

josephine@laptop:~$ git clone https://github.com/supriya-project/supriya.git
josephine@laptop:~$ cd supriya
josephine@laptop:~/supriya$ pip install -e .[test]

Graphviz¶

Supriya uses Graphviz, an open-source graph visualization library, to create graphs of rhythm-trees and other tree structures, and to create visualizations of class hierarchies for its documentation. Graphviz is not necessary for making sounds with Supriya.

To install Graphviz:

josephine@laptop:~$ brew install graphviz

josephine@laptop:~$ sudo apt-get install graphviz

josephine@laptop:~$ choco install graphviz

Once you have install Graphviz, test if you can call it from your command-line by running the following:

josephine@laptop:~$ dot -V
dot - graphviz version 13.1.0 (20250701.0955)

FFmpeg and LAME¶

Supriya’s integrations with IPython and Sphinx need to ensure audio files are websafe. To do this, Supriya uses FFmpeg and LAME to transcode audio output from SuperCollider into OGG or MP3 files suitable for use in web browsers. If you want to build Supriya’s documentation or use Supriya in Jupyter notebooks, make sure to install them:

josephine@laptop:~$ brew install ffmpeg lame

josephine@laptop:~$ sudo apt-get install ffmpeg lame

josephine@laptop:~$ choco install ffmpeg lame