CHANGELOG.md

JupyterCAD Changelog

1.0.0 - Highlights

Below are the major highlights in JupyterCAD 1.0.0

New packaging system

From 1.0.0, JupyterCAD is split into multiple python and javascript packages, this makes deploying and extending JupyterCAD easier.

• New python packages:
  • jupytercad-core: package contains core plugins for worker registry, jcad file support, document tracker, and annotation
  • jupytercad-lab: package contains plugins for lab interface and notebook support
  • jupytercad-app: the standalone JupyterCAD application
• New js packages:
  • @jupytercad/schema: package contains the schema of the JCAD file and related models/interfaces
  • @jupytercad/opencascade: the custom opencascade.js build for JupyterCAD
  • @jupytercad/occ-worker: the opencascade worker of JupyterCAD.
  • @jupytercad/base: package contains the UI components.

The current jupytercad PYPI package is still available, but it has become a meta-package to facilitate the installation of the application. Users can continue to install JupyterCAD with

pip install jupytercad

New extension system

JupyterCAD now provides multiple tokens to allow extending its features by using the JupyterLab extension system. Users can register new file formats, register new operators, or add more post-processing capabilities to the application.

By using the new system, FreeCAD file format is supported through an extension of JupyterCAD, users can install it with

pip install jupytercad-freecad

New supported file format

JupyterCAD now can render the geometries of a STEP file. More improvement in the interoperability of the STEP file will be added in future versions.

3.0.0a2

(Full Changelog)

Enhancements made

• Add jcad icon in the launcher #428 (@martinRenou)
• Use SharedModelFactory to create shared model #425 (@davidbrochart)

Bugs fixed

• Fix python api #422 (@trungleduc)

Maintenance and upkeep improvements

• Add link to playwright report in PR #430 (@trungleduc)
• Bump jupyter-collaboration v3 #429 (@davidbrochart)
• Fix metadata #424 (@davidbrochart)

Documentation improvements

• Remove non-relevant steps #421 (@arjxn-py)

Other merged PRs

• Correct artifact output #432 (@trungleduc)
• Save artifact data on failure #431 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@arjxn-py | @davidbrochart | @github-actions | @martinRenou | @trungleduc

3.0.0a1

(Full Changelog)

Maintenance and upkeep improvements

• Fix dependencies pinning #420 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

3.0.0a0

(Full Changelog)

Enhancements made

• Remove unneeded jupytercad_lab dependencies #417 (@martinRenou)
• Smart color handling for edges based upon mesh luminance #412 (@arjxn-py)
• Add Color Customization for JupyterCAD Models #397 (@arjxn-py)
• Enable Damping for Smoother Model Movement #395 (@arjxn-py)
• Add python console to 3D view #392 (@trungleduc)
• Enable Toggling Wireframe View #390 (@arjxn-py)
• Position & Axis inputs in a row #389 (@arjxn-py)
• Delete Object Keyboard Shortcut #388 (@arjxn-py)
• Improve shape metadata update logic #385 (@trungleduc)
• Implement Undo & Redo keyboard shortcuts #382 (@arjxn-py)

Bugs fixed

• Fix jupyterlite deployment #409 (@trungleduc)
• Little darker shade of color for edges #408 (@arjxn-py)
• Replace toggle wireframe button to the right #405 (@arjxn-py)
• Fix python console in the standalone app #402 (@trungleduc)
• Delete parent object if edge is selected with [Delete] key binding #393 (@arjxn-py)

Maintenance and upkeep improvements

• Try fixing the upload of Github pages #416 (@martinRenou)
• Exclude node_modules from sdists #415 (@martinRenou)
• Update yjs-widgets dependency + make it shared #414 (@martinRenou)
• Remove the guidata option #413 (@arjxn-py)
• Save jupyterlite build artifact #404 (@trungleduc)
• Preview PR using appsharing.space #403 (@trungleduc)
• Try fixing bot to update snapshots #401 (@arjxn-py)
• Fix bot to update snapshots #400 (@arjxn-py)
• Fix bot behaviour to update snapshots #398 (@arjxn-py)
• Bump ypywidgets v0.9 #387 (@davidbrochart)
• #78 Re-enable jupyterlab.browser_check #386 (@arjxn-py)
• Fix code format #383 (@trungleduc)

Documentation improvements

• Contributing Guide in .rst #381 (@arjxn-py)

Contributors to this release

(GitHub contributors page for this release)

@arjxn-py | @davidbrochart | @github-actions | @martinRenou | @pre-commit-ci | @SylvainCorlay | @trungleduc

2.0.2

(Full Changelog)

Bugs fixed

• Pin reacttrs #380 (@martinRenou)

Documentation improvements

• Update Contributing Guide for Development Installation #379 (@arjxn-py)

Contributors to this release

(GitHub contributors page for this release)

@arjxn-py | @github-actions | @martinRenou

2.0.1

(Full Changelog)

Bugs fixed

• Fix rendering stl and step files #377 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @trungleduc

2.0.0 Highlights

(Full Changelog)

Enhancements made

• Edge operators #340 (@martinRenou)
• Implement clipping #333 (@martinRenou)
• Support JupyterLite #331 (@trungleduc)
• Support for opening STL files #246 (@martinRenou)
• Step file export to .jcad #238 (@martinRenou)
• Improve post-processing system #350 (@trungleduc)
• Error handling #349 (@martinRenou)
• Add constraints to form schema #362 (@trungleduc)
• Generate dropdowns for operands on operator properties #371 (@martinRenou)
• Improve deletion behavior #369 (@martinRenou)

Maintenance and upkeep improvements

• Remove y-py #329 (@trungleduc)
• Jupyter Collaboration v2 #239 (@martinRenou)

Bugs fixed

• Fix build shape from brep string #334 (@trungleduc)

2.0.0rc0

(Full Changelog)

Maintenance and upkeep improvements

• Sync jupytercad_* version #375 (@trungleduc)
• Unpin ajv #374 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

2.0.0a10

(Full Changelog)

Enhancements made

• Generate dropdowns for operands on operator properties #371 (@martinRenou)
• Improve deletion behavior #369 (@martinRenou)
• Add constraints to form schema #362 (@trungleduc)

Bugs fixed

• Workaround extruction non-solid issue #373 (@martinRenou)
• Fix extrusion form defaults #368 (@martinRenou)
• Fix dry-run logic so that it does not run on the first load of the file #366 (@martinRenou)

Maintenance and upkeep improvements

• Update github URL #365 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @SylvainCorlay | @trungleduc

2.0.0a9

(Full Changelog)

Enhancements made

• Error handling #349 (@martinRenou)

Bugs fixed

• Notebook API: Fix remove method #359 (@martinRenou)

Maintenance and upkeep improvements

• Pin ajv #360 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @pre-commit-ci | @trungleduc

2.0.0a8

(Full Changelog)

Enhancements made

• Update jcad exporting mechanism #355 (@trungleduc)

Bugs fixed

• Fix wrong emitter id of select object action #354 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @trungleduc

2.0.0a7

(Full Changelog)

Enhancements made

• Update 3D rendering logic #353 (@trungleduc)

Bugs fixed

• Update 3D rendering logic #353 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @trungleduc

2.0.0a6

(Full Changelog)

Bugs fixed

• Add await for postShape before sending #351 (@gjmooney)

Contributors to this release

(GitHub contributors page for this release)

@gjmooney

2.0.0a5

(Full Changelog)

Enhancements made

• Improve post-processing system #350 (@trungleduc)
• Wider edge operators support #348 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

2.0.0a4

No merged PRs

2.0.0a3

(Full Changelog)

Enhancements made

• Add chamfer and fillet icons #342 (@IsabelParedes)
• Edge operators #340 (@martinRenou)
• Implement clipping #333 (@martinRenou)

Bugs fixed

• Update svg files #338 (@trungleduc)
• Fix build shape from brep string #334 (@trungleduc)

Maintenance and upkeep improvements

• Visual regression tests: Increase cell execution timeout #347 (@trungleduc)
• Refactor 3D view #341 (@trungleduc)
• Close warning before starting the UI test #336 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @IsabelParedes | @martinRenou | @trungleduc

2.0.0a2

(Full Changelog)

Enhancements made

• Update JupyterLite config #332 (@trungleduc)
• Support JupyterLite #331 (@trungleduc)
• Update occ API #330 (@trungleduc)
• Support for opening STL files #246 (@martinRenou)

Maintenance and upkeep improvements

• Remove y-py #329 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

2.0.0a1

(Full Changelog)

Enhancements made

• Step file export to .jcad #238 (@martinRenou)

Maintenance and upkeep improvements

• Unpin jupyterlab in ui-tests #251 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @pre-commit-ci | @trungleduc

2.0.0a0

(Full Changelog)

Maintenance and upkeep improvements

• Jupyter Collaboration v2 #239 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

1.0.1

(Full Changelog)

Bugs fixed

• Pin JupyterLab in publish release #254 (@martinRenou)
• Expose CadDocument from jupytercad #252 (@martinRenou)

Maintenance and upkeep improvements

• Missing util #255 (@martinRenou)
• Fixing check-release workflow + Fix regression tests #250 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou

1.0.0

(Full Changelog)

Enhancements made

• Don't show properties panel for readonly files #245 (@martinRenou)

Documentation improvements

• Add changelog #247 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

1.0.0a4

(Full Changelog)

Enhancements made

• Support loading STL binary format #244 (@trungleduc)

Maintenance and upkeep improvements

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @pre-commit-ci | @trungleduc

1.0.0a3

(Full Changelog)

Enhancements made

• Non-editable step file #235 (@martinRenou)
• Update worker and 3D viewer #230 (@trungleduc)

Bugs fixed

• Fix object selection #242 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

1.0.0a2

(Full Changelog)

Enhancements made

• STEP files support #232 (@martinRenou)

Maintenance and upkeep improvements

• Galata bot: Missing hub command #233 (@martinRenou)
• Fix missing dev dependency #231 (@martinRenou)

Other merged PRs

• Galata bot: Fix conda env #234 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @pre-commit-ci | @trungleduc

1.0.0a1

(Full Changelog)

Maintenance and upkeep improvements

• Rename packages #228 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@trungleduc

1.0.0a0

(Full Changelog)

Enhancements made

• Organization rename #225 (@martinRenou)
• Update OCC build #221 (@martinRenou)
• Create jupytercad-* packages #220 (@trungleduc)

Bugs fixed

• Pin pydantic (again) #222 (@martinRenou)

Maintenance and upkeep improvements

• Update release script #227 (@trungleduc)
• Fix CI #226 (@trungleduc)
• Create jupytercad-* packages #220 (@trungleduc)
• Update links to repository #219 (@martinRenou)
• Support pydantic 2 #213 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @pre-commit-ci | @trungleduc

0.3.3

(Full Changelog)

Enhancements made

• Allow changing camera settings #204 (@martinRenou)

Maintenance and upkeep improvements

• Fix check release #205 (@martinRenou)

Documentation improvements

• Add conda instructions #202 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

0.3.2

(Full Changelog)

Bugs fixed

• Remove guidata when deleting an object #201 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.3.1

(Full Changelog)

Bugs fixed

• Add yjs-widgets to the shared scope #199 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@trungleduc

0.3.0

(Full Changelog)

Enhancements made

• Add annotation and color API #198 (@trungleduc)
• Update to latest ypywidgets #194 (@martinRenou)
• Compute shape properties #193 (@trungleduc)
• Add Jupyverse plugin #179 (@davidbrochart)

Bugs fixed

• Fix fuse and intersection operator #197 (@trungleduc)
• Hide FreeCAD import message #187 (@trungleduc)

Maintenance and upkeep improvements

• Remove mock setting in Galata tests #188 (@trungleduc)

Documentation improvements

• Add docs link in the README #190 (@martinRenou)
• Add some documentation #169 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @martinRenou | @pre-commit-ci | @trungleduc

0.2.3

(Full Changelog)

Bugs fixed

• Missing dependencies #184 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@martinRenou

0.2.2

(Full Changelog)

Bugs fixed

• Update shared scope #182 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@trungleduc

0.2.1

(Full Changelog)

Bugs fixed

• Fix missing static files in cad app #181 (@trungleduc)
• NPM Package version fix #173 (@martinRenou)

Maintenance and upkeep improvements

• Simplify bump version script #178 (@martinRenou)
• Fix file paths in Notebook.ipynb #176 (@davidbrochart)
• Add releaser action and pre-commit config #172 (@trungleduc)

Documentation improvements

• Add docstrings #177 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @martinRenou | @trungleduc

0.2.0

(Full Changelog)

Enhancements made

• Add backend installation check #168 (@trungleduc)
• Improve cache mechanism #164 (@trungleduc)
• Add shadow to annotation boxes #163 (@trungleduc)
• Python API #162 (@martinRenou)
• Remove shadowmapping #159 (@martinRenou)
• Improve lighting #158 (@trungleduc)
• Remove gradient background #150 (@martinRenou)
• Multi selection #145 (@martinRenou)
• Add top menu and launcher #140 (@trungleduc)

Bugs fixed

• Fixup visibility checking #161 (@martinRenou)
• Fix Notebook API view #160 (@martinRenou)
• Fix: prevent selecting invisible mesh #155 (@martinRenou)
• Fix broken SVG #153 (@martinRenou)

Maintenance and upkeep improvements

• Install python-occ core on galata bot #167 (@martinRenou)
• Update jupyter_collaboration dependency #166 (@martinRenou)
• Fix galata bot #152 (@martinRenou)
• Install jupyter_collaboration on the Galata bot #165 (@martinRenou)

Documentation improvements

• Update screenshot #156 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

0.1.0

No merged PRs

0.1.0rc0

No merged PRs

0.1.0b0

(Full Changelog)

Enhancements made

• Update to JupyterLab 4 #147 (@martinRenou)
• Simplify annotations update #146 (@martinRenou)
• Update annotations position on resize #143 (@martinRenou)
• Default shape/operator names #141 (@martinRenou)
• Lab app #135 (@trungleduc)
• Toolbar refactor and styling #129 (@martinRenou)

Bugs fixed

• Update annotations position on resize #143 (@martinRenou)

Maintenance and upkeep improvements

• Update to JupyterLab 4 #147 (@martinRenou)
• Create monorepo #133 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

0.1.0a2

(Full Changelog)

Enhancements made

• Hide source objects after executing operators #117 (@trungleduc)
• Expose JupyterCad 3d view and APIs in notebook #102 (@trungleduc)

Maintenance and upkeep improvements

• Update to JupyterLab beta 2 #130 (@trungleduc)
• Update to JupyterLab beta 0 #119 (@martinRenou)

Contributors to this release

(GitHub contributors page for this release)

@github-actions | @martinRenou | @trungleduc

0.1.0a1

(Full Changelog)

Enhancements made

• Exploded view #109 (@martinRenou)
• Add launcher buttons #108 (@hbcarlos)
• Only compute the bounding box of the visible objects for the reflength #105 (@martinRenou)
• Improve performance #104 (@martinRenou)
• Add extrusion #98 (@trungleduc)
• Toolbar for configuring the grid and axes #94 (@hbcarlos)
• FCstd color support #91 (@martinRenou)
• Automatically remove annotations when they are empty #86 (@martinRenou)
• Annotations: Change remove button to a close button #84 (@martinRenou)
• Update build occ command #80 (@trungleduc)
• 2D Editor #76 (@trungleduc)
• Use theme for the annotation styling #62 (@martinRenou)
• Take into account the current user for message displaying #61 (@martinRenou)
• Support for undo/redo #60 (@hbcarlos)
• Decouple camera from remote user camera #59 (@martinRenou)
• Automatically rebuild open cascade when needed #56 (@martinRenou)
• Build OpenCascade when building the Worker #54 (@martinRenou)
• Custom Open Cascade build #40 (@martinRenou)
• Follow mode #32 (@trungleduc)
• Display and sync pointers between clients #29 (@martinRenou)
• Render unsupported shape types in read-only mode. #28 (@trungleduc)
• Highlight differently the mesh that is hovered AND selected #27 (@martinRenou)

Bugs fixed

• Cleanup selection logic and throttle some events #107 (@martinRenou)
• Fix bot for updating galata references #106 (@martinRenou)
• Fixes selections #103 (@hbcarlos)
• Toolbar for configuring the grid and axes #94 (@hbcarlos)
• Remove malformed form button #88 (@martinRenou)
• Do not reset the grid and axe when the scene is empty #83 (@hbcarlos)
• Hot fix occ build #81 (@trungleduc)
• Fix intersection name #57 (@martinRenou)
• Pointer color fix #39 (@martinRenou)
• Fix minor pointer issues. #30 (@trungleduc)
• Handle de-select when selecting a non-visible object #26 (@martinRenou)

Maintenance and upkeep improvements

• Remove pip install -e . step in the check release workflow #116 (@jtpio)
• Pin JupyterLab #115 (@martinRenou)
• Prepare for release #114 (@martinRenou)
• Pin JupyterLab #113 (@martinRenou)
• Fix ci #97 (@trungleduc)
• Add galata bot #96 (@trungleduc)
• Uses hatch and update releaser #90 (@hbcarlos)
• Fix binder #87 (@trungleduc)
• Introduce jupytercad-opencascade separate package #85 (@martinRenou)
• Add UI tests #73 (@trungleduc)

Documentation improvements

• Update README #112 (@martinRenou)
• Update readme #111 (@trungleduc)

Other merged PRs

• Fix CI #77 (@trungleduc)
• Fixes objects tree view #75 (@hbcarlos)
• Annotations panel #74 (@martinRenou)
• Fixes 51 #72 (@hbcarlos)
• Fixes iterable #71 (@hbcarlos)
• Types the API and hides Y data structures #68 (@hbcarlos)
• Migrate to @jupyter/ydoc and fix observe #67 (@hbcarlos)
• Remove "getCoordinate" from the Annotation Model #65 (@martinRenou)
• Fix: reset state when unfollowing #58 (@martinRenou)
• Add intersection operator #55 (@davidbrochart)
• Add fuse operator #53 (@davidbrochart)
• Prevent updating refLength on each remove/hide #52 (@martinRenou)
• Put back logic for syncing pointers #42 (@martinRenou)
• Fix missing FS and symbol #41 (@martinRenou)
• Add annotation #33 (@trungleduc)
• add conda-forge/label/jupyterlab_alpha for binder #25 (@bollwyvl)
• Mesh selection #24 (@trungleduc)
• Update tree view #23 (@trungleduc)
• Add @jupyterlab/shared-models to the package.json #22 (@jtpio)
• Revert "Use THREE.LineSegments instead of THREE.Line for edges" #19 (@martinRenou)
• Use rjsf's JupyterLab theme #18 (@martinRenou)
• Add Torus #15 (@martinRenou)
• Add Sphere and Cone primitives #14 (@martinRenou)
• Improve theme handling 3D view and tree view #10 (@martinRenou)
• Use THREE.LineSegments instead of THREE.Line for edges #9 (@martinRenou)
• Implement highlight on hover using a Color Picking technique #8 (@martinRenou)
• Fix invisible logo for dark theme #6 (@martinRenou)
• Support boolean operator #5 (@trungleduc)
• Add support for FreeCAD native file format #4 (@trungleduc)
• Add JCAD file #3 (@trungleduc)
• Add shared model #2 (@trungleduc)
• Add dark background and loading animation #1 (@trungleduc)

Contributors to this release

(GitHub contributors page for this release)

@bollwyvl | @davidbrochart | @github-actions | @hbcarlos | @jtpio | @martinRenou | @trungleduc