ipytone

Interactive audio in Jupyter, using Tone.js.

Note: This is still at a proof-of-concept stage.

Requirements

• JupyterLab >= 3.0 or Jupyter notebook.

Install

You can install ipytone either with pip or conda.

With pip

pip install ipytone
# Skip the next step if using JupyterLab or Classic notebook version 5.3 and above
jupyter nbextension enable --py --sys-prefix ipytone

With conda

conda install -c conda-forge ipytone

Contributing

Development install

Development installation requires NodeJS and yarn be installed. You can easily install it with conda:

conda install nodejs yarn -c conda-forge

Clone this repository, change directory to the ipytone directory and install the package in development mode:

python -m pip install -e .

# if you use jupyterlab, you can also install the pre-built extension
# in development mode and re-build the extension (see below):
jupyter labextension develop . --overwrite

Re-build the extension

After making changes to the typescript source code, you need to rebuild the extension:

yarn run build

# or if you use jupyterlab
yarn run build:lib
yarn run build:labextension:dev

You can then refresh the notebook or JupyterLab in the browser to test the changes.

If you change the Python source, you need to reload the Python kernel.