Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A Python API for SuperCollider

Project description

Supriya is a Python interface to SuperCollider.

Supriya lets you:

  • boot and communicate with SuperCollider’s scsynth synthesis server
  • construct and compile SynthDef unit generator graphs in native Python code
  • build and control graphs of synthesizers and synthesizer groups
  • object-model scysnth OSC communications explicitly via Request and Response classes
  • compile non-realtime synthesis scores via Supriya’s nonrealtimetools.Session class


This project is still under heavy development, is not yet stable, and is not yet intended for deployment in the field.

Send compliments or complaints to, or register an issue at

Supriya is compatible with Python 3.3+ only.


GitHub | PyPI | Documentation | Issue Tracker | Mailing list |


1. Get Supriya and SuperCollider

Get Supriya from GitHub:

~$ git clone
~$ cd supriya
supriya$ sudo pip install -e .

Get SuperCollider from

Run the tests to make sure everything’s OK:

supriya$ tox

Consult our installation instructions for detailed help on getting Abjad, setting it up, and installing any additional dependencies like Graphviz.

2. Make some noise

Start your Python interpreter and import Supriya:

>>> from supriya import *

Boot the SuperCollider server:

>>> server = servertools.Server()
>>> server.boot()
<Server: udp://, 8i8o>

Create and allocate a group:

>>> group = servertools.Group().allocate()

Make a synthesizer definition and send it to the server:

>>> builder = synthdeftools.SynthDefBuilder(
...     amplitude=1.0,
...     frequency=440.0,
...     gate=1.0,
...     )
>>> with builder:
...     source =
...         frequency=builder['frequency'],
...         )
...     envelope =
...         done_action=synthdeftools.DoneAction.FREE_SYNTH,
...         envelope=synthdeftools.Envelope.asr(),
...         gate=builder['gate'],
...         )
...     source = source * builder['amplitude']
...     source = source * envelope
...     out =
...         bus=(0, 1),
...         source=source,
...         )
>>> synthdef =

Synchronize with the server:

>>> server.sync()
<Server: udp://, 8i8o>

Create a synthesizer with the previously defined synthesizer definition:

>>> synth = servertools.Synth(synthdef)
>>> synth
<Synth: ???>

Allocate it on the server as a child of the previously created group:

>>> group.append(synth)
>>> synth
<Synth: 1001>

Query the server’s node tree:

>>> response = server.query_remote_nodes(include_controls=True)
>>> print(response)
NODE TREE 0 group
    1 group
        1000 group
            1001 f1c3ea5063065be20688f82b415c1108
                amplitude: 0.0, frequency: 440.0

Bind a MIDI controller to the synth’s controls:

>>> korg = miditools.NanoKontrol2()
>>> korg.open_port(0)
>>> source = korg.fader_1
>>> target = synth.controls['frequency']
>>> bind(source, target, range_=Range(110, 880), exponent=2.0)

Release the synth:

>>> synth.release()

Quit the server:

>>> server.quit()
<Server: offline>

Project details

Release history Release notifications

This version
History Node


Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page