Skip to main content

Jupyter kernel for OpenSCAD

Project description

OpenSCAD Kernel for Jupyter

I was missing a Jupyter Kernel for OpenSCAD. So I took up the challenge and here is the result.

Any regular text in a cell is added to the overall OpenSCAD code buffer. This allows you to build up an OpenSCAD model in multiple steps using Jupyter cells and document the design along the way.


  • Jupyter or Jupyterlab should have been installed
  • Please make sure that OpenSCAD has been installed on your system (e.g. with apt install openscad) and that it can be called on the command line:
openscad -v

diplays the version. E.g. 2019.12.20


pip install jupyter-openscad-kernel
python -m iopenscad.install

Installation from source

git clone
cd jupyter-openscad-kernel
pip install .
python -m iopenscad.install

Optional Steps

If you want to be able to display stl files you need to install a mime renderer for Jupyter. E.g

jupyter labextension install jupyterlab-viewer-3d

If you want to have syntax highlighting for OpenSCAD:

jupyter labextension install jupyterlab-openscad-syntax-highlighting

On linux, if you want to run openscad in a headless environment (e.g. Docker) you need to install xvfb

apt install -y xvfb

Now you can launch your kernel my calling

jupyter lab


jupyter workspace


  • 1.0 Initial Version
  • 1.0.1 Additional syntax checking; Publish to pypi
  • 1.0.13 Error corrections for parser and installer, support for %use
  • 1.0.14 Cleanup and corrections for spelling mistakes, Upgrade node and setuptools release in Dockerfile

Further Information

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

jupyter-openscad-kernel-1.0.14.tar.gz (24.8 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page