suggest_soda_run_command

soda_analyzer.suggest_soda_run_command(run_root, *, launcher='auto', profile='generic', workflow=None, config_filename='config.ini', nodes=None, total_cpus=None, num_worker=None, cpus_per_worker=None, gpus_per_node=None, num_gpu_workers=None, time_limit=None, job_name='SODA', soda_exe='$SODA_ROOT/build/$BUILD_NAME/soda', outputdir=None, extra_args=None, check_run_folder=True, print_report=True, text_output=True)

Suggest local, MPI, or Slurm command text for a prepared SODA run folder.

Parameters:

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

  • launcher (str, optional) – Launch style: auto, local, mpirun, or slurm. Automatic selection uses the profile default. Default: 'auto'.

  • profile (str, optional) – Resource profile: generic, laptop, raven, or viper. Default: 'generic'.

  • 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'.

  • nodes (int, optional) – Number of compute nodes; None uses the selected profile or resource inference. Default: None.

  • total_cpus (int, optional) – CPU cores available per node, including the SODA server allocation. Default: None.

  • num_worker (int, optional) – Number of SODA workers per node, excluding the server rank. Default: None.

  • cpus_per_worker (int, optional) – CPU cores allocated to each worker. Default: None.

  • gpus_per_node (int, optional) – Available GPU count per compute node. Default: None.

  • num_gpu_workers (int, optional) – Number of GPU workers per node. Default: None.

  • time_limit (str, optional) – Scheduler wall-time limit included in generated submission text. Default: None.

  • job_name (str, optional) – Scheduler job name. Default: 'SODA'.

  • soda_exe (str or pathlib.Path, optional) – SODA executable path or shell expression used for the check or generated command. Default: '$SODA_ROOT/build/$BUILD_NAME/soda'.

  • outputdir (str or pathlib.Path, optional) – Output-directory argument included in the generated command. Default: None.

  • extra_args (str or sequence of str, optional) – Additional SODA command-line arguments. Default: None.

  • check_run_folder (bool, optional) – Include a run-folder preflight report before suggesting the command. Default: True.

  • 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 generated shell text in commands, resource assumptions, diagnostics, and optional preflight results. Commands are not executed or submitted.