A JupyterLab extension for 3D geometry modeling.
- JupyterLab >= 3.0
To install the extension, execute:
pip install jupytercad
To remove the extension, execute:
pip uninstall jupytercad
Note: You will need NodeJS to build the extension package.
The jlpm
command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn
or npm
in lieu of jlpm
below.
# Clone the repo to your local environment
# Change directory to the jupytercad directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm run build
command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
JupyterCAD uses a custom build of Open Cascade WASM. For performance and data usage concern, we only build the symbols we need.
In the case where you need to add new symbols, you will need to add those symbols into the src/worker/opencascade/build.yml
file, then rebuild Open Cascade.
In order to rebuild it yourself, you will first need to pull the proper docker image (you only need to run this once and for all):
yarn run prepare:opencascade
Then you can rebuild Open Cascade, this may take some time without showing any progress:
yarn run build:opencascade && yarn run build
Then you can commit the output into the jupytercad repo.
Custom build doc: https://ocjs.org/docs/app-dev-workflow/custom-builds Custom build example: https://github.com/donalffons/opencascade.js/blob/master/website/ocjs-editor-theme/src/customBuild/customBuild.yml Where to find symbols: https://dev.opencascade.org/doc/refman/html/annotated.html
pip uninstall jupytercad
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list
to figure out where the labextensions
folder is located. Then you can remove the symlink named jupytercad
within that folder.
See RELEASE