Jupyter SCAD: SCAD in Jupyter

Jupyter SCAD provides rendering and interactive visualization for 3D objects described in SolidPython2 within a Jupyter notebook. Additionally, it provides interactive visualization for STLs.

This program is focused on the use case of generating stl files with Python (aka SolidPython2) interactively within a Jupyter notebook.

Status: MATURE

This project has reached it's goal, a basic Jupyter notebook viewer for SolidPython2. Any further improvements are best served by just using the OpenSCAD GUI (see Alternatives below).

At this time, the only work that is planned for this project is bugfixes. If you are interested in continuing to add functionality, make an issue expressing your interest and we can discuss passing the baton.

Documentation

Documentation is hosted at https://jreiberkyle.github.io/jupyterscad/.

Quick Start

Jupyter SCAD can be installed with pip:

pip install jupyterscad

An OpenSCAD object can be defined using SolidPython2, viewed in a Jupyter notebook, and saved to an stl file with:

from jupyterscad import view
from solid2 import cube

view(cube([1.5,2,1],center=True), outfile='cube.stl')

render example

Alternatives

As an alternative to Jupyter SCAD, one could use a Jupyter notebook as an external editor, using SolidPython2 to update the SCAD file and OpenSCAD to visualize and render the SCAD file. The benefit to this approach is that one can visualize the preview. The drawback is that the two-program workflow can feel distracting. See more on using external editors for OpenSCAD here.

Or, one can use ViewSCAD, which was the motivation for this project. However the last time ViewSCAD was updated was 2019 (checked on 9/21/2023). It only supports SolidPython, not SolidPython2.

Transitioning from ViewSCAD

This package was inspired by ViewSCAD and therefore maintains a very similar interface.

To transition from ViewSCAD, replace

import viewscad

r = viewscad.Renderer()
r.render(obj)

with

from jupyterscad import view

view(obj)

Visualization Backend

This package uses pythreejs for visualization.

Alternatives considered, ordered from closest fit to farthest:

pyvolume: provides mesh visualization and interaction but (as of 2023.09.24) the latest release is alpha and documentation is sparse.
matplotlib mplot3d: provides mesh visualization and interaction but is slow.
pyvista: provides stl loading and visualization but visualization does not work in docker image.

Acknowledgements

Thanks to nickc92 for creating ViewSCAD, which is the inspiration for this project.

jreiberkyle / jupyterscad

readme