psimulate Runner

The main process loop for psimulate runs.

vivarium_cluster_tools.psimulate.runner.report_initial_status(num_jobs_completed, finished_sim_metadata, total_num_jobs)[source]
Return type:

None

Parameters:

  • num_jobs_completed (int)

  • finished_sim_metadata (DataFrame)

  • total_num_jobs (int)

vivarium_cluster_tools.psimulate.runner.try_run_vipin(output_paths)[source]
Return type:

None

Parameters:

output_paths (OutputPaths)

vivarium_cluster_tools.psimulate.runner.write_backup_metadata(backup_metadata_path, job_parameters_list)[source]
Return type:

None

Parameters:
vivarium_cluster_tools.psimulate.runner.write_configuration(output_root, command, input_paths, native_specification, max_workers, max_attempts, backup_freq, extra_args)[source]

Write the resolved run configuration to a YAML file in the output directory.

This creates a configuration.yaml file that records all of the parameters used for the run. The file is written in a format that is directly usable with psimulate <command> --run-config configuration.yaml so that previous runs can be easily reproduced.

Return type:

None

Parameters:

  • output_root (Path) – The root output directory for the simulation run.

  • command (str) – The psimulate sub-command (e.g. "run", "restart", "expand").

  • input_paths (InputPaths) – The resolved input file paths.

  • native_specification (NativeSpecification) – The cluster resource specification.

  • max_workers (int) – Maximum number of concurrent workers.

  • max_attempts (int) – Maximum number of Jobmon task attempts.

  • backup_freq (int | None) – Interval in seconds between saving backups, or None to disable.

  • extra_args (dict[str, Any]) – Additional command-specific arguments (e.g. sim_verbosity, num_draws, num_seeds).

vivarium_cluster_tools.psimulate.runner.main(command, input_paths, native_specification, max_workers, max_attempts, backup_freq, extra_args)[source]
Return type:

None

Parameters: