check_soda_run_folder

soda_analyzer.check_soda_run_folder(run_root, *, workflow=None, config_filename='config.ini', soda_exe=None, print_report=True, text_output=True)

Preflight-check a SODA run folder without initializing SODA runtime.

Parameters:

  • run_root (str or pathlib.Path) – SODA run directory containing configuration, inputs, and any output logs.

  • workflow (str, optional) – Workflow to check; None infers it from the run configuration. Default: None.

  • config_filename (str, optional) – SODA configuration filename relative to the run directory. Default: 'config.ini'.

  • soda_exe (str or pathlib.Path, optional) – SODA executable path or shell expression used for the check or generated command. Default: None.

  • print_report (bool, optional) – Print the formatted report in addition to returning its dictionary. Default: True.

  • text_output (bool, optional) – Use a human-readable report when true, or JSON when false. Default: True.

Returns:

dict – Contains ready_to_run, detected workflow, resource_hints, input and executable checks, and diagnostics. No simulation is started.

Notes

The helper reads files and config text only unless soda_exe is provided, in which case it also inspects that executable with ldd. It does not launch SODA, MPI, LAMMPS, ASE calculators, or any workflow-specific runtime.