# sc3nb
sc3nb is a python package that offers an interface to SuperCollider3 (SC3), with special support to be used within jupyter notebooks.
* [Documentation](https://interactive-sonification.github.io/sc3nb)
* [Source code](https://github.com/interactive-sonification/sc3nb)
* [Bug reports](https://github.com/interactive-sonification/sc3nb/issues)
The goal of sc3nb is to facilitate the development of auditory displays and interactive sonifications by teaming up
* python (and particularly numpy, scipy, pandas, matplotlib etc.) for data science
* and SuperCollider3 for interactive real-time sound rendering.
It allows:
* to interface with the SuperCollider audio server (scsynth) aswell as the SuperCollider Language and Interpreter (sclang) via the SC class
* The SuperCollider audio server can be started and addressed via
* OSC directly with OSC messages and bundles
* Python implementations of Classes from SuperCollider like `Synth`, `SynthDef`, `Buffer` and `Bus`
* the `Score` class for non-realtime synthesis
* use the SuperCollider language (sclang) interactively via a subprocess.
* write SuperCollider language code in Jupyter Notebooks and let sclang evaluate it.
* inject Python variables into your sclang code
* get the results of the sclang code in Python
* helper functions such as linlin, cpsmidi, midicps, clip, ampdb, dbamp which work like their SC3 counterparts.
sc3nb can be used for
* multi-channel audio processing
* auditory display and sonification
* sound synthesis experiment
* audio applications in general such as games or GUI-enhancements
* signal analysis and plotting
* computer music and just-in-time music control
* any usecase that the SuperCollider 3 language supports
It is meant to grow into a backend for a sonification package, and can be used both from jupyter and in standard python software development.
## Installation
- To use sc3nb you need a installation of SuperCollider on your system. See [SuperCollider Download](https://supercollider.github.io/download) for installation files.
- To install sc3nb you can
- install it locally in editable mode (i.e. changes to sc3nb code will automatically be "re-installed").
- clone the repository from https://github.com/interactive-sonification/sc3nb
- from inside the sc3nb directory run `pip install -e .`
- or install it directly from PyPI using `pip install sc3nb`
## Examples
We provide examples in the form of Jupyter notebooks. You see them executed in the User Guide section of the [documentation](https://interactive-sonification.github.io/sc3nb) and also download them from the [sc3nb examples folder](https://github.com/interactive-sonification/sc3nb/tree/master/examples).
## Publications & Citation
* A paper introducing sc3nb can be found at https://doi.org/10.1145/3478384.3478401
* The belonging supplementary material can be found at https://doi.org/10.4119/unibi/2956379
* The presentation of the paper can be found at https://www.youtube.com/watch?v=kuZZSNCS53E
If you use sc3nb please cite the sc3nb introduction paper https://doi.org/10.1145/3478384.3478401
Raw data
{
"_id": null,
"home_page": "https://github.com/interactive-sonification/sc3nb",
"name": "sc3nb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sonification,sound synthesis",
"author": "Thomas Hermann",
"author_email": "thermann@techfak.uni-bielefeld.de",
"download_url": "https://files.pythonhosted.org/packages/c6/c6/30dc00102c456f68dba43882e96277cba91e1b66846738707bf8d1aee69e/sc3nb-1.1.0.tar.gz",
"platform": null,
"description": "# sc3nb\n\nsc3nb is a python package that offers an interface to SuperCollider3 (SC3), with special support to be used within jupyter notebooks.\n\n* [Documentation](https://interactive-sonification.github.io/sc3nb)\n* [Source code](https://github.com/interactive-sonification/sc3nb)\n* [Bug reports](https://github.com/interactive-sonification/sc3nb/issues)\n\n\nThe goal of sc3nb is to facilitate the development of auditory displays and interactive sonifications by teaming up\n* python (and particularly numpy, scipy, pandas, matplotlib etc.) for data science\n* and SuperCollider3 for interactive real-time sound rendering.\n\u200b\n\nIt allows:\n* to interface with the SuperCollider audio server (scsynth) aswell as the SuperCollider Language and Interpreter (sclang) via the SC class\n* The SuperCollider audio server can be started and addressed via\n * OSC directly with OSC messages and bundles\n * Python implementations of Classes from SuperCollider like `Synth`, `SynthDef`, `Buffer` and `Bus`\n * the `Score` class for non-realtime synthesis\n* use the SuperCollider language (sclang) interactively via a subprocess.\n * write SuperCollider language code in Jupyter Notebooks and let sclang evaluate it.\n * inject Python variables into your sclang code\n * get the results of the sclang code in Python\n* helper functions such as linlin, cpsmidi, midicps, clip, ampdb, dbamp which work like their SC3 counterparts.\n\n\nsc3nb can be used for\n* multi-channel audio processing\n* auditory display and sonification\n* sound synthesis experiment\n* audio applications in general such as games or GUI-enhancements\n* signal analysis and plotting\n* computer music and just-in-time music control\n* any usecase that the SuperCollider 3 language supports\n\n\nIt is meant to grow into a backend for a sonification package, and can be used both from jupyter and in standard python software development.\n\n## Installation\n\n- To use sc3nb you need a installation of SuperCollider on your system. See [SuperCollider Download](https://supercollider.github.io/download) for installation files.\n- To install sc3nb you can\n - install it locally in editable mode (i.e. changes to sc3nb code will automatically be \"re-installed\").\n - clone the repository from https://github.com/interactive-sonification/sc3nb\n - from inside the sc3nb directory run `pip install -e .`\n - or install it directly from PyPI using `pip install sc3nb`\n\n## Examples\n\nWe provide examples in the form of Jupyter notebooks. You see them executed in the User Guide section of the [documentation](https://interactive-sonification.github.io/sc3nb) and also download them from the [sc3nb examples folder](https://github.com/interactive-sonification/sc3nb/tree/master/examples).\n\n## Publications & Citation\n\n* A paper introducing sc3nb can be found at https://doi.org/10.1145/3478384.3478401\n* The belonging supplementary material can be found at https://doi.org/10.4119/unibi/2956379\n* The presentation of the paper can be found at https://www.youtube.com/watch?v=kuZZSNCS53E\n\nIf you use sc3nb please cite the sc3nb introduction paper https://doi.org/10.1145/3478384.3478401\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SuperCollider3 (sc3) for Python and Jupyter notebooks",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/interactive-sonification/sc3nb/issues",
"Documentation": "https://interactive-sonification.github.io/sc3nb",
"Homepage": "https://github.com/interactive-sonification/sc3nb",
"Source Code": "https://github.com/interactive-sonification/sc3nb"
},
"split_keywords": [
"sonification",
"sound synthesis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "950d07cc3b8e26a3ae0c6432dd73a4d752601ac13356828497ed4c64627bc123",
"md5": "dd813e4f31383fec80ea0281c1a9f23d",
"sha256": "533cee102451e31776082a395d5e533e8965a6725ad4967827c69be9c401cd5a"
},
"downloads": -1,
"filename": "sc3nb-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd813e4f31383fec80ea0281c1a9f23d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 71946,
"upload_time": "2023-08-22T10:26:27",
"upload_time_iso_8601": "2023-08-22T10:26:27.859913Z",
"url": "https://files.pythonhosted.org/packages/95/0d/07cc3b8e26a3ae0c6432dd73a4d752601ac13356828497ed4c64627bc123/sc3nb-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6c630dc00102c456f68dba43882e96277cba91e1b66846738707bf8d1aee69e",
"md5": "cd2f70e20ccd4be259c49191fece0966",
"sha256": "83ccf05164bf5e6186990573702f4252bd2b762e5eb157dc106c3ff5ff4e931b"
},
"downloads": -1,
"filename": "sc3nb-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cd2f70e20ccd4be259c49191fece0966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 252548,
"upload_time": "2023-08-22T10:26:30",
"upload_time_iso_8601": "2023-08-22T10:26:30.095499Z",
"url": "https://files.pythonhosted.org/packages/c6/c6/30dc00102c456f68dba43882e96277cba91e1b66846738707bf8d1aee69e/sc3nb-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 10:26:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "interactive-sonification",
"github_project": "sc3nb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "sc3nb"
}
JSON
