Skip to main content

A SuperCollider kernel for Jupyter Notebooks

Project description

# sckernel

sckernel is a Jupyter Notebook kernel for SuperCollider’s sclang. sckernel launches a post window to display output just as the SuperCollider IDE does while the Notebook front end handles input.

Syntax highlighting in the Notebook uses smalltalk as a default.

At this stage sckernel has only been tested on MacOS and is only guaranteed to work on that operating system. sckernel may work on other platforms but has not been tested yet.

## Requirements

In order for sckernel to work, the binary sclang must be in your $PATH.

## Installation

To install sckernel from PyPI:

` pip install sckernel python -m sckernel.install `

By default the kernel will be install in the per-user kernel registry, equivalent to python -m sckernel.install –user.

To install in the root directory or for an environment like Anaconda or venv, run instead python -m sckernel.install –sys-prefix.

## Using SuperCollider kernel

When opening Jupyter notebook, select from the <i>New</i> menu SC_Kernel to create a new SuperCollider notebook using sclang.

For the console frontend, you can run it by adding –kernel sckernel.

## Converting from Notebooks to SuperCollider files (.scd)

The sckernel package also comes with a convenience script to translate from Jupyter notebooks to .scd files (i.e., SuperCollider files).

` python -m sckernel.convertNotebookToScd /path/to/notebook /path/to/destination `

Some light formatting is done to make the .scd files readable in a similar way to Jupyter Notebooks.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sckernel-0.2.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sckernel-0.2.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file sckernel-0.2.0.tar.gz.

File metadata

  • Download URL: sckernel-0.2.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for sckernel-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3a8a6b4162e1058ea9567e2b6b856876f8dcd384eed612aae35f59cb3db8bb7c
MD5 a8cc0ff0b1a2c59e487b539a7197ca19
BLAKE2b-256 6c1a9fdc69036993246f62b819de12ea6691342a690f67d86caaf03c1ccaf698

See more details on using hashes here.

File details

Details for the file sckernel-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: sckernel-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.6.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0

File hashes

Hashes for sckernel-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d836735dc2981ec2713388145a332a5b7507e1fe77056d1e2e545da30e1115c0
MD5 938b1751129328f055e01f700a6b1102
BLAKE2b-256 3c37cb5f691062f40b2ae63d5cb93f5b2917703069afe4b0f41455e030ed1a87

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page