The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

run - job submission script for PBS (Portable Batch System)

SYNOPSIS

  run [command [arguments]]
  run [-h | -m | -v | -l | -e]
    -h  help
    -m  print the manual
    -v  print the version number
    -l  list the current config
    -e  edit the config

DESCRIPTION

run is a small script applying PBS::Client. It aims at making job submission to PBS quick and easy. It reads queueing options from the config file .runrc in the home directory, generate job script and then submit to PBS.

Current config can be listed by the -l option. The -e option is used to create or edit the config, using the editor specified by the EDITOR or VISUAL environment variables.

To submit a command (say ./a.out), simply add run before it, e.g. run ./a.out. Arguments (say arg) of a.out can also be added behind, e.g. run ./a.out arg.

After submission, a job script will be generated. The default name is the command appended by ".sh". After the job is finished, two more files -- output and error file will be generated. They have names "[job name].o[job ID]" and "[job name].e[job ID]" respectively.

CONFIG FILE

Queueing options are declaring in .runrc in the home directory. It assumes being in .ini-style, i.e. of the format

    Parameter_1 = Value_1
    Parameter_2 = Value_2

Spaces beside = are optional. For example:

    queue = delta
    nodes = 2
    cput  = 01:00:00
    mem   = '1gb'

To list the current configuration, use the -l option. To create or edit the config file, use the -e option. The default editor is vi. This can be modified by specifying the environment variable EDITOR or VISUAL.

EXAMPLES

(1) Execute ./a.out
    run ./a.out
(2) Execute ./a.out -a arg1 -b arg2 arg3
    run ./a.out -a arg1 -b arg2 arg3
(3) Execute ./a.out > /tmp/a.dat
    run ./a.out \> /tmp/a.dat

or

    run "./a.out > /tmp/a.dat"

REQUIREMENTS

PBS::Client

BUGS

Perhaps many, but none is found yet. Bugs and suggestions please email to kwmak@cpan.org

AUTHOR(S)

Ka-Wai Mak <kwmak@cpan.org>