gaps.cli.execution.kickoff_job#

kickoff_job(ctx, cmd, exec_kwargs)[source]#

Kickoff a single job (a single command execution).

Parameters:
  • ctx (click.Context) – Context object with a .obj attribute that contains at least the following keys:

    NAMEstr

    Job name.

    OUT_DIRpath-like

    Path to output directory.

    COMMAND_NAMEstr

    Name of command being run.

    PIPELINE_STEP: str

    Name of pipeline step being run.

  • cmd (str) – String form of command to kickoff.

  • exec_kwargs (dict) – Keyword-value pairs to pass to the respective submit function. These will be filtered, so they may contain extra values. If some required inputs are missing from this dictionary, a gapsConfigError is raised.

Raises:

gapsConfigError – If exec_kwargs is missing some arguments required by the respective submit function.