babs status: Check job status

Command-Line Arguments

Check job status in a BABS project.

usage: babs status [-h] [--wait | --json] [--wait-interval WAIT_INTERVAL]
                   [PATH]

Positional Arguments

PATH

Absolute path to the root of BABS project. For example, '/path/to/my_BABS_project/' (default is current working directory).

Named Arguments

--wait

Poll until all submitted jobs complete or fail.

--json

Print only a machine-readable JSON summary of job counts to stdout (no human-readable table).

--wait-interval

Seconds between status checks when using --wait.

Warning

Do NOT kill babs status while it's running! Otherwise, new job IDs may not be captured or saved into the job_status.csv!

Example commands

Basic use

When only providing the required argument project_root, you'll only get job status summary (i.e., number of jobs finished/pending/running/failed):

cd /path/to/my_BABS_project
babs status

Machine-readable output

Pass --json to print only a JSON summary of the job counts to stdout (no human-readable table), so tooling can parse it directly:

babs status --json /path/to/my_BABS_project

{"total": 5, "submitted": 5, "unsubmitted": 0, "pending": 0, "running": 0, "completing": 0, "configuring": 0, "done": 5, "failed": 0}

pending, running, completing, and configuring are the live scheduler states (queued / executing / finishing / preparing); done finished with results and failed ended without. total == submitted + unsubmitted always holds. --json cannot be combined with --wait.

Job resubmission

After running babs status, you might see that some jobs are pending or failed, and you'd like to resubmit them.

Run this (in BABS project root) to resubmit all the failed jobs:

babs submit