Skip to main content

Module study

Module study 

Source
Expand description

study mode: run a crate::suite::Suite into one aggregated, comparable artifact.

Today a run is one scenario → one report. A study is a named SET of scenarios run together into one JSON artifact plus a self-contained side-by-side comparison HTML. This is the spine every commercial “study report” sits on.

This module does not re-implement scenario running: it calls the existing engine, crate::api::run_toml, once per scenario and parses the per-scenario crate::report::RunResult back out of the returned JSON. Aggregation is pure and deterministic — no clock is read here (a generated timestamp, if any, is the CLI’s job, via crate::report::StudyMeta). Running a suite therefore yields per-scenario figures of merit byte-identical to running each scenario alone through run_toml.

Structs§

StudyOutput
The outputs of a study: the aggregated JSON artifact, a self-contained comparison HTML, and a one-line summary. Mirrors the shape/spirit of crate::api::RunOutput.

Functions§

run_suite
Run every scenario in suite (resolved against base_dir) through the engine and aggregate the results into a StudyOutput.