1 reporting.scorer.mac_q1_research

reporting.scorer.mac_q1_research

Persist a source-bound research interpretation of completed Mac Q1 fits.

This standalone campaign adapter uses the shared immutable result, notation and Plotly contracts. It keeps human interpretation in a hash-pinned research context and never changes native campaign admission, checkpoints or validation gates. Figures consume already reduced tables; canonical equations are compiled from the Typst owners and frozen alongside their generated TeX projections.

1.1 Functions

Name Description
read_mac_q1_publication Cold-admit a portable Q1 publication against an independent manifest pin.
read_mac_q1_publication_with_assets Return admitted scientific results and their exact authenticated bytes.
read_mac_q1_research_report Cold-validate an exported bundle without reading producer data or running inference.
write_mac_q1_publication Atomically compact admitted frozen publication bytes without recomputation.
write_mac_q1_research_report Build and atomically replace a standalone research bundle.

1.1.1 read_mac_q1_publication

reporting.scorer.mac_q1_research.read_mac_q1_publication(
    bundle,
    *,
    expected_manifest_sha256,
)

Cold-admit a portable Q1 publication against an independent manifest pin.

1.1.1.1 Parameters

Name Type Description Default
bundle Path Directory containing a complete public v1 or compact v2 product. required
expected_manifest_sha256 str SHA-256 obtained outside this candidate from frozen evidence or an independently pinned source revision. required

1.1.1.2 Returns

Name Type Description
ReportSnapshot Complete immutable tables and Plotly inputs, preserving their original
ReportSnapshot scientific digest. Native-parent hashes are attribution only: omitted
ReportSnapshot evaluations, checkpoints and controller receipts are not authenticated.

1.1.1.3 Raises

Name Type Description
ValueError The external pin, inventory, snapshot, displayed evidence, attribution, privacy or local-link contract fails. This does not admit a public projection as a private native research bundle.

1.1.2 read_mac_q1_publication_with_assets

reporting.scorer.mac_q1_research.read_mac_q1_publication_with_assets(
    bundle,
    *,
    expected_manifest_sha256,
)

Return admitted scientific results and their exact authenticated bytes.

The mapping includes the pinned manifest and all inventory files. Delivery consumers must use these detached bytes rather than reopen candidate paths. Native-parent hashes retain the attribution-only meaning documented by read_mac_q1_publication.

1.1.3 read_mac_q1_research_report

reporting.scorer.mac_q1_research.read_mac_q1_research_report(
    bundle,
    *,
    expected_manifest_sha256=None,
)

Cold-validate an exported bundle without reading producer data or running inference.

1.1.4 write_mac_q1_publication

reporting.scorer.mac_q1_research.write_mac_q1_publication(
    source,
    target,
    *,
    expected_manifest_sha256,
    readme=None,
    reader_edition=False,
)

Atomically compact admitted frozen publication bytes without recomputation.

1.1.4.1 Parameters

Name Type Description Default
source Path Frozen public v1/v2 input, admitted before any output mutation. required
target Path Disjoint directory, or the same explicitly owned publication. Proper ancestors/descendants of the source are rejected before any output mutation, including aliases through parent symlinks. required
expected_manifest_sha256 str Independent source-manifest trust anchor. required
reader_edition bool Produce a new responsive reading path while preserving all native tables, plotted bytes and source interpretation. False
readme Path | None Optional authored delivery instructions; scientific snapshot, context, mission, HTML and displayed bytes remain unchanged. None

1.1.4.2 Returns

Name Type Description
Path Published HTML path. V2 retains one analysis snapshot, authored context,
Path mission, README, manifest, self-contained HTML and chart SVGs. Equation
Path renders remain inline; all original tables and Plotly inputs remain
Path recoverable from the shared snapshot. Source bytes are never modified
Path unless source and target explicitly name the same owned publication.

1.1.5 write_mac_q1_research_report

reporting.scorer.mac_q1_research.write_mac_q1_research_report(
    saved_report,
    context_path,
    destination,
    *,
    root,
)

Build and atomically replace a standalone research bundle.

The context pins the native report bytes and supplies interpreted findings, competing mechanisms and prospective actions. Those words cannot silently follow a changed fit. The native report and runtime evidence stay read-only. All analysis and figure assets are sealed with shared ReportSnapshot types; the existing generic recipe-driven exporter is not impersonated.

Back to top