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.1.1.tar.gz (6.9 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.1.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sckernel-0.1.1.tar.gz
  • Upload date:
  • Size: 6.9 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.1.1.tar.gz
Algorithm Hash digest
SHA256 30b80c771e88724e6e79f5e546c7e906e212ad98244727232f70b71151a12a41
MD5 6a3d29f6e0f255156e99e2b12c06768e
BLAKE2b-256 69e6c52a2bced52169ea827d5dbdc1445726f660d52425af05e362e15e1777bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sckernel-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.6 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f1f6c9d7caf4c3ac112b8771f0a13a82e10e738870885fb98d52cdc2c95ede0
MD5 ee4a913d488a26abfd17bccb23485e89
BLAKE2b-256 beea110c6fecf370bc6e2eb4ef01acc48259c0012567725cd28d4b31d7e7a22f

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