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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sckernel-0.0.1.tar.gz.
File metadata
- Download URL: sckernel-0.0.1.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
35b507aae81cbf9c0d3895dc92c126ad6c8116504aed70aefa1e260c0cee1045
|
|
| MD5 |
1d253bdf291037186a3f93847bd946f6
|
|
| BLAKE2b-256 |
488809f89fc6154114498beb8088d0c9d6bcc740e7b81f7dcdb0e75e3ab3df8b
|
File details
Details for the file sckernel-0.0.1-py3-none-any.whl.
File metadata
- Download URL: sckernel-0.0.1-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a2241eb3ad96511bfdba15b6796de63dfd51a30e93278651e2962bffb014143
|
|
| MD5 |
7304ad468c982f8db1114878cf1bdcc0
|
|
| BLAKE2b-256 |
e9f0ca384fe200b56bf190f0c687afd1416d4d0fe618469e36090b70012198c8
|