Create Notebooks with Interactive Figures
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
dspnote
example
.gitignore
readme.md
setup.py

readme.md

DSPnote: Create Notebooks with Interactive Figures

DSPnote is a static site generator specialized in creating notebooks with interactive figures. It's mostly implemented as an extension to python-markdown. It currently supports the following types of figures:

  • SporthDiagram: an audio processing block diagram, accompanied by a user-defined Sporth script that can be run in-browser, and parameter sliders to control the script.

  • Image: an image with a caption.

Installing and Using

For development installation, clone or extract the dspnote repository, and run this in the resulting folder:

pip3 install -e .

This installs the tool dspnote-gen, which takes a single argument: a directory containing a dspnote project.

dspnote-gen example

To create a project, copy the example folder and modify it.

Prior Art