convert_native_ezga_multi_agent_run_setup_to_soda

soda_analyzer.convert_native_ezga_multi_agent_run_setup_to_soda(agent_setups, output_root, *, agent_dir='agents', config_filename='config.ini', hdf5_output_path='', memory_cap_mb=0, worker_groups=None, sage_structure_fields=None, sage_structure_missing_policy=None, trusted_import_prefixes=(), allow_filesystem_imports=False, ezga_config_options=None, overwrite=False, strict=True, print_report=True, text_output=True)

Convert multiple native EZGA agent setups into one SODA run folder.

Parameters:

  • agent_setups (sequence of str or pathlib.Path or dict) – One native-root path per agent, or mappings containing native_root and optional single-agent converter arguments.

  • output_root (str or pathlib.Path) – Destination directory for the converted SODA run setup.

  • agent_dir (str, optional) – Subdirectory for per-agent files in the generated run directory. Default: 'agents'.

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

  • hdf5_output_path (str, optional) – HDF5 output setting written to the SODA configuration; empty uses the runtime default. Default: ''.

  • memory_cap_mb (int, optional) – Memory cap in MB shared by all EZGA agents. Returned as the --ezga_memory_cap_mb launch option, not an [EZGA] configuration key; zero leaves the default unchanged. Default: 0.

  • worker_groups (int, optional) – Retired compatibility argument. A supplied value produces a diagnostic and is not written to config.ini; use the SODA MPI rank layout to control worker capacity. Default: None.

  • sage_structure_fields (sequence of str, optional) – Optional SAGE structure fields to preserve; None uses the default field policy. Default: None.

  • sage_structure_missing_policy (str, optional) – Missing-field policy for requested optional SAGE structure data. Default: None.

  • trusted_import_prefixes (sequence of str, optional) – Explicit module prefixes trusted when validating native configuration imports. Default: ().

  • allow_filesystem_imports (bool, optional) – Allow filesystem-based imports during native configuration admission. Default: False.

  • ezga_config_options (dict, optional) – Additional EZGA configuration options applied to the generated setup. Default: None.

  • overwrite (bool, optional) – Allow replacement of existing destination files. Default: False.

  • strict (bool, optional) – Reject unsupported or inconsistent input rather than accepting a partial conversion. 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 agent_reports, agent_config_inis, written_files, shared configuration options, ready_to_run, and diagnostics.

Notes

Each agent setup may be a native-root path or a mapping with native_root plus optional single-agent converter arguments such as native_config_file and structure_file. The converter writes a root multi-agent config.ini and one child SODA config per agent. It does not materialize native EZGA objects or launch SODA.