tud_lbm.io.plotting.run_comparison
==================================

.. py:module:: tud_lbm.io.plotting.run_comparison

.. autoapi-nested-parse::

   Cross-run comparison plots and batch CSV-export CLI entry point.



Functions
---------

.. autoapisummary::

   tud_lbm.io.plotting.run_comparison.compare_runs
   tud_lbm.io.plotting.run_comparison.process_parent_dir
   tud_lbm.io.plotting.run_comparison.main


Module Contents
---------------

.. py:function:: compare_runs(parent_dir: str | pathlib.Path) -> None

   Generate comparison scatter plots across all processed runs.

   Reads ``simulation_data.csv`` files produced by :func:`build_simulation_csv`
   from every run directory under *parent_dir* and writes plots to
   ``<parent_dir>/comparison_analysis/``.

   :param parent_dir: Parent directory that contains the individual run directories.


.. py:function:: process_parent_dir(parent_dir: str | pathlib.Path, fields: list[str] | None = None) -> tuple[int, int]

   Discover runs, export per-run CSVs, and generate comparison plots.

   Discovers runs by searching for ``config.toml`` files recursively.
   Skips directories whose path contains ``"init"`` or ``"comparison_analysis"``.
   Writes ``simulation_data.csv`` per run, then generates 8 comparison plots
   when at least one run produced CSV data.

   :param parent_dir: Absolute or relative path to the parent directory.
   :param fields: Comparison operator names to run as per-run analysis plots.
                  When ``None``, no per-run analysis plots are generated beyond the CSV.

   :returns: A tuple ``(n_runs_found, n_runs_with_csv)``.


.. py:function:: main(parent_dir: str | None = None) -> None

   Script entry point for batch CSV export and run comparison plots.