Experimental features¶
These APIs are included in the stable package under inklet.experimental, but
you opt in to each one. Their signatures, report schemas and saved-file formats
may change between releases. See the
support and saved-file policy
before relying on a saved state format.
Still experimental in 4.4: linked browser documents (inklet.experimental.browser),
mesh and grid fields (fields, grid), engineering drawings (engineering),
image measurement (measurement) and the figure planner (figure_planner,
planner_geometry).
inklet.experimental.engineering will be removed in 5.0. From 4.4,
importing it raises a DeprecationWarning. BoxComponent and BoxAssembly
have no replacement. The linked engineering report example keeps working in
4.x; pin inklet<5 for recipes that depend on it. In the browser package,
BrowserScatter also warns: use BrowserFigure(table, views, columns=len(views)).
Graduated in 4.3, and covered by the stable compatibility policy:
| Now stable | Was | Guides |
|---|---|---|
inklet.volume |
inklet.experimental.volume, sections, slabs, regions, channels, contours, measurements, tiff |
Microscopy volumes |
inklet.selection |
inklet.experimental.selection |
Live data and categories, pandas and Polars inputs |
inklet.project |
inklet.experimental.project |
Figure projects |
inklet.editor |
inklet.experimental.layout_editor |
Local layout editor, Save layout choices |
The old paths still work and return the same objects, and from 4.4 they warn;
see migration. The compiled scene viewer runtime is
now private; open it with RenderScene.to_html() (figure viewer).
Interactive documents
Offline HTML pages whose plots share selections, filters and saved views, reconstructable in Python.