jade.extensions.demo.autoregression_execution.AutoRegressionExecution¶

class jade.extensions.demo.autoregression_execution.AutoRegressionExecution(job, output, output_format='csv')[source]¶

A class used for auto-regression job execution on computer.

Init auto-regression execution class

Parameters:

job (AutoRegressionParameters) – The instance of AutoRegressionParameters
output (str,) – The path to the output directory.
output_format (str,) – The export format of result file, default ‘csv’.

Methods

`collect_results`(output_dir)	Collect result data from output directory.
`create`(_, job, output, **kwargs)	Create instance of `AutoRegressionExecution`
`generate_command`(job, output, config_file[, ...])	Generate command consumed by bash for running auto-regression analysis.
`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 autoregression, and return status code

Attributes

Return the results directory created by the simulation.

property results_directory¶: Return the results directory created by the simulation.

classmethod create(_, job, output, **kwargs)[source]¶: Create instance of AutoRegressionExecution

static generate_command(job, output, config_file, verbose=False)[source]¶

Generate command consumed by bash for running auto-regression analysis.

Parameters:

job (AutoRegressionParameters) – The instance of AutoRegressionParameters.
output (str) – The path to the output directory.
config_file (str,) – The path to the configuration json file of job inputs.
verbose (bool) – True if verbose, otherwise False.

Return type:

str, A command line string

list_results_files()[source]¶: Return a list of result filenames created by the simulation.

static collect_results(output_dir)¶

Collect result data from output directory.