Command Line

The lev command line application that is used to submit API commands, retrieve the results, and check the status of running jobs.

Submitting Jobs

A job can be submitted with a command like this:

lev engine submit <job type> <job options>

Where <job type> and <job options> vary depending on the job being submitted. See the specific documentation section for details.

The command will return a job ID and the username that the job was submitted under. The job ID is a unique ID which can be used to retrieve the results later.

the option --comment can be used to add a human readable comment to your job, this can be used to annotate jobs with information about the experiment being run, to make them easier to track.

Retrieving Results

To get the results of a completed job, run the following command:

lev engine get <job id> --output-dir <output directory>

Where <job id> is the ID of the job and <output directory> is the directory results should be output to. The output directory will be created if it does not already exist. If the job is still Running, you cannot get the results yet and the command will exit.

Listing running jobs

To list the currently running jobs, run the following command:

lev engine list

This will result in a table listing the Job ID, status, age of the job, comments, and the options the job was run with.

Deleting jobs

To delete completed jobs, run the following command:

lev engine delete <job id>

where <job id> is the ID of a submitted job.

Commands

  • Submit a job: lev engine submit <job type> <job options> --option
    • Example: lev engine submit relax input.pdb --repeats 10 (relax input.pdb ten times)
  • List submitted jobs: lev engine list
    • Example: lev engine list | head -n 20 (list the most recent 20 results)
  • Download a job: lev engine get <job id> --output-dir <output directory>
    • Example: lev engine get relax-9dn30 --output-dir relax_results (Download that relax job results to relax_results)
  • Cancel a job: lev engine delete <job id>
    • Example: lev engine delete relax-9dn30 (Cancel that relax job)
  • See a job’s cost: lev billing workflow get <job id>
    • Example: lev billing workflow get relax-9dn30 (Get the cost of that relax job)

Updated: