Machinome Viewer

The browser viewer for the Machinome framework: inspect an assembly, operate its declared inputs, and watch its mechanical relationships work. The same viewer powers the development page, portable exports, custom embeds and headless snapshots.

Read the user manual · Installation · Embedding · API and CLI reference

Version 0.7.0 releases with Machinome 0.7.0 and is numbered with it. It declares viewer API 27 and reads document versions 1–13. The widget is not published on npm; it ships inside the Python distribution.

For makers

Machinome authors and builds the machine. The viewer opens its published document in a WebGL-capable browser, with camera, assembly navigation and the controls appropriate to a posed, running or clocked model. A reader of a static export needs no Python, Node.js or CAD installation.

Install it with the framework: pip install "machinome[viewer]". Built distributions carry the bundle and install without npm; the Python package needs Python 3.11+. To work on the viewer source, build the bundle first (Node.js 22+) and install the checkout into the same environment as the framework:

npm ci --prefix machinome_viewer/widget
npm run build --prefix machinome_viewer/widget
python -m pip install -e .
machinome-viewer describe

See the manual's installation guide before configuring snapshots or opening a project.

For embedding hosts

Serve the exported page in an iframe, or load machinome-viewer.js and call MachinomeViewer.mount(target, documentUrl, options). Use mountInspector() for a viewer with a collapsible assembly sidebar. The manual includes a working example and every public mount option and handle operation.

The process interface is machinome-viewer describe|serve|capture, also available as python -m machinome_viewer. The machinome.viewer entry point provides only the bundle lookup. The viewer does not import or depend on the framework; serving and capture are separate processes.

License and development

This package and its browser bundle are AGPL-3.0-or-later; the framework is Apache-2.0. Keep the bundle's source/license and dependency notices intact. See LICENSE and CHANGELOG.md.

User documentation lives in docs/. Build/hosting instructions and review evidence belong in workflow/; accepted decisions remain in workflow/adrs/, and the release-preparation record is workflow/release-0.7.md. OpenSpec requirements and changes remain in openspec/.

For a local manual preview, follow workflow/documentation.md. Tests use the committed exports under tests/fixtures/, without importing the framework. Run npm test --prefix machinome_viewer/widget, npm run typecheck --prefix machinome_viewer/widget and python -m pytest in an environment with the development dependencies. scripts/check-dist builds and smoke-tests distributions and uploads nothing.