1 reporting.explanations

reporting.explanations

Presentation-free scientific narratives shared by domain figures and clients.

Domain owners supply interpretation and canonical notation identifiers; clients render them without redefining metrics or copying equations from the thesis.

1.1 Classes

Name Description
ExplanationSection One optional narrative passage, not a mandatory interpretation checklist.
ScientificExplanation Interpret one result using its factual population and canonical theory.

1.1.1 ExplanationSection

reporting.explanations.ExplanationSection(title, body)

One optional narrative passage, not a mandatory interpretation checklist.

1.1.1.1 Attributes

Name Description
title Short heading identifying the conceptual point.
body Markdown narrative explaining the point and its scientific limitations.

1.1.2 ScientificExplanation

reporting.explanations.ScientificExplanation(
    question,
    answer,
    sections,
    evidence_role,
    source_fields,
    theory=None,
    external_references=(),
)

Interpret one result using its factual population and canonical theory.

1.1.2.1 Attributes

Name Description
question Scientific question addressed by this particular result.
answer Concise interpretation, without implying an unsupported causal conclusion.
sections Only the narrative passages needed to understand this result.
evidence_role Whether evidence is actor-visible, privileged, derived, or provenance.
source_fields Exact fields underlying the figure or metric.
theory Identifiers resolved from the generated canonical Typst notation registry.
external_references Relevant primary-source titles and browser-accessible URLs.
Back to top