2.27.2.13. pycsamt.pipeline._report

Pipeline report generators.

make_text_report() produces a compact plain-text summary. make_html_report() produces a self-contained HTML report with per-step cards, timing, plot thumbnails (linked, not embedded), and a processing log.

Functions

make_html_report(pipeline_name, ...[, ...])	Return a self-contained HTML pipeline report.
make_notebook_html(pipeline_name, ...)	Return a compact, scoped HTML fragment for PipelineResult._repr_html_.
make_text_report(pipeline_name, ...)	Return a compact plain-text pipeline summary.

pycsamt.pipeline._report.make_text_report(pipeline_name, step_results, elapsed_sec, outdir, n_sites_in, n_sites_out)

Return a compact plain-text pipeline summary.

Parameters:

• pipeline_name (str)

• step_results (list[StepResult])

• elapsed_sec (float)

• outdir (Path | None)

• n_sites_in (int)

• n_sites_out (int)

Return type:

str

pycsamt.pipeline._report.make_html_report(pipeline_name, step_results, elapsed_sec, outdir, n_sites_in, n_sites_out, pipeline_yaml='')

Return a self-contained HTML pipeline report.

Parameters:

• pipeline_name (str)

• step_results (list[StepResult])

• elapsed_sec (float)

• outdir (Path | None)

• n_sites_in (int)

• n_sites_out (int)

• pipeline_yaml (str)

Return type:

str

pycsamt.pipeline._report.make_notebook_html(pipeline_name, step_results, elapsed_sec, outdir, n_sites_in, n_sites_out)

Return a compact, scoped HTML fragment for PipelineResult._repr_html_.

A quick-glance step table, not a substitute for make_html_report() (no plot thumbnails, no embedded config YAML).

Parameters:

• pipeline_name (str)

• step_results (list[StepResult])

• elapsed_sec (float)

• outdir (Path | None)

• n_sites_in (int)

• n_sites_out (int)

Return type:

str