meanap.pipeline.report

Self-contained HTML output viewer for a MEA-NAP pipeline run.

Walks an output folder (the same tree output_folders.py creates) and writes a single report.html that lets you browse it — a folder tree on the left, an image gallery on the right, with a caption under each plot explaining what it shows. No server or external JS/CSS needed; opening the file directly in a browser works, including over file://.

Functions

describe_data_file(filename)

describe_folder(name)

describe_plot(filename)

Returns (title, caption) for a known plot filename, else None.

generate_report(output_root[, out_path])

Build report.html for a MEA-NAP output folder.

meanap.pipeline.report.describe_data_file(filename)[source]
Parameters:

filename (str)

Return type:

str | None

meanap.pipeline.report.describe_folder(name)[source]
Parameters:

name (str)

Return type:

str | None

meanap.pipeline.report.describe_plot(filename)[source]

Returns (title, caption) for a known plot filename, else None.

Parameters:

filename (str)

Return type:

tuple[str, str] | None

meanap.pipeline.report.generate_report(output_root, out_path=None)[source]

Build report.html for a MEA-NAP output folder. Returns its path.

Parameters:
  • output_root (Path | str)

  • out_path (Path | str | None)

Return type:

Path