inklet 4.0.0.dev2__tar.gz → 4.0.0.dev4__tar.gz

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/.github/workflows/checks.yml

@@ -70,6 +70,7 @@ jobs:
           .venv/bin/python examples/v4/time_series.py --output out/v4-time
           .venv/bin/python examples/v4/statistical_views.py --output out/v4-statistics
           .venv/bin/python examples/v4/regional_report.py --render --output out/v4-regional-report
+          .venv/bin/python examples/v4/regional_report.py --renderer compiled --editor --render --output out/v4-compiled-regional
           .venv/bin/python examples/v4/engineering_report.py --render --output out/v4-engineering
           .venv/bin/python examples/v4/scientific_report.py --render --output out/v4-scientific
           .venv/bin/python examples/v4/mesh_fields.py --render --output out/v4-mesh-fields
@@ -95,6 +96,10 @@ jobs:
           .venv/bin/python examples/compositing_review.py --output out/compositing-review
           .venv/bin/python examples/hatch_review.py --output out/hatch-review
           .venv/bin/python examples/clipping_review.py --output out/clipping-review
+          .venv/bin/python examples/render_scene_review.py --output out/render-scene-review
+          .venv/bin/python examples/dense_scatter_review.py --output out/dense-scatter-review
+          .venv/bin/python examples/compiled_marker_shapes.py --output out/compiled-marker-shapes
+          .venv/bin/python examples/compiled_scene_viewer.py --output out/compiled-scene-viewer
       - name: Diagram routing and label review
         run: |
           .venv/bin/python tools/benchmark_diagrams.py --repeat 1 --output out/diagram-benchmark.json

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/.github/workflows/publish.yml

@@ -6,7 +6,7 @@ on:
       tag:
         description: Published GitHub release tag
         required: true
-        default: v4.0.0.dev2
+        default: v4.0.0.dev4
         type: string
       dry_run:
         description: Validate release files without uploading to PyPI
@@ -43,7 +43,7 @@ jobs:
           RELEASE_TAG: ${{ inputs.tag }}
         run: |
           [[ "$RELEASE_TAG" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(\.dev[0-9]+)?$ ]] || {
-            echo 'Expected a stable or development tag such as v3.1.0 or v4.0.0.dev2' >&2
+            echo 'Expected a stable or development tag such as v3.1.0 or v4.0.0.dev4' >&2
             exit 1
           }
           gh release view "$RELEASE_TAG" --json isDraft,isPrerelease > "$RUNNER_TEMP/release.json"

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/CHANGELOG.md

@@ -1,5 +1,124 @@
 # Changelog
 
+## Unreleased
+
+## 4.0.0.dev4 — 2026-09-12
+
+Fourth development preview: correct closed polar geometry and make the plot
+documentation visual and easier to navigate. 3.1.0 remains stable.
+
+- Fix closed polar curves retracing the angular range and shaded bands crossing
+  themselves. Complete the closing arc in sample order and retain both band
+  endpoints; refresh polar previews and cover angular units and winding directions.
+
+- Reorganize documentation around plotting, interactive documents and microscopy.
+  Add a searchable visual plot gallery and six guides with 22 rendered, runnable
+  examples; check plot-family coverage, gallery links and guide execution.
+
+## 4.0.0.dev3 — 2026-09-12
+
+Third development preview: shared scene execution, dense marker rendering,
+linked compiled reports and the first reproducible plot-style editor. Install
+explicitly with `python -m pip install "inklet==4.0.0.dev3"`; 3.1.0 remains stable.
+
+- Add an offline inspector for named plot colours, marker radii and line widths,
+  with bounded undo/redo and separate versioned overrides. Preserve compatible
+  choices across source revisions and page widths; reject or explicitly report
+  orphaned targets. Reproduce edited views through Python SVG/PDF/PNG exports.
+- Prepare style commands atomically, preserve selection and view state, and
+  prevent file/command/revision races. Add edited full-report visual comparisons,
+  failure cases, browser/Python agreement and installed-wheel checks.
+
+- Add opt-in compiled execution to linked browser figures, preserving keyed
+  selection, filtering, saved states, revision policies and vector exports.
+  Pack contiguous circle runs without reordering paint, retain native SVG for
+  other marks, and intersect visibility masks with spatial candidates.
+- Share the compiled viewer runtime with the linked report instead of duplicating
+  GPU execution. Retain immutable records during filtering and release surfaces
+  on revision replacement. Add a runnable regional report mode, complete-figure
+  display comparisons and state/revision/export regressions across backends.
+
+- Build ordered marker candidates with a reusable bitmap instead of temporary
+  JavaScript result arrays and comparison sorting. Accept fully contained grid
+  cells without rechecking each footprint, preserving source paint order and
+  independently owned result arrays.
+- Measure 250,000- and million-point index queries and browser submission.
+  The million-point zoom query falls from 5.253 to 0.629 ms in the standalone
+  study; tiny queries are slightly slower. Retained bitmap storage adds one bit
+  per row. Add word-boundary and query-result ownership regressions.
+
+- Cull individual packed markers with a shared spatial index of full marker
+  footprints. Preserve source order, antialiasing margins and vector exports.
+  Canvas paints candidates; WebGL2 fetches immutable records using compact
+  row-index uploads. Report candidate counts, uploads and index storage.
+- Add a 250,000-point stress recipe, brute-force and visual fidelity checks,
+  and separate submission/GPU timer studies. Canvas window submission improves
+  from 88.5 to 10.8 ms in the recorded workload; GPU draw time falls from 0.325
+  to 0.042 ms while CPU submission rises from 0.9 to 2.2 ms. Document memory costs.
+
+- Size compiled-viewer surfaces around the visible region with a retained pan
+  margin; skip painting offscreen layers and reuse their immutable buffers on
+  return. Preserve native clipping, marker order and complete vector export.
+- Keep deep-zoom resolution within the existing per-surface pixel limits. In
+  the five-panel RTX 5090 study, 8× zoom uses about 3.05 million backing pixels
+  instead of 20 million, and median WebGL submission falls from 49.0 to 13.8 ms.
+  Add normal/deep-zoom fidelity, visibility and re-entry checks with raw studies.
+
+- Retain compiled-viewer backing surfaces across pans and small zoom changes,
+  repaint only when resolution changes, and shrink after large zoom-outs.
+  Read all SVG transforms before changing canvas dimensions. Preserve the
+  existing pixel budgets, native compositing, vector export and error fallback.
+- Report surface paints, resizes, reuse and allocated pixel counts. Add hardware
+  before/after profiles and regressions for reuse, resolution growth, shrinking
+  and context loss. Warm small-zoom submission falls from 47.8 ms to 0.5 ms in
+  the measured five-panel RTX 5090 workload; startup and growth are excluded.
+
+- Accelerate filled square, triangle, diamond and star marker batches in the
+  compiled-scene viewer. Preserve exact polygon geometry, per-point sizes and
+  colours, winding rules, paint order, clipping and vector SVG download.
+- Add a five-panel interactive marker comparison and test complete composited
+  screenshots against SVG at two display resolutions, including concave
+  polygons. Self-intersections, open, outlined and curved markers stay native.
+- Validate the five-panel viewer on an RTX 5090 Laptop GPU through WSL/D3D12.
+  Publish timings and display comparisons; Canvas remains faster for this
+  measured workload, so hardware availability is not presented as a speedup.
+
+- Add `RenderScene.to_html()` for offline native-scene viewing, with instanced
+  WebGL2 circle layers, Canvas fallback and native SVG artwork in paint order.
+  Automatic selection avoids recognized software WebGL renderers. Report
+  backend decisions, context loss, display limits and buffer uploads.
+- Keep packed source buffers shared and immutable across browser view changes;
+  reconstruct vector SVG from 64-bit records, including exact source indices.
+- Add a complete interactive figure, shader/fallback/resource tests and native
+  export comparisons. Keyed-row interaction migration and broader GPU geometry
+  remain open; hardware performance is not inferred from software WebGL tests.
+
+- Store dense vector scatter in immutable 36-byte marker records, preserving
+  source order, per-point size/colour, physical strokes and native vector output.
+  Series with at least 256 points use batches unless placement anchors or
+  broken axes require individual nodes. Dense point handles become batch
+  handles; source indices remain inspectable in buffers and SVG elements.
+- Stream batches through SVG/PDF with bounded prototype caches, preserve
+  geometric clipping and painted windows, and retain batch geometry on revisions.
+- Check packed palettes against colour keys and inspect individual marker
+  footprints for text overlaps, avoiding false collisions over empty cloud space.
+- Add a 38,300-marker four-panel review, native-backend fidelity tests and
+  reproducible construction/export/memory measurements, including a separate
+  million-point construction test.
+
+- Compile a shared native render scene for SVG, PDF and PNG, resolving styles,
+  transforms, clipping and compositing once. Retain it across document exports.
+- Reuse unchanged scene nodes and geometry across revisions; share small shapes
+  and shaped labels by value, expose invalidation reasons and conservative
+  redraw coverage, and report render-compilation work separately from layout.
+- Reject missing image and font resources before native export; SVG no longer
+  silently emits broken image links or substitutes an unavailable font file.
+- Snapshot file-backed image bytes so completed figures survive source changes;
+  detect updated image inputs on subsequent document compilation and reject
+  exports using changed or missing font files.
+- Add a complete six-panel scene/revision review and repeated-export benchmarks.
+  Browser/GPU execution and finer layout invalidation remain open.
+
 ## 4.0.0.dev2 — 2026-09-08
 
 Second development preview. Install explicitly with

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: inklet
-Version: 4.0.0.dev2
+Version: 4.0.0.dev4
 Summary: Scientific figures with live data, measured layout, and consistent vector exports.
 Project-URL: Repository, https://github.com/Mapika/inklet
 Project-URL: Documentation, https://inklet.readthedocs.io/en/latest/
@@ -81,19 +81,16 @@ their signatures and report schemas may change.
 
 ## 4.0 development preview
 
-**4.0.0.dev2** adds curve-preserving clipping, painted windows, improved PDF
-compositing and hatching, alongside offline linked charts, maps, calibrated images, mesh fields,
-contours and streamlines, with saved selections and reproducible exports.
-It also includes date/UTC axes, facets, pandas/Polars adapters and shared
-plotting-quality improvements.
-
+**4.0.0.dev4** fixes closed polar curves and shaded bands, and adds a visual
+plot gallery with 22 runnable examples. It retains shared compiled rendering,
+offline viewing, linked reports, and reproducible plot editing with undo/redo.
 ```sh
-python -m pip install "inklet==4.0.0.dev2"
+python -m pip install "inklet==4.0.0.dev4"
 ```
 
 [Preview guide and examples](https://inklet.readthedocs.io/en/latest/development-preview/) ·
 [4.0 roadmap](https://inklet.readthedocs.io/en/latest/roadmap/) ·
-[Release notes](https://github.com/Mapika/inklet/releases/tag/v4.0.0.dev2)
+[Release notes](https://github.com/Mapika/inklet/releases/tag/v4.0.0.dev4)
 
 This is an opt-in development release. Experimental APIs and saved-state schemas
 may change; 3.1.0 remains the stable release. General browser editing,

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/README.md

@@ -31,19 +31,16 @@ their signatures and report schemas may change.
 
 ## 4.0 development preview
 
-**4.0.0.dev2** adds curve-preserving clipping, painted windows, improved PDF
-compositing and hatching, alongside offline linked charts, maps, calibrated images, mesh fields,
-contours and streamlines, with saved selections and reproducible exports.
-It also includes date/UTC axes, facets, pandas/Polars adapters and shared
-plotting-quality improvements.
-
+**4.0.0.dev4** fixes closed polar curves and shaded bands, and adds a visual
+plot gallery with 22 runnable examples. It retains shared compiled rendering,
+offline viewing, linked reports, and reproducible plot editing with undo/redo.
 ```sh
-python -m pip install "inklet==4.0.0.dev2"
+python -m pip install "inklet==4.0.0.dev4"
 ```
 
 [Preview guide and examples](https://inklet.readthedocs.io/en/latest/development-preview/) ·
 [4.0 roadmap](https://inklet.readthedocs.io/en/latest/roadmap/) ·
-[Release notes](https://github.com/Mapika/inklet/releases/tag/v4.0.0.dev2)
+[Release notes](https://github.com/Mapika/inklet/releases/tag/v4.0.0.dev4)
 
 This is an opt-in development release. Experimental APIs and saved-state schemas
 may change; 3.1.0 remains the stable release. General browser editing,

{inklet-4.0.0.dev2 → inklet-4.0.0.dev4}/docs/api.md

@@ -18,6 +18,23 @@ took before layout still resolves inside the finished figure.
 
 Declared format support; no renderer is selected implicitly.
 
+#### `class RenderScene(root: 'SceneNode', bbox: 'Rect', stats: 'Mapping', changes: 'tuple[SceneChange, ...]', _nodes: 'Mapping', _resources: 'Mapping', _images: 'Mapping', _fonts: 'Mapping') -> None`
+
+A compiled native scene shared by SVG, PDF and PNG exports.
+
+* `walk()`
+* `validate_fonts()`
+* `sources_current()` -- Check external inputs when a document considers reusing a snapshot.
+* `to_svg(**options)`
+* `to_pdf(**options)`
+* `to_png(**options)`
+* `to_html(*, title='Inklet figure', backend='auto', **options)` -- Offline experimental viewer; WebGL2 filled markers, Canvas fallback, SVG art.
+* `damage_bounds(previous: 'RenderScene')` -- Conservative old/new ink union for changed placements, in page mm.
+
+#### `compile_scene(root: 'Diagram | RenderScene', *, previous: 'RenderScene | None' = None) -> 'RenderScene'`
+
+Resolve a drawing for all native backends, reusing an optional revision.
+
 #### `blend(node, mode='multiply')`
 
 Blend an isolated group with the artwork behind it, natively in SVG/PDF.
@@ -1023,19 +1040,19 @@ One actionable finding. `where` is figure-space, in millimetres.
 
 Compact report. Returns a single string with no trailing newline.
 
-#### `to_svg(root: 'Diagram', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compact: 'bool | str' = 'auto', text: 'str' = 'names') -> 'str'`
+#### `to_svg(root: 'Diagram | RenderScene', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compact: 'bool | str' = 'auto', text: 'str' = 'names') -> 'str'`
 
 Render a diagram tree to a self-contained SVG document.
 
-#### `save_svg(root: 'Diagram', path: 'str', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compact: 'bool | str' = 'auto', text: 'str' = 'names') -> 'None'`
+#### `save_svg(root: 'Diagram | RenderScene', path: 'str', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compact: 'bool | str' = 'auto', text: 'str' = 'names') -> 'None'`
 
 Write `root` to `path` as SVG. `to_svg` is the same thing as a string.
 
-#### `to_pdf(root: 'Diagram | Sequence[Diagram]', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compress: 'bool' = True, text: 'str' = 'outline') -> 'bytes'`
+#### `to_pdf(root: 'Diagram | RenderScene | Sequence[Diagram | RenderScene]', *, width: 'float | str | None' = None, height: 'float | str | None' = None, margin: 'float' = 0.0, background: 'str | None' = None, precision: 'int' = 3, title: 'str | None' = None, compress: 'bool' = True, text: 'str' = 'outline') -> 'bytes'`
 
 Render one diagram tree, or a sequence of them, to a PDF document.
 
-#### `save_pdf(root: 'Diagram | Sequence[Diagram]', path: 'str | Path', **kwargs) -> 'None'`
+#### `save_pdf(root: 'Diagram | RenderScene | Sequence[Diagram | RenderScene]', path: 'str | Path', **kwargs) -> 'None'`
 
 Write `root` to `path` as PDF. `to_pdf` is the same thing as bytes.
 

inklet-4.0.0.dev4/docs/assets/research-preview/compiled-marker-shapes-caption.tex

@@ -0,0 +1 @@
+\caption{Five filled marker shapes with simulated observations. Each panel contains 2,500 points with varying sizes and two overlapping colour groups. The browser uses packed WebGL2 or Canvas layers; SVG and PDF retain vector markers. Marker order, transparency and panel clipping are shared by all modes. MIT, Mark Marosi.}