[us-commits] [ehb54/ultrascan3] 501aba: somo/grpy: document how to read ShellReport

[emre brookes]

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

  Changed paths:
    M us_somo/develop/grpy/README.md

  Log Message:
  -----------
  somo/grpy: document how to read ShellReport

The README covered the fields that decide what happened (converged,
unreduced, mem_capped, viscosity_unreliable) but not the ones a caller
actually reads out. Adds a field table.

The points that are not guessable from the names: err_est, extrapolated and
k_obs are parallel to require, not to anything else; k_obs == 0 means
extrapolation was declined, so err_est is the raw inter-rung gap and
extrapolated holds the final rung's value rather than an extrapolated one;
and run() returns the final rung's Results verbatim, so the extrapolated
values live only in the report -- deliberately, since overwriting the scalars
would contradict the report text embedded in them.

Also states that only `unreduced` licenses treating a result as exact.

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