hepi.resummino.run

Runs Resummino

Module Contents

Classes

ResumminoRunParam

Parameters for running Resummino.

Functions

set_path(p: str)

Set the path to the resummino folder containing the binary in './build/bin'.

get_path() → str

Get Resummino path.

run(params: List[hepi.Input], noskip=False, bar=False, no_parse=False, para=True, skip=True, parse=True, run=True) → dict

Run the passed list of parameters.

_parse(outputs: List[str]) → List[hepi.resummino.result.ResumminoResult]

Parses Resummino output files and returns List of Results.

_queue(params: List[hepi.Input], noskip=False) → List[ResumminoRunParam]

Queues and generates Resummino run files.

_run(rps: List[ResumminoRunParam], bar=True, no_parse=False, para=True)

Runs Resummino per RunParams.

Attributes

resummino_path

resummino folder containing the binary in './build/bin'.
hepi.resummino.run.resummino_path :str = ~/resummino/[source]

resummino folder containing the binary in ‘./build/bin’.

hepi.resummino.run.set_path(p: str)[source]

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

Parameters

str – new Resummino path.

hepi.resummino.run.get_path() → str[source]

Get Resummino path.

Returns

current Resummino path

Return type

str

class hepi.resummino.run.ResumminoRunParam(flags: str, in_path: str, out_path: str, skip=False)[source]

Bases: hepi.run.RunParam

Parameters for running Resummino.

Variables

  • skip (bool) – Skip already performed and stored runs.

  • flags (str) – Additional resummino flags. E.g. ‘–nlo’.

  • in_path (str) – File path of the input file.

  • out_path (str) – File path of the output file.

hepi.resummino.run.run(params: List[hepi.Input], noskip=False, bar=False, no_parse=False, para=True, skip=True, parse=True, run=True) → dict[source]

Run the passed list of parameters.

Parameters

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

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

  • bar (bool) – Display a progressbar.

  • no_parse (bool) – Skip parsing the results. This is the prefered cluster mode, as this function only queues the job.

  • para (bool) – Run jobs in parallel.

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

Returns

combined dictionary of results and parameters. Each member therein is a list.

The dictionary is empty if no_parse is set.

Return type

dict

hepi.resummino.run._parse(outputs: List[str]) → List[hepi.resummino.result.ResumminoResult][source]

Parses Resummino output files and returns List of Results.

Parameters

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

Returns

list of hepi.resummino.result.ResumminoResult

hepi.resummino.run._queue(params: List[hepi.Input], noskip=False) → List[ResumminoRunParam][source]

Queues and generates Resummino run files.

Extends params by input and output files.

Parameters

  • params (list of hepi.Input) – input parameters

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

Returns

Run paramters for usage with _run().

Return type

list of hepi.RunParams

hepi.resummino.run._run(rps: List[ResumminoRunParam], bar=True, no_parse=False, para=True)[source]

Runs Resummino per RunParams.

Parameters

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

  • bar (bool) – Enable info bar.

  • no_parse (bool) – Do not wait for parallel runs to finish.

  • para (bool) – Run jobs in parallel.

Returns

return codes from jobs if no_parse is False.

Return type

list of int