Vivarium Worker

Worker executable for running simulation jobs.

class vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.ParallelSimulationContext(model_specification=None, components=None, configuration=None, plugin_configuration=None, sim_name=None, logging_verbosity=1)[source]

A parallel simulation context.

This is identical to SimulationContext except that it does not write out the results to disk in order to allow them to be batch-written.

Parameters:

model_specification (str | Path | LayeredConfigTree | None)
components (list[Component] | dict[str, Any] | LayeredConfigTree | None)
configuration (dict[str, Any] | LayeredConfigTree | None)
plugin_configuration (dict[str, Any] | LayeredConfigTree | None)
sim_name (str | None)
logging_verbosity (int)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.work_horse(job_parameters)[source]

Return type:: dict[str, DataFrame]
Parameters:: job_parameters (JobParameters)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.get_backup(job_parameters)[source]

Return type:: ParallelSimulationContext | None
Parameters:: job_parameters (JobParameters)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.get_sim_from_backup(event, backup)[source]

Return type:

tuple[ParallelSimulationContext, dict[str, float]]

Parameters:

event (dict[str, float])
backup (ParallelSimulationContext)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.initialize_new_sim(event, job_parameters)[source]

Return type:

tuple[ParallelSimulationContext, dict[str, float]]

Parameters:

event (dict[str, float])
job_parameters (JobParameters)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.run_simulation(job_parameters, event, sim, exec_time)[source]

Return type:

Path

Parameters:

job_parameters (JobParameters)
event (dict[str, float])
sim (ParallelSimulationContext)
exec_time (dict[str, float])

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.get_sim_results(sim, job_parameters, start_snapshot, event, exec_time)[source]

Return type:

dict[str, DataFrame]

Parameters:

sim (ParallelSimulationContext)
job_parameters (JobParameters)
start_snapshot (CounterSnapshot)
event (dict[str, float])
exec_time (dict[str, float])

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.do_sim_epilogue(start, end, event, exec_time, parameters)[source]

Return type:

None

Parameters:

start (CounterSnapshot)
end (CounterSnapshot)
event (dict[str, float])
exec_time (dict[str, float])
parameters (JobParameters)

vivarium_cluster_tools.psimulate.worker.vivarium_work_horse.remove_backups(backup_path)[source]

Return type:: None
Parameters:: backup_path (Path)