[us-commits] [ehb54/ultrascan3] 33a5e7: somo/grpy: document the memory cap and progress re...

[emre brookes]

  Branch: refs/heads/ehb54-issue-984
  Home:   https://github.com/ehb54/ultrascan3
  Commit: 33a5e7950ed7181651b20283cf7affb0e0133b8c
      https://github.com/ehb54/ultrascan3/commit/33a5e7950ed7181651b20283cf7affb0e0133b8c
  Author: ehb54 <brookes at uthscsa.edu>
  Date:   2026-08-07 (Fri, 07 Aug 2026)

  Changed paths:
    M us_somo/develop/grpy/README.md
    M us_somo/somo/doc/manual/somo/somo_hydro.html

  Log Message:
  -----------
  somo/grpy: document the memory cap and progress reporting

Docs lagged the last two commits.

Module README gains two sections. The memory cap covers why a caller's
pre-flight refusal has to size the matrix from the full bead count and so
turns away the very models the ladder can handle, what max_beads does about
it, and the two contract points a caller must honour: a capped run reports
mem_capped and is never marked converged, and levels == 0 means there is no
result and the default-constructed Results must not be read.

The progress section records that ShellSolver wraps the ProgressFn it is
given rather than forwarding it per rung -- the reason the caller's bar no
longer restarts several times per model -- that the callback signature is
unchanged and passes through verbatim when disabled, and what on_rung
reports.

The manual gains one sentence in the shell-reduction description: each
calculation in the series is reported as it completes with its bead count and
error estimate, and the progress bar refers to the series as a whole. That is
what a user actually sees, and previously the page implied a single opaque
calculation.

INTEGRATION.md was checked and needs nothing -- it covers the drop-in core
solver and does not mention shell reduction at all.

Page remains pure ASCII under its declared ISO-8859-1 charset.

Fixes ehb54/ultrascan-tickets#984

Co-Authored-By: Claude Opus 5 <noreply at anthropic.com>



To unsubscribe from these emails, change your notification settings at https://github.com/ehb54/ultrascan3/settings/notifications