Command line interface

Command line interface#

dpdispatcher: Generate HPC scheduler systems jobs input scripts, submit these scripts to HPC systems, and poke until they finish

usage: dpdisp [-h] {submission,gui,run,submit} ...

Valid subcommands#

command

Possible choices: submission, gui, run, submit

Sub-commands#

submission#

Handle terminated submission.

dpdisp submission [-h] [--download-terminated-log] [--download-finished-task]
                  [--clean] [--reset-fail-count]
                  SUBMISSION_HASH

Positional Arguments#

SUBMISSION_HASH

Submission hash to download.

Actions#

One or more actions to take on submission.

--download-terminated-log

Download log files of terminated tasks.

Default: False

--download-finished-task

Download finished tasks.

Default: False

--clean

Clean submission.

Default: False

--reset-fail-count

Reset fail count of all jobs to zero.

Default: False

gui#

Serve DP-GUI.

dpdisp gui [-h] [-p PORT] [--bind_all]

Named Arguments#

-p, --port

The port to serve DP-GUI on.

Default: 6042

--bind_all

Serve on all public interfaces. This will expose your DP-GUI instance to the network on both IPv4 and IPv6 (where available).

Default: False

run#

Run a Python script.

dpdisp run [-h] [--allow-ref] filename

Positional Arguments#

filename

Python script to run. PEP 723 metadata should be contained in this file.

Named Arguments#

--allow-ref

Allow loading external JSON/YAML snippets through $ref. Disabled by default for security.

Default: False

submit#

Submit a submission from a JSON file.

dpdisp submit [-h] [--dry-run] [--exit-on-submit] [--allow-ref] filename

Positional Arguments#

filename

JSON file containing submission configuration.

Named Arguments#

--dry-run

Only upload files without submitting.

Default: False

--exit-on-submit

Exit after submitting without waiting for completion.

Default: False

--allow-ref

Allow loading external JSON/YAML snippets through $ref. Disabled by default for security.

Default: False

Contents