jade.jobs.job_execution_interface.JobExecutionInterface

class jade.jobs.job_execution_interface.JobExecutionInterface

Bases: ABC

Interface definition for simulations.

Methods

collect_results(output_dir)	Collect result data from output directory.
create(job_inputs, job, output)	Creates an instance of a JobExecutionInterface.
generate_command(job, output, config_file[, ...])	Generate a command for a job to be run in a subprocess.
list_results_files()	Return a list of result filenames created by the simulation.
post_process(**kwargs)	Run post-process operations on data.
run()	Runs the simulation.

Attributes

results_directory

Return the results directory created by the simulation.

static collect_results(output_dir)

Collect result data from output directory.

Parameters:

output_dir (str)

Return type:

list of dict

abstract classmethod create(job_inputs, job, output)

Creates an instance of a JobExecutionInterface.

abstract static generate_command(job, output, config_file, verbose=False)

Generate a command for a job to be run in a subprocess.

Parameters:

• job (class.parameters_type)

• output (str) – output directory

• config_file (str) – job configuration file

Returns:

command that can be executed in the OS

Return type:

str

abstract property results_directory

Return the results directory created by the simulation.

abstract list_results_files()

Return a list of result filenames created by the simulation.

abstract post_process(**kwargs)

Run post-process operations on data.

abstract run()

Runs the simulation.