toolwake 0.2.1__tar.gz → 0.2.2__tar.gz

{toolwake-0.2.1 → toolwake-0.2.2}/CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project are documented here. Format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions follow
 [Semantic Versioning](https://semver.org/).
 
+## [0.2.2] — 2026-09-18
+
+Bounds the size of the viewer page. No reported number changes.
+
+### Fixed
+- **The viewer inlined every deposited bead, so the page grew without limit.**
+  Frames were capped at 400; beads were not capped at all. A 2 674-row path
+  already produces a 1.2 MB page, and a 100 000-row one would produce tens of
+  megabytes — which is a problem the moment anyone raises their row budget and
+  tries to embed the result in an iframe.
+
+  `to_html_str` now takes `max_beads` (default 20 000) and decimates the drawn
+  wake on the same rule as frames: sample evenly, and never drop a bead
+  something collided with. Purely cosmetic — the report is computed from the
+  full deposit, and nothing on the page claims a bead count.
+
 ## [0.2.1] — 2026-09-18
 
 Finishes 0.2.0. That release fixed the tool's geometry; this one fixes the

{toolwake-0.2.1/src/toolwake.egg-info → toolwake-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: toolwake
-Version: 0.2.1
+Version: 0.2.2
 Summary: Simulate a depositing tool travelling a toolpath, accumulate the material it leaves in its wake, and check the tool against it.
 Author-email: Zane Bates <zanetbates1@gmail.com>
 License: MIT

{toolwake-0.2.1 → toolwake-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "toolwake"
-version = "0.2.1"
+version = "0.2.2"
 description = "Simulate a depositing tool travelling a toolpath, accumulate the material it leaves in its wake, and check the tool against it."
 readme = "README.md"
 requires-python = ">=3.9"

{toolwake-0.2.1 → toolwake-0.2.2}/src/toolwake/__init__.py

@@ -19,7 +19,7 @@ from .profile import Section, ToolProfile, blunt_cannula, luer_taper_tip
 from .tool import Needle, ToolPose
 from .toolpath import PRINT, TRAVEL, Toolpath
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 __all__ = [
     "Toolpath", "PRINT", "TRAVEL",

{toolwake-0.2.1 → toolwake-0.2.2}/src/toolwake/viewer.py

@@ -310,7 +310,7 @@ def to_html(result, out="wake.html", **kw):
     return out
 
 
-def to_html_str(result, *, max_frames=400, fps=20, title=None,
+def to_html_str(result, *, max_frames=400, max_beads=20000, fps=20, title=None,
                 show_housing=True, live_poll=None):
     """Write a standalone interactive viewer for `result`.
 
@@ -318,6 +318,10 @@ def to_html_str(result, *, max_frames=400, fps=20, title=None,
     "jump to worst" goes straight to the deepest penetration — which is usually
     the only frame anyone actually wants to see.
 
+    `max_frames` and `max_beads` bound the size of the page. Both sample evenly
+    and both keep every collision regardless: the page exists to show what went
+    wrong, so that is the one thing decimation must never discard.
+
     The current frame is mirrored into the URL hash, so `file.html#f=506` or
     `file.html#worst` opens directly on a given row. That turns "look at the
     collision around row 506" into something sendable.
@@ -353,8 +357,22 @@ def to_html_str(result, *, max_frames=400, fps=20, title=None,
            if c >= 0 and d < result.threshold}
     segs = dep.segments()
     t_of = np.asarray(dep._t) if len(dep) else np.zeros(0, dtype=int)
-    beads = [[*map(float, s[0]), *map(float, s[1]), int(t_of[j]), 1 if j in hot else 0]
-             for j, s in enumerate(segs)]
+
+    # Decimate the drawn wake, on the same rule as frames: sample evenly, and
+    # never drop a bead something collided with. Every segment is inlined into
+    # the page, so an unbounded wake is an unbounded page — a 2 674-row path
+    # gives 1.2 MB, and a 100 000-row one would give tens of megabytes that no
+    # iframe is going to enjoy. Purely cosmetic: the report is computed from
+    # the full deposit, and nothing on the page claims a bead count.
+    n_segs = len(segs)
+    if max_beads and n_segs > max_beads:
+        stride = int(np.ceil(n_segs / max_beads))
+        shown = sorted(set(range(0, n_segs, stride)) | hot)
+    else:
+        shown = range(n_segs)
+    beads = [[*map(float, segs[j][0]), *map(float, segs[j][1]),
+              int(t_of[j]), 1 if j in hot else 0]
+             for j in shown]
 
     frames = []
     for r in rows:

{toolwake-0.2.1 → toolwake-0.2.2/src/toolwake.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: toolwake
-Version: 0.2.1
+Version: 0.2.2
 Summary: Simulate a depositing tool travelling a toolpath, accumulate the material it leaves in its wake, and check the tool against it.
 Author-email: Zane Bates <zanetbates1@gmail.com>
 License: MIT

{toolwake-0.2.1 → toolwake-0.2.2}/tests/test_toolwake.py

@@ -885,3 +885,38 @@ def test_bead_sits_below_the_nozzle_face_not_on_the_path():
     assert dropped.n_hits == 0, (
         f"bead dropped to its layer still collides: {dropped.n_hits} rows, "
         f"worst {dropped.worst * 1e3:.4f} mm")
+
+
+def test_viewer_bounds_the_wake_but_keeps_every_collision():
+    """The page inlines every bead, so an unbounded wake is an unbounded page.
+
+    A 2 674-row path already produces 1.2 MB; at the 100 000-row budget the
+    backend now allows, an uncapped wake would be tens of megabytes and no
+    iframe would enjoy it. Decimation samples evenly and keeps every bead
+    something collided with — the page exists to show what went wrong, so that
+    is the one thing it must never drop.
+    """
+    import json
+    import re
+
+    from toolwake.viewer import to_html_str
+
+    # A tight spiral so plenty of beads land near the tool and some collide.
+    path = Toolpath.helix(radius=0.004, pitch=2e-4, turns=12.0, per_turn=120)
+    res = simulate(path, Needle(inner_d=90e-6), lag=4, threshold=0.0)
+
+    def beads_of(html):
+        m = re.search(r'"beads":\s*(\[.*?\])\s*,\s*"', html, re.S)
+        assert m, "bead array not found in the page"
+        return json.loads(m.group(1))
+
+    full = beads_of(to_html_str(res, max_beads=0))
+    small = beads_of(to_html_str(res, max_beads=60))
+    assert len(full) > 200, "fixture is too small to exercise decimation"
+
+    n_hot = sum(1 for b in full if b[7])
+    assert len(small) <= 60 + n_hot, (
+        f"{len(small)} beads kept against a cap of 60 (+{n_hot} collisions)")
+    assert len(small) < len(full)
+    assert sum(1 for b in small if b[7]) == n_hot, (
+        "decimation dropped a bead that something collided with")