cad-viewer-widget

A Jupyter widget to view CAD objects

cad-viewer-widgets has its origin in Jupyter-CadQuery, which now has been split into 3 layers. This repo being the middle layer:

1. three-cad-viewer This is the complete CAD viewer written in Javascript with threejs being the only dependency.

2. cad-view-widget (this repository) A thin layer on top of cad-viewer-widget that wraps the CAD viewer into an ipywidget. The API documentation can be found here

3. Jupyter-CadQuery A CadQuery viewer, collecting and tessellating CadQuery objects, using cad-view-widget to visualize the objects

Click on the "launch binder" icon to start cad-viewer-widget on binder:

Examples

• Tests and demos: Demonstrating the features using the sample tesssellations in ./examples
• Classic OCC Bottle: A real CAD example based on python-occ

Installation

To install use pip:

$ pip install cad_viewer_widget

For a development installation (requires Node.js and Yarn version 1),

$ git clone https://github.com/bernhard-42/cad-viewer-widget.git
$ cd cad-viewer-widget
$ pip install -e . 
$ jupyter labextension develop . --overwrite 

When actively developing your extension for JupyterLab, run the command:

$ jupyter labextension develop --overwrite cad_viewer_widget

Then you need to rebuild the JS when you make a code change:

$ cd js
$ yarn run build

You then need to refresh the JupyterLab page when your javascript changes.

Build step

hatch build

Changes

2023-08-14

• Adapt to ocp-tessellate
• Support version 1.8.6 of three-cad-viewer
• Supports jupyterlab>=4, ipywidgets>=8 and notebook>7
• Dropped support for notebook < 7.0
• Build process now uses pyproject.toml and hatch

2023-01-03

• Added pyparsing as dependency
• Pinned traitlets to ~5.8
• Upgraded bottle example to occt 7.6.2