hepi.run.run

Classes

RunParam	Abstract class that is similar to a dictionary but with fixed keys.
Runner

Module Contents

class hepi.run.run.RunParam(skip=False, in_file=None, out_file=None, execute=None, name=None)

Bases: hepi.util.DictData

Abstract class that is similar to a dictionary but with fixed keys.

Parameters:

• skip (bool)

• in_file (str)

• out_file (str)

• execute (str)

• name (str)

name = None

skip = False

in_file = None

out_file = None

execute = None

class hepi.run.run.Runner(path, in_dir=None, out_dir=None, pre=None)

Parameters:

• path (str)

• in_dir (str)

• out_dir (str)

path

orders()

List of supported Orders in this runner.

Return type:

List[hepi.input.Order]

get_name()

Returns the name of the runner.

Return type:

str

get_version()

Return type:

str

_sub_run(coms)

Parameters:

coms (List[str])

Return type:

str

_check_path()

Checks if the passed path is valid.

Return type:

bool

_prepare(p, skip=False, assume_valid=False, **kwargs)

Parameters:

p (hepi.input.Input)

Return type:

RunParam

_check_input(param, **kwargs)

Parameters:

param (hepi.input.Input)

Return type:

bool

_prepare_all(params, skip=True, n_jobs=None, **kwargs)

Prepares all parameters for execution.

Parameters:

• params (List[hepi.Input]) – List of input parameters.

• skip (bool, optional) – If True, the runner will check if the output file already exists and skip the execution if it does. Defaults to True.

• n_jobs (int) – Number of parallel jobs. If None, use all available cores.

Return type:

List[RunParam]

run(params, skip=True, parse=True, parallel=True, sleep=0, run=True, ignore_error=False, n_jobs=None, **kwargs)

Run the passed list of parameters.

Parameters:

• params (list of hepi.Input) – All parameters that should be executed/queued.

• skip (bool) – True means stored runs will be skipped. Else the are overwritten.

• parse (bool) – Parse the results. This is not the prefered cluster/parallel mode, as there the function only queues the job.

• parallel (bool) – Run jobs in parallel.

• sleep (int) – Sleep seconds after starting job.

• run (bool) – Actually start/queue runner.

• ignore_error (bool) – Continue instead of raising Exceptions. Also ignores hash collisions.

• n_jobs (int) – Number of parallel jobs. If None, use all available cores.

Returns:

combined dataframe of results and parameters. The dataframe is empty if parse is set to False.

Return type:

pd.DataFrame

_run(rps, wait=True, parallel=True, sleep=0, n_jobs=None, **kwargs)

Runs Runner per RunParams.

Parameters:

• rps (list of RunParams) – Extended run parameters.

• bar (bool) – Enable info bar.

• wait (bool) – Wait for parallel runs to finish.

• sleep (int) – Sleep seconds after starting subprocess.

• parallel (bool) – Run jobs in parallel.

• n_jobs (int) – Number of parallel jobs. If None, use all available cores.

Returns:

return codes from jobs if no_parse is False.

Return type:

list of int

_is_valid(file, p, d, **kwargs)

Verifies that a file is a complete output.

Parameters:

• file (str) – File path to be parsed.

• p (hepi.Input) – Onput parameters.

• d (dict) – Param dictionary.

Returns:

True if file could be parsed.

Return type:

bool

parse(outputs, n_jobs=None)

Parses Resummino output files and returns List of Results.

Args:

outputs (list of str): List of the filenames to be parsed.

n_jobs (int): Number of parallel jobs. If None, use all available cores.

Returns:

list of hepi.resummino.result.ResumminoResult

Parameters:

outputs (List[str])

Return type:

List[hepi.results.Result]

_parse_file(file)

Extracts results from an output file.

Parameters:

file (str) – File path to be parsed.

Returns:

If a value is not found in the file None is used.

Return type:

Result

get_path()

Get the Runner path.

Returns:

current Runner path.

Return type:

str

get_input_dir()

Get the input directory.

Returns:

in_dir

Return type:

str

get_output_dir()

Get the input directory.

Returns:

out_dir

Return type:

str

get_pre()

Gets the command prefix.

Returns:

pre

Return type:

str

set_path(p)

Set the path to the Runner folder containing the binary in ‘./bin’ or ‘./build/bin’.

Parameters:

p (str) – new path.

set_input_dir(indir)

Sets the input directory.

Parameters:

indir (str) – new input directory.

set_output_dir(outdir, create=True)

Sets the output directory.

Parameters:

• outdir (str) – new output directory. create (bool): create directory if not existing.

• create (bool)

set_pre(ppre)

Sets the command prefix.

Parameters:

ppre (str) – new command prefix.