From b577499b41b94b115ae4c45bcfd5701d45afa8df Mon Sep 17 00:00:00 2001 From: Walter Simson Date: Thu, 16 Jul 2026 15:01:46 +0000 Subject: [PATCH 1/2] docs: add benchmark results matrix to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a Benchmarks section to the front-page README with a 10-row matrix covering (backend, OS, accelerator) combinations against three grid sizes (64³, 128³, 256³). All cells ship empty (em-dash) as a scaffold — contributors fill rows via follow-up commits with their hardware, k-wave-python version, and BINARY_VERSION. Co-Authored-By: Claude Opus 4.7 --- docs/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/README.md b/docs/README.md index c4d28c7e..2bd3baa7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,25 @@ uv run examples/ivp_homogeneous_medium.py No GPU required — all examples run on CPU with NumPy. +## Benchmarks + +Reference runtimes for the 3D scaling benchmark in [`benchmarks/benchmark.py`](../benchmarks/README.md). Values are total elapsed seconds for a single default run (3D initial-value problem, heterogeneous absorbing medium, 1000 timesteps, averaged over 3 repeats). + +| Backend | OS | Accelerator | 64³ | 128³ | 256³ | Hardware | +|---------|-----------------------|-------------------|-----|------|------|----------| +| python | Linux | CPU | — | — | — | — | +| python | Linux | NVIDIA GPU | — | — | — | — | +| python | macOS (Apple Silicon) | CPU | — | — | — | — | +| python | Windows | CPU | — | — | — | — | +| python | Windows | NVIDIA GPU | — | — | — | — | +| cpp | Linux | CPU (OMP) | — | — | — | — | +| cpp | Linux | NVIDIA GPU (CUDA) | — | — | — | — | +| cpp | macOS (Apple Silicon) | CPU (OMP) | — | — | — | — | +| cpp | Windows | CPU (OMP) | — | — | — | — | +| cpp | Windows | NVIDIA GPU (CUDA) | — | — | — | — | + +Contributions welcome — open a PR filling a row with your k-wave-python version, and (for `cpp` backend) `BINARY_VERSION`. See [`benchmarks/README.md`](../benchmarks/README.md) for the reproducer command. + ## Installation Using [uv](https://docs.astral.sh/uv/) (recommended): From 9451b8a70426337c55aa6a3d5df1a1167a2992e7 Mon Sep 17 00:00:00 2001 From: Walter Simson Date: Thu, 16 Jul 2026 09:07:42 -0700 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20fill=20python/macOS/CPU=2064=C2=B3?= =?UTF-8?q?=20benchmark=20row=20(81s,=20M1)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Measured on Apple M1 MacBook Air (8 GB) against k-wave-python 0.6.3rc1: 64³ = 81 s (python backend, CPU, 1000 timesteps, 3 averages). 128³/256³ left empty — 256³ exceeds 8 GB RAM on this machine. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 2bd3baa7..b60ffb01 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,7 +30,7 @@ Reference runtimes for the 3D scaling benchmark in [`benchmarks/benchmark.py`](. |---------|-----------------------|-------------------|-----|------|------|----------| | python | Linux | CPU | — | — | — | — | | python | Linux | NVIDIA GPU | — | — | — | — | -| python | macOS (Apple Silicon) | CPU | — | — | — | — | +| python | macOS (Apple Silicon) | CPU | 81 | — | — | Apple M1, 8 GB | | python | Windows | CPU | — | — | — | — | | python | Windows | NVIDIA GPU | — | — | — | — | | cpp | Linux | CPU (OMP) | — | — | — | — |