Skip to content

For Reviewers

This documentation site is annotated with Hypothes.is, a W3C Web Annotation client. Reviewers can leave inline comments on any equation, parameter value, or block of text without leaving the page.

Quick start

  1. Sign up for a free account at hypothes.is (skip if you already have one).
  2. Join the Ti-64 review group at https://hypothes.is/groups/q395RE7G/ti64-smracap. The Hypothes.is sidebar on this site only posts into this group; if you aren't a member you'll see a "join this group" prompt instead of a comment box.
  3. Open any page on this site. A small annotation widget appears on the right edge (three stacked icons).
  4. Click the < icon to open the sidebar, then sign in.
  5. Select any text — a parameter's nominal value, a function name, an equation, a sentence — and choose Annotate (post to the group) or Highlight (private, only you see it).
  6. Type your comment and click Post.

Annotations save instantly; you can edit or delete your own at any time from the sidebar.

Visibility

Annotations are confined to the private Ti-64 group. The sidebar is configured to post only into that group — Public and any other groups are hidden — so reviewers can't accidentally publish their comments to the open Hypothes.is layer. Combined with the Cloudflare Access policy that gates the site URL, this keeps the review confidential to invited group members.

Reading the parameter tables

Each requirement_* flow on the process pages is followed by a sortable table of the parameters that feed its equation:

  • Nominal value is the value used for the deterministic baseline — by default the pooled mean across the cited sources (or the placeholder value where a parameter is not yet sourced), or a value the analyst pins explicitly via the nominal: key in parameters.yaml.
  • Distribution summarises the per-source stats_arrays distributions used for Monte-Carlo uncertainty; the full schema is documented with each parameters.yaml.
  • Source(s) link to the Bibliography.

What to comment on

The inventory is defined by a few layers worth scrutinising:

  • The flow equations and sourced parameters on the process pages — Plasma Arc Welding, Transport, Vacuum Arc Remelting. Each requirement_* flow shows its equation and a table of parameters (nominal value, distribution, and the literature source each cites).
  • The composition on the Functional Unit page — how welding, transport, and VAR combine per 1 kg of ingot.
  • The material properties and their citations on the Material page.
  • The references themselves on the Bibliography page.

Useful prompts for a review comment:

  • Is this nominal value, distribution, or unit appropriate for the source it cites?
  • Does the equation match the cited source (and the code)?
  • Are there missing inputs or flows — a foreground exchange not currently modelled?
  • Is the scope accurate (what's included vs. excluded)?
  • Is a parameter still an unsourced placeholder that needs a citation?

Limitations

  • Hypothes.is only works on the HTML version of this site.
  • Anchoring is robust to small text changes but can break if a paragraph is rewritten substantially. An "orphan" annotation means the underlying text changed since the comment was made — open the orphan and use the quoted excerpt to re-locate the passage.
  • Each released version is published at an immutable URL (/v0.1.0/, /v0.2.0/, …), so annotations stay pinned to the exact text they were applied to. See DEPLOY.md for the versioning scheme.