Skip to content

Integrators in Practice: an Interactive Explainer

advanced · salvage · A narrated web animation comparing integrators on an ODE, an SDE, and a curved manifold; TorchEBM is the compute engine.

Run it:

python examples/90-showcase/03-integrator-story/compute.py

A short, narrated web animation comparing numerical integrators on an ODE, an SDE, and a curved manifold. TorchEBM is the compute engine; the browser only renders precomputed trajectories.

1
2
3
4
compute.py   → runs every experiment with TorchEBM → data.js (+ data.json, preview.png)
index.html   → the page
app.js       → renderer: Canvas2D (Ch.1–2) + Three.js (Ch.3) + narration timeline + recorder
vendor/      → three.min.js (r128, vendored so it works offline)

Chapters

  1. ODE — Kepler orbit. Forward Euler spirals out, RK4 slowly decays, symplectic Leapfrog holds a stable ellipse; an energy meter shows the drift.
  2. SDE — Langevin double-well. Walkers under dX = −∇U dt + √(2T) dW build a histogram that matches the true Boltzmann p ∝ e^(−U/T); all three SDE integrators agree.
  3. S² — geodesic. A naive flat-space Euler step drifts off the sphere while an exponential-map (geodesic / Riemannian) step stays exact — RM-HMC / GeneralisedLeapfrog.

Run

Just open index.html (double-click works offline — data is inlined in data.js). Or serve it: python -m http.server in this folder, then visit the printed URL.

  • Play / Pause / Restart / scrubber at the bottom.
  • Record .webm captures the canvas to a video file. Convert to mp4 with the bundled ffmpeg:
    python -c "import imageio_ffmpeg as f;print(f.get_ffmpeg_exe())"   # path to ffmpeg
    <ffmpeg> -i torchebm_integrators.webm -pix_fmt yuv420p torchebm_integrators.mp4
    
  • index.html?t=<seconds> freezes a single frame (used for screenshot tests).

Regenerate the data

python compute.py
Edits to the experiments (step sizes, eccentricity, temperature, …) live in compute.py; rerun it to refresh data.js.

compute.py

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
r"""Compute layer for the "Integrators in practice" explainer.

TorchEBM is the compute engine: this script runs every experiment and writes a
single ``data.json`` that the Three.js front-end (index.html / app.js) animates.
It also renders a static ``preview.png`` contact sheet so the physics can be
sanity-checked before building the interactive artifact.

Three chapters:
    1. ODE  — eccentric two-body (Kepler) orbit: Euler vs RK4 vs symplectic
              Leapfrog; symplectic stays a closed ellipse, the rest drift.
    2. SDE  — overdamped Langevin on a double well: Euler-Maruyama vs Heun vs
              Backward-Euler-Maruyama recover the Boltzmann density; at large dt
              the explicit method destabilises while the implicit one holds.
    3. S^2  — geodesic motion on a sphere: a naive ambient Euler step drifts off
              the manifold, an exponential-map (geodesic) step stays exact.

Run:  python examples/visualization/integrator_story/compute.py
"""

from __future__ import annotations

import json
import math
from pathlib import Path

import numpy as np
import torch

import time

from torchebm.integrators import (
    EulerMaruyamaIntegrator,
    HeunIntegrator,
    BackwardEulerMaruyamaIntegrator,
    RK4Integrator,
    LeapfrogIntegrator,
)
from torchebm.core import BaseModel
from torchebm.samplers import LangevinDynamics

HERE = Path(__file__).resolve().parent
torch.manual_seed(0)

# Brand palette shared with the front-end.
ORANGE = "#E69F00"   # the method that goes wrong
BLUE = "#56B4E9"     # in-between
GREEN = "#00D49A"    # the correct / stable method
TRUTH = "#e8e8ee"


def _r(a, nd=4):
    """Round a numpy array to a JSON-friendly nested list."""
    return np.asarray(a, dtype=np.float64).round(nd).tolist()


# ============================================================================ #
# Chapter 1 — Kepler orbit (ODE)
# ============================================================================ #

GM = 1.0


def kepler_accel(pos: torch.Tensor) -> torch.Tensor:
    """Newtonian gravity a = -GM r / |r|^3 for pos shape (..., 2)."""
    r = torch.linalg.vector_norm(pos, dim=-1, keepdim=True).clamp_min(1e-6)
    return -GM * pos / r ** 3


def kepler_full_drift(z, t):
    """First-order field (vx, vy, ax, ay) for the RK/Euler integrators."""
    pos, vel = z[..., :2], z[..., 2:]
    return torch.cat([vel, kepler_accel(pos)], dim=-1)


def kepler_energy(pos: np.ndarray, vel: np.ndarray) -> np.ndarray:
    r = np.linalg.norm(pos, axis=-1)
    return 0.5 * np.sum(vel ** 2, axis=-1) - GM / np.clip(r, 1e-6, None)


def run_kepler(h: float, n: int):
    p0 = torch.tensor([[1.4, 0.0]])          # start at aphelion
    v0 = torch.tensor([[0.0, 0.45]])         # -> eccentricity ~0.7 (RK4 visibly decays)
    t = np.arange(n + 1) * h

    methods = []

    # --- Euler (forward) and RK4 on the full first-order system ---
    for name, color, integ in [
        ("Forward Euler", ORANGE, EulerMaruyamaIntegrator()),   # no noise -> Euler
        ("RK4", BLUE, RK4Integrator()),
    ]:
        z = torch.cat([p0, v0], dim=-1)
        state = {"x": z}
        pos = [p0.numpy().copy()[0]]
        vel = [v0.numpy().copy()[0]]
        for _ in range(n):
            state = integ.step(state, h, drift=kepler_full_drift)
            zc = state["x"][0]
            pos.append(zc[:2].numpy().copy())
            vel.append(zc[2:].numpy().copy())
        pos = np.asarray(pos); vel = np.asarray(vel)
        methods.append({"name": name, "color": color,
                        "xy": _r(pos), "energy": _r(kepler_energy(pos, vel), 5)})

    # --- symplectic Leapfrog (x=position, p=velocity, mass=1) ---
    lf = LeapfrogIntegrator()
    state = {"x": p0.clone(), "p": v0.clone()}
    pos = [p0.numpy().copy()[0]]; vel = [v0.numpy().copy()[0]]
    for _ in range(n):
        state = lf.step(state, h, drift=lambda x, t: kepler_accel(x))
        pos.append(state["x"][0].numpy().copy())
        vel.append(state["p"][0].numpy().copy())
    pos = np.asarray(pos); vel = np.asarray(vel)
    methods.append({"name": "Leapfrog (symplectic)", "color": GREEN,
                    "xy": _r(pos), "energy": _r(kepler_energy(pos, vel), 5)})

    e0 = float(kepler_energy(p0.numpy(), v0.numpy())[0])
    print("  [Kepler]  energy drift |E_end-E0|:")
    for m in methods:
        drift = abs(m["energy"][-1] - e0)
        rmax = float(np.max(np.linalg.norm(np.asarray(m["xy"]), axis=-1)))
        print(f"    {m['name']:<22} {drift:9.4f}   max r={rmax:.2f}")
    return {"t": _r(t, 4), "GM": GM, "energy0": round(e0, 5), "methods": methods}


# ============================================================================ #
# Chapter 1b — the figure-eight 3-body choreography (ODE)
# ============================================================================ #

# Chenciner-Montgomery figure-eight initial conditions (G=1, equal unit masses).
TB_X = [0.97000436, -0.24308753, -0.97000436, 0.24308753, 0.0, 0.0]
TB_V = [0.46620369, 0.43236573, 0.46620369, 0.43236573, -0.93240737, -0.86473146]
TB_PERIOD = 6.3259


def tb_accel(pos: torch.Tensor) -> torch.Tensor:
    """Pairwise gravity for 3 bodies; pos (..., 6) = [x1,y1,x2,y2,x3,y3]."""
    P = pos.view(*pos.shape[:-1], 3, 2)
    a = torch.zeros_like(P)
    for i in range(3):
        for j in range(3):
            if i == j:
                continue
            d = P[..., j, :] - P[..., i, :]
            r = d.norm(dim=-1, keepdim=True).clamp_min(1e-4)
            a[..., i, :] = a[..., i, :] + d / r ** 3
    return a.reshape(pos.shape)


def tb_full_drift(z, t):
    pos, vel = z[..., :6], z[..., 6:]
    return torch.cat([vel, tb_accel(pos)], dim=-1)


def tb_energy(pos: np.ndarray, vel: np.ndarray) -> np.ndarray:
    P = pos.reshape(-1, 3, 2)
    ke = 0.5 * np.sum(vel ** 2, axis=-1)
    pe = np.zeros(P.shape[0])
    for i, j in [(0, 1), (0, 2), (1, 2)]:
        pe -= 1.0 / np.linalg.norm(P[:, j] - P[:, i], axis=-1).clip(1e-4)
    return ke + pe


def run_threebody(h: float, periods: float, keep: int):
    p0 = torch.tensor([TB_X]); v0 = torch.tensor([TB_V])
    n = int(round(periods * TB_PERIOD / h))
    every = max(1, n // keep)

    def drive_rk(integ):
        z = torch.cat([p0, v0], -1); state = {"x": z}; P = [TB_X[:]]; V = [TB_V[:]]
        for i in range(n):
            state = integ.step(state, h, drift=tb_full_drift)
            if (i + 1) % every == 0:
                zc = state["x"][0]; P.append(zc[:6].tolist()); V.append(zc[6:].tolist())
        return np.array(P), np.array(V)

    def drive_lf():
        lf = LeapfrogIntegrator(); state = {"x": p0.clone(), "p": v0.clone()}; P = [TB_X[:]]; V = [TB_V[:]]
        for i in range(n):
            state = lf.step(state, h, drift=lambda x, t: tb_accel(x))
            if (i + 1) % every == 0:
                P.append(state["x"][0].tolist()); V.append(state["p"][0].tolist())
        return np.array(P), np.array(V)

    runs = {
        "Forward Euler": (ORANGE,) + drive_rk(EulerMaruyamaIntegrator()),
        "RK4": (BLUE,) + drive_rk(RK4Integrator()),
        "Leapfrog": (GREEN,) + drive_lf(),
    }
    e0 = float(tb_energy(np.array([TB_X]), np.array([TB_V]))[0])
    methods = []
    print(f"\n  [3-body figure-8]  h={h}  periods={periods}  e0={e0:.3f}")
    for name, (color, P, V) in runs.items():
        E = tb_energy(P, V)
        bodies = P.reshape(P.shape[0], 3, 2)        # (F, 3, 2)
        methods.append({"name": name, "color": color,
                        "bodies": _r(bodies, 4), "energy": _r(E, 4)})
        print(f"    {name:<16} |E_end-e0|={abs(E[-1]-e0):8.3f}  "
              f"max excursion={np.abs(bodies).max():.2f}")
    return {"period": TB_PERIOD, "energy0": round(e0, 4), "methods": methods}


# ============================================================================ #
# Chapter 2 — Langevin on a double well (SDE)
# ============================================================================ #

BARRIER = 1.0           # U(x) = BARRIER * (x^2 - 1)^2
TEMP = 0.5              # temperature -> diffusion D = TEMP


def U(x):
    return BARRIER * (x ** 2 - 1.0) ** 2


def dU(x):
    return BARRIER * 4.0 * x * (x ** 2 - 1.0)


def langevin_drift(x, t):
    return -dU(x)


def run_langevin(dt: float, n_steps: int, n_walkers: int, keep: int, label_blowup=False):
    """Drive each SDE integrator; return per-method walker frames + final hist."""
    xgrid = np.linspace(-2.2, 2.2, 220)
    true_pdf = np.exp(-U(xgrid) / TEMP)
    true_pdf /= true_pdf.sum() * (xgrid[1] - xgrid[0])     # normalise (uniform grid)

    D = torch.tensor(float(TEMP))            # diffusion coefficient (must be a tensor)
    specs = [
        ("Euler-Maruyama", ORANGE, EulerMaruyamaIntegrator()),
        ("Heun", BLUE, HeunIntegrator()),
        ("Backward-Euler-Maruyama", GREEN, BackwardEulerMaruyamaIntegrator()),
    ]
    methods = []
    for name, color, integ in specs:
        torch.manual_seed(0)
        x = (torch.rand(n_walkers, 1) * 0.4 - 0.2)        # start near the barrier
        frames = [x[:, 0].numpy().copy()]
        every = max(1, n_steps // keep)
        blew = False
        for i in range(n_steps):
            x = integ.step({"x": x}, dt, drift=langevin_drift, diffusion=D)["x"]
            if not torch.isfinite(x).all() or x.abs().max() > 50:
                blew = True
                x = torch.nan_to_num(x, nan=0.0).clamp(-50, 50)
            if (i + 1) % every == 0:
                frames.append(x[:, 0].numpy().copy())
        frames = np.asarray(frames)                       # (F, n_walkers)
        hist, edges = np.histogram(frames[-1], bins=60, range=(-2.2, 2.2), density=True)
        methods.append({"name": name, "color": color, "blew_up": bool(blew),
                        "frames": _r(frames, 3),
                        "hist": _r(hist, 4)})
    out = {"dt": dt, "n_walkers": n_walkers,
           "xgrid": _r(xgrid, 4), "U": _r(U(xgrid), 4), "true_pdf": _r(true_pdf, 5),
           "hist_edges": _r(np.linspace(-2.2, 2.2, 61), 4),
           "temp": TEMP, "barrier": BARRIER, "methods": methods}
    tag = "large dt" if label_blowup else "small dt"
    print(f"  [Langevin {tag}] dt={dt}:")
    for m in methods:
        fr = np.asarray(m["frames"][-1])
        print(f"    {m['name']:<26} blew_up={m['blew_up']!s:<5} "
              f"frac|x|>0.5={np.mean(np.abs(fr) > 0.5):.2f}  range=[{fr.min():.2f},{fr.max():.2f}]")
    return out


# ============================================================================ #
# SDE on a line — Ornstein-Uhlenbeck, same Brownian path for every integrator
# ============================================================================ #

def run_sde_line(theta=1.5, sigma=1.0, x0=2.0, dt=0.3, n=42, stride=24):
    r"""Drive Euler-Maruyama / Heun / Backward-EM on dX = -theta X dt + sigma dW,
    all sharing ONE Brownian path, against a fine-step reference.

    The integrators add ``sqrt(2*diffusion)*noise*sqrt(dt)``, so diffusion =
    sigma^2/2 and ``noise`` is a standard normal. The coarse normal for step i is
    the standardised sum of the ``stride`` fine increments inside that step, so the
    coarse methods and the fine reference see the identical Brownian motion.
    """
    torch.manual_seed(0)
    D = torch.tensor(sigma ** 2 / 2.0)
    drift = lambda x, t: -theta * x
    dt_fine = dt / stride
    zf = torch.randn(n * stride, 1)                      # fine standard normals

    # fine reference (Euler-Maruyama at dt_fine on the same noise)
    em = EulerMaruyamaIntegrator()
    x = torch.tensor([[x0]]); ref = [x0]
    for i in range(n * stride):
        x = em.step({"x": x}, dt_fine, drift=drift, diffusion=D, noise=zf[i:i + 1])["x"]
        if (i + 1) % stride == 0:
            ref.append(float(x.item()))
    ref = np.asarray(ref)

    # coarse standardised increments (same Brownian path)
    zc = zf.view(n, stride, 1).sum(dim=1) / math.sqrt(stride)   # (n,1)

    specs = [("Euler-Maruyama", ORANGE, EulerMaruyamaIntegrator()),
             ("Heun", BLUE, HeunIntegrator()),
             ("Backward-Euler-Maruyama", GREEN, BackwardEulerMaruyamaIntegrator())]
    methods = []
    for name, color, integ in specs:
        x = torch.tensor([[x0]]); path = [x0]
        for i in range(n):
            x = integ.step({"x": x}, dt, drift=drift, diffusion=D, noise=zc[i:i + 1])["x"]
            path.append(float(x.item()))
        path = np.asarray(path)
        methods.append({"name": name, "color": color, "path": _r(path, 4),
                        "err": round(float(np.max(np.abs(path - ref))), 4)})

    t = np.arange(n + 1) * dt
    print(f"\n  [SDE line]  OU theta={theta} dt={dt}  max|path-ref|:")
    for m in methods:
        print(f"    {m['name']:<26} {m['err']:.3f}   end={m['path'][-1]:+.3f}  (ref end {ref[-1]:+.3f})")
    return {"theta": theta, "sigma": sigma, "dt": dt, "t": _r(t, 4),
            "ref": _r(ref, 4), "methods": methods}


# ============================================================================ #
# Optimal transport — exact Gaussian displacement interpolation (Flow Matching)
# ============================================================================ #

def run_ot(n=620, F=64):
    r"""Flow-Matching / optimal-transport demo: a Gaussian source is carried to a
    structured two-moons target. A greedy OT coupling pairs the points, and
    TorchEBM's interpolants set the path: LinearInterpolant -> straight OT
    geodesics, CosineInterpolant -> curved paths.  x_t = alpha(t) x1 + sigma(t) x0."""
    from torchebm.interpolants.linear import LinearInterpolant
    from torchebm.interpolants.cosine import CosineInterpolant
    torch.manual_seed(2)

    # source: isotropic Gaussian (left)
    x0 = torch.randn(n, 2) * 0.42 + torch.tensor([-2.7, 0.0])

    # target: two interleaving moons (sklearn-style), centred, scaled, shifted right
    h1 = n // 2
    a1 = math.pi * torch.rand(h1)
    a2 = math.pi * torch.rand(n - h1)
    moons = torch.cat([torch.stack([torch.cos(a1), torch.sin(a1)], 1),
                       torch.stack([1 - torch.cos(a2), 0.5 - torch.sin(a2)], 1)], 0)
    moons = (moons - moons.mean(0)) * 1.45 + torch.randn(n, 2) * 0.045
    x1 = moons + torch.tensor([2.7, 0.0])

    # greedy OT-approximate coupling (no scipy): repeatedly take the nearest free pair
    C = ((x0[:, None, :] - x1[None, :, :]) ** 2).sum(-1).numpy()
    order = np.argsort(C, axis=None)
    u0 = np.zeros(n, bool); u1 = np.zeros(n, bool); pair = np.full(n, -1); cnt = 0
    for idx in order:
        i, j = int(idx // n), int(idx % n)
        if not u0[i] and not u1[j]:
            pair[i] = j; u0[i] = u1[j] = True; cnt += 1
            if cnt == n:
                break
    x1 = x1[torch.from_numpy(pair)]

    # interpolant schedules straight from TorchEBM (x_t = alpha x1 + sigma x0)
    tg = torch.linspace(0, 1, F)
    sched = {}
    for name, interp in [("linear", LinearInterpolant()), ("cosine", CosineInterpolant())]:
        al = interp.compute_alpha_t(tg)[0].reshape(-1)
        sg = interp.compute_sigma_t(tg)[0].reshape(-1)
        sched[name] = {"alpha": _r(al.numpy(), 4), "sigma": _r(sg.numpy(), 4)}
    print(f"\n  [OT]  n={n}  source=Gaussian  target=two-moons  coupling=greedy-OT  "
          f"interpolants={list(sched)}")
    return {"x0": _r(x0.numpy(), 3), "x1": _r(x1.numpy(), 3),
            "t": _r(tg.numpy(), 4), "sched": sched}


# ============================================================================ #
# Chapter 3 — geodesic on the sphere S^2
# ============================================================================ #

def run_sphere(h: float, n: int):
    """A great-circle geodesic: exact exponential-map step vs naive ambient Euler."""
    x0 = np.array([0.0, 0.0, 1.0])                  # north pole
    # tangent velocity (in the x-z... pick a tilted great circle for visual interest)
    v0 = np.array([1.0, 0.35, 0.0]); v0 = v0 - np.dot(v0, x0) * x0
    v0 = v0 / np.linalg.norm(v0) * 1.0              # |v|=omega=1

    # True great circle: x(t) = cos(t) x0 + sin(t) v0_hat
    t = np.arange(n + 1) * h
    true = (np.cos(t)[:, None] * x0 + np.sin(t)[:, None] * v0)

    # Geodesic (exponential-map) integrator: exact rotation in the (x, v) plane.
    geo = []
    x, v = x0.copy(), v0.copy()
    for _ in range(n + 1):
        geo.append(x.copy())
        w = np.linalg.norm(v)
        xn = math.cos(w * h) * x + math.sin(w * h) * (v / w)
        vn = -w * math.sin(w * h) * x + math.cos(w * h) * v
        x, v = xn, vn
    geo = np.asarray(geo)

    # Naive forward Euler on the unit-speed geodesic ODE x'' = -x, with NO
    # re-projection onto the manifold: energy is not conserved, so |x| grows and
    # the path gently spirals OFF the sphere (the flat-space integrator does not
    # know it must stay on S^2).
    naive = []
    x, v = x0.copy(), v0.copy()
    for _ in range(n + 1):
        naive.append(x.copy())
        a = -x
        x = x + h * v
        v = v + h * a
    naive = np.asarray(naive)

    rad = lambda a: np.linalg.norm(a, axis=-1)
    print("  [Sphere]  radius drift |r_end-1|:")
    print(f"    geodesic (exp-map)   {abs(rad(geo)[-1]-1):.4f}")
    print(f"    naive ambient Euler  {abs(rad(naive)[-1]-1):.4f}")
    return {
        "t": _r(t, 4),
        "true_path": _r(true, 4),
        "methods": [
            {"name": "Geodesic (exp-map)", "color": GREEN,
             "path": _r(geo, 4), "radius": _r(rad(geo), 4)},
            {"name": "Naive ambient Euler", "color": ORANGE,
             "path": _r(naive, 4), "radius": _r(rad(naive), 4)},
        ],
    }


# ============================================================================ #
# Fluid — Taylor-Green (exact NS) + Karman street + vorticity-as-density
# ============================================================================ #

class RingEnergy(BaseModel):
    """A vortex-ring energy: low energy on the circle r=R."""
    def forward(self, x):
        r = torch.linalg.vector_norm(x, dim=-1)
        return 6.0 * (r - 1.2) ** 2


def run_fluid(disp=1000, nsteps=180, keep=2):
    rk = RK4Integrator()
    out = {}

    # ---- Taylor-Green vortices: u = (cos x sin y, -sin x cos y) (steady NS) ----
    def tg(z, t):
        x, y = z[..., 0:1], z[..., 1:2]
        return torch.cat([torch.cos(x) * torch.sin(y), -torch.sin(x) * torch.cos(y)], -1)

    torch.manual_seed(3)
    P = torch.rand(disp, 2) * (2 * math.pi)
    st = {"x": P.clone()}; fr = [P.numpy().copy()]
    for i in range(nsteps):
        st = rk.step(st, 0.05, drift=tg)
        if (i + 1) % keep == 0:
            fr.append(st["x"].numpy().copy())
    Nb = 60000; sb = {"x": torch.rand(Nb, 2) * (2 * math.pi)}
    t0 = time.time()
    for _ in range(400):
        sb = rk.step(sb, 0.05, drift=tg)
    el = time.time() - t0
    out["taylor"] = {"tracers": _r(np.stack(fr, 0), 3), "L": round(2 * math.pi, 4),
                     "timing": f"{Nb // 1000}k tracers · 400 RK4 steps · {el * 1000:.0f} ms"
                               f"  ({Nb * 400 / el / 1e6:.0f}M particle-steps/s)"}
    print(f"  [Fluid] Taylor-Green: {out['taylor']['timing']}")

    # ---- Karman vortex street: staggered point vortices + freestream ----
    sp, hgt, G, U = 1.7, 0.6, 2.6, 0.9
    vlist = []
    for k in range(-3, 4):
        vlist.append((k * sp, hgt, -G))
        vlist.append((k * sp + sp / 2, -hgt, G))
    VX = torch.tensor([[a, b] for a, b, _ in vlist]); GAM = torch.tensor([c for _, _, c in vlist])
    core = 0.10

    def karman(z, t):
        d = z[:, None, :] - VX[None, :, :]
        r2 = (d ** 2).sum(-1) + core
        ux = (-GAM / (2 * math.pi) * d[..., 1] / r2).sum(-1) + U
        uy = (GAM / (2 * math.pi) * d[..., 0] / r2).sum(-1)
        return torch.stack([ux, uy], -1)

    torch.manual_seed(4)
    Pk = torch.stack([torch.rand(disp) * 10 - 7.0, torch.rand(disp) * 3.4 - 1.7], -1)
    stk = {"x": Pk.clone()}; frk = [Pk.numpy().copy()]
    for i in range(nsteps):
        stk = rk.step(stk, 0.04, drift=karman)
        if (i + 1) % keep == 0:
            frk.append(stk["x"].numpy().copy())
    out["karman"] = {"tracers": _r(np.stack(frk, 0), 3),
                     "vortices": _r(VX.numpy(), 3), "gam": GAM.tolist()}

    # ---- vorticity as a density: Langevin on a vortex-ring energy ----
    torch.manual_seed(5)
    sampler = LangevinDynamics(model=RingEnergy(), step_size=5e-3, noise_scale=0.25)
    x0 = torch.randn(900, 2) * 0.25
    traj = sampler.sample(x=x0, dim=2, n_steps=900, thin=12, return_trajectory=True)
    vort = traj.permute(1, 0, 2).numpy()              # (frames, walkers, 2)
    out["vorticity"] = {"walkers": _r(vort, 3), "R": 1.2}
    print(f"  [Fluid] vorticity walkers {vort.shape}")
    return out


# ============================================================================ #
# Assemble + preview
# ============================================================================ #

def preview(data, path: Path):
    import matplotlib
    matplotlib.use("Agg")
    import matplotlib.pyplot as plt

    plt.rcParams.update({"figure.facecolor": "#0b0b0f", "savefig.facecolor": "#0b0b0f",
                         "text.color": "#f5f5f7", "font.family": "DejaVu Sans"})
    fig = plt.figure(figsize=(15, 5), dpi=110)

    # (a) Kepler
    ax = fig.add_subplot(1, 3, 1)
    ax.set_facecolor("#0b0b0f"); ax.set_aspect("equal"); ax.axis("off")
    ax.set_xlim(-2.2, 2.2); ax.set_ylim(-2.2, 2.2)
    ax.set_title("Ch.1 · Kepler orbit (ODE)", color="#9aa0aa")
    ax.plot(0, 0, "o", color="#ffd27f", ms=10)
    for m in data["ode"]["methods"]:
        xy = np.asarray(m["xy"])
        ax.plot(xy[:, 0], xy[:, 1], color=m["color"], lw=1.3, alpha=0.9, label=m["name"])
    ax.legend(loc="upper right", fontsize=7, frameon=False, labelcolor="#f5f5f7")

    # (b) Langevin
    ax = fig.add_subplot(1, 3, 2)
    ax.set_facecolor("#0b0b0f")
    ax.set_title("Ch.2 · Langevin double-well (SDE)", color="#9aa0aa")
    s = data["sde_small"]
    xg = np.asarray(s["xgrid"])
    ax.plot(xg, np.asarray(s["true_pdf"]), color=TRUTH, lw=2, ls="--", label="true p(x)")
    edges = np.asarray(s["hist_edges"]); ctr = 0.5 * (edges[1:] + edges[:-1])
    for m in s["methods"]:
        ax.plot(ctr, np.asarray(m["hist"]), color=m["color"], lw=1.6, alpha=0.9, label=m["name"])
    ax.plot(xg, 0.15 * np.asarray(s["U"]), color="#555", lw=1, alpha=0.6)
    ax.set_xlim(-2.2, 2.2); ax.tick_params(colors="#9aa0aa")
    ax.legend(loc="upper center", fontsize=7, frameon=False, labelcolor="#f5f5f7")

    # (c) Sphere
    ax = fig.add_subplot(1, 3, 3, projection="3d")
    ax.set_facecolor("#0b0b0f")
    ax.set_title("Ch.3 · Geodesic on S² (3D finale)", color="#9aa0aa")
    u, v = np.mgrid[0:2 * np.pi:40j, 0:np.pi:20j]
    ax.plot_wireframe(np.cos(u) * np.sin(v), np.sin(u) * np.sin(v), np.cos(v),
                      color="#333", linewidth=0.3)
    for m in data["sphere"]["methods"]:
        p = np.asarray(m["path"])
        ax.plot(p[:, 0], p[:, 1], p[:, 2], color=m["color"], lw=2, label=m["name"])
    ax.legend(loc="upper center", fontsize=7, labelcolor="#f5f5f7")
    ax.set_box_aspect((1, 1, 1)); ax.grid(False)
    for a in (ax.xaxis, ax.yaxis, ax.zaxis):
        a.set_pane_color((0, 0, 0, 0)); a.line.set_color((0, 0, 0, 0))
        a.set_ticklabels([])

    fig.tight_layout()
    fig.savefig(path, dpi=110)
    print(f"\nwrote {path}")


def main():
    print("Computing chapters...\n")
    data = {
        "ode": run_kepler(h=0.08, n=460),
        "threebody": run_threebody(h=0.024, periods=6.0, keep=600),
        "sde_small": run_langevin(dt=0.01, n_steps=2400, n_walkers=2000, keep=80),
        "sphere": run_sphere(h=0.06, n=210),
    }
    out = HERE / "data.json"
    payload = json.dumps(data, separators=(",", ":"))
    out.write_text(payload)
    # Also emit a JS global so index.html works by double-click (no fetch/CORS).
    (HERE / "data.js").write_text("window.STORY_DATA=" + payload + ";\n")
    mb = out.stat().st_size / 1e6
    print(f"\nwrote {out} and data.js  ({mb:.1f} MB)")
    preview(data, HERE / "preview.png")


if __name__ == "__main__":
    main()

capture.py

r"""Render the explainer to an MP4 by driving headless Chrome via the DevTools
protocol. For each frame we call window.__seek(t) (deterministic) and grab the
canvas with window.__snap(), then pipe the JPEGs to ffmpeg (from imageio-ffmpeg).

Run:  python examples/visualization/integrator_story/capture.py [--fps 30]
Output: integrator_story.mp4  (1280x720, H.264, yuv420p — LinkedIn/Twitter ready)
"""
from __future__ import annotations

import argparse
import base64
import json
import subprocess
import time
import urllib.request
from pathlib import Path

import websocket  # websocket-client
import imageio_ffmpeg

HERE = Path(__file__).resolve().parent
URL = (HERE / "index.html").as_uri()
PORT = 9333


def get_page_ws():
    for _ in range(120):
        try:
            data = json.load(urllib.request.urlopen(f"http://127.0.0.1:{PORT}/json/list"))
            for t in data:
                if t.get("type") == "page" and t.get("webSocketDebuggerUrl"):
                    return t["webSocketDebuggerUrl"]
        except Exception:
            pass
        time.sleep(0.25)
    raise RuntimeError("DevTools page target not found")


def main():
    ap = argparse.ArgumentParser()
    ap.add_argument("--fps", type=int, default=30)
    ap.add_argument("--out", default=str(HERE / "integrator_story.mp4"))
    ap.add_argument("--crf", type=int, default=18)
    args = ap.parse_args()

    chrome = subprocess.Popen([
        "google-chrome", "--headless=new", "--no-sandbox", "--disable-dev-shm-usage",
        "--hide-scrollbars", "--window-size=1320,840",
        "--use-gl=angle", "--use-angle=swiftshader", "--enable-unsafe-swiftshader",
        f"--remote-debugging-port={PORT}", "--remote-allow-origins=*", URL,
    ], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)

    ws = websocket.create_connection(get_page_ws(), suppress_origin=True,
                                     max_int=2**31, timeout=60)
    _id = [0]

    def cmd(method, params=None):
        _id[0] += 1
        mid = _id[0]
        ws.send(json.dumps({"id": mid, "method": method, "params": params or {}}))
        while True:
            msg = json.loads(ws.recv())
            if msg.get("id") == mid:
                if "error" in msg:
                    raise RuntimeError(msg["error"])
                return msg.get("result")

    def ev(expr):
        r = cmd("Runtime.evaluate", {"expression": expr, "returnByValue": True})
        return r["result"].get("value")

    cmd("Page.enable")
    cmd("Runtime.enable")
    for _ in range(200):
        try:
            if ev("typeof window.__ready==='function' && window.__ready()"):
                break
        except Exception:
            pass
        time.sleep(0.1)

    total = ev("window.__total")
    if not total:
        raise RuntimeError("page did not initialise (window.__total missing)")
    nframes = int(round(total * args.fps))
    print(f"total={total:.1f}s  ->  {nframes} frames @ {args.fps}fps  ->  {args.out}")

    ff = imageio_ffmpeg.get_ffmpeg_exe()
    enc = subprocess.Popen([
        ff, "-y", "-f", "image2pipe", "-r", str(args.fps), "-vcodec", "mjpeg", "-i", "-",
        "-vf", "scale=1280:720:flags=lanczos", "-pix_fmt", "yuv420p",
        "-c:v", "libx264", "-crf", str(args.crf), "-preset", "medium",
        "-movflags", "+faststart", args.out,
    ], stdin=subprocess.PIPE, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)

    t0 = time.time()
    for i in range(nframes):
        ev(f"window.__seek({i / args.fps})")
        durl = ev("window.__snap(0.95)")
        enc.stdin.write(base64.b64decode(durl.split(",", 1)[1]))
        if i % 120 == 0:
            print(f"  frame {i}/{nframes}  ({time.time() - t0:.0f}s)")
    enc.stdin.close()
    enc.wait()
    ws.close()
    chrome.terminate()
    kb = Path(args.out).stat().st_size // 1000
    print(f"wrote {args.out}  ({kb} KB)")


if __name__ == "__main__":
    main()

capture_shots.py

r"""Render the explainer to MP4 via parallel headless-Chrome screenshots.

CDP screencast is blocked in some sandboxes (Chrome is killed when it binds a
debug port), so we instead capture one clean frame per `--screenshot` launch
(?capture=1&t=SECONDS) across a thread pool, then encode with ffmpeg.

Run:  python capture_shots.py [--fps 20] [--workers 6]
Output: integrator_story.mp4  (1280x720, H.264, yuv420p)
"""
from __future__ import annotations

import argparse
import concurrent.futures
import re
import subprocess
import time
from pathlib import Path

import imageio_ffmpeg

HERE = Path(__file__).resolve().parent
URL = (HERE / "index.html").as_uri()
DECK_DUR = {"story": 66, "sde": 16, "ot": 26, "fluid": 34}

CHROME_FLAGS = [
    "google-chrome", "--headless=new", "--no-sandbox", "--disable-dev-shm-usage",
    "--hide-scrollbars", "--window-size=1280,720", "--force-device-scale-factor=1",
    "--use-gl=angle", "--use-angle=swiftshader", "--enable-unsafe-swiftshader",
]


def shot(i: int, fps: int, budget: int, frames: Path, deck: str):
    out = frames / f"f{i:05d}.png"
    if out.exists() and out.stat().st_size > 2000:
        return True
    try:
        subprocess.run(
            CHROME_FLAGS + [f"--virtual-time-budget={budget}", f"--screenshot={out}",
                            f"{URL}?deck={deck}&capture=1&t={i / fps}"],
            stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=60)
    except Exception:
        pass
    return out.exists() and out.stat().st_size > 2000


def main():
    ap = argparse.ArgumentParser()
    ap.add_argument("--deck", default="story", choices=list(DECK_DUR))
    ap.add_argument("--fps", type=int, default=20)
    ap.add_argument("--duration", type=float, default=0.0)   # 0 -> per-deck default
    ap.add_argument("--workers", type=int, default=6)
    ap.add_argument("--budget", type=int, default=1600)
    ap.add_argument("--out", default="")
    ap.add_argument("--encode-only", action="store_true")
    a = ap.parse_args()

    deck = a.deck
    a.out = a.out or str(HERE / f"integrator_{deck}.mp4")
    FRAMES = Path(f"/tmp/frames_{deck}")
    dur = a.duration or DECK_DUR[deck]
    n = int(round(dur * a.fps))
    FRAMES.mkdir(exist_ok=True)
    print(f"duration={dur:.1f}s  fps={a.fps}  frames={n}  workers={a.workers}", flush=True)

    if not a.encode_only:
        t0 = time.time()
        with concurrent.futures.ThreadPoolExecutor(max_workers=a.workers) as ex:
            futs = [ex.submit(shot, i, a.fps, a.budget, FRAMES, deck) for i in range(n)]
            done = ok = 0
            for f in concurrent.futures.as_completed(futs):
                done += 1
                ok += 1 if f.result() else 0
                if done % 40 == 0 or done == n:
                    print(f"  {done}/{n} captured ({ok} ok)  {time.time() - t0:.0f}s", flush=True)
        missing = [i for i in range(n) if not (FRAMES / f"f{i:05d}.png").exists()]
        if missing:
            print(f"  retrying {len(missing)} missing frames serially...", flush=True)
            for i in missing:
                shot(i, a.fps, a.budget + 400, FRAMES, deck)
        missing = [i for i in range(n) if not (FRAMES / f"f{i:05d}.png").exists()]
        print(f"missing after retry: {len(missing)}", flush=True)

    ff = imageio_ffmpeg.get_ffmpeg_exe()
    subprocess.run([ff, "-y", "-framerate", str(a.fps), "-i", str(FRAMES / "f%05d.png"),
                    "-pix_fmt", "yuv420p", "-c:v", "libx264", "-crf", "18",
                    "-preset", "medium", "-movflags", "+faststart", a.out], check=True)
    kb = Path(a.out).stat().st_size // 1000
    print(f"wrote {a.out}  ({kb} KB)", flush=True)


if __name__ == "__main__":
    main()