Search

Categories

Documents

LSF - A perl API built on top of the LSF command line tools

• NAME
• SYNOPSIS
• DESCRIPTION
• CLASS METHODS
• HISTORY
• SEE ALSO
• AUTHOR
• COPYRIGHT

NAME

LSF - A perl API built on top of the LSF command line tools

SYNOPSIS

    use LSF;
    use LSF RaiseError => 1, PrintError => 1, PrintOutput => 1;

DESCRIPTION

NOTE: FOR THESE MODULES TO WORK IT IS ESSENTIAL THAT YOU INCLUDE THE LSF COMMAND LINES IN YOUR PATH.

This is the base class of the LSF suite of modules. 'use LSF' will also preload all of the LSF modules at one time. Currently this includes:

      LSF::Job
      LSF::JobHistory
      LSF::JobGroup
      LSF::Queue
      LSF::JobManager

Two error reporting strategies are available and can be set globally via the 'use LSF' statement or individually in each of the LSF modules. By setting the 'RaiseError' directive to true, or by using the RaiseError class method, the LSF modules will die on error, otherwise they will return false, setting $? to the exit value and $@ to the stderr of the LSF command line. Additionally the printing of LSF command line stdout and stderr can be controlled via the 'PrintOutput' and 'PrintError' directives or class methods of the same names. Defaults are as above.

For more information on any of these modules, please see its respective documentation.

CLASS METHODS

LSF()

Returns the LSF version string

RaiseError( [ [ TRUE or FALSE ] ] )

Controls whether LSF command line errors will be thrown. The default is FALSE. When called with no arguments returns the current value.

PrintError( [ [ TRUE or FALSE ] ] )

Controls printing to STDERR the stderr of the LSF command line. The default is TRUE. When called with no arguments returns the current value.

PrintOutput( [ [ TRUE or FALSE ] ] )

Controls printing to STDOUT the stdout of the LSF command line. The default is FALSE. When called with no arguments returns the current value.

HISTORY

The LSF::Batch module on cpan didn't compile easily on all platforms i wanted. The LSF API didn't seem very perlish either. As a quick fix I knocked these modules together which wrap the LSF command line interface. It was enough for my simple usage. Hopefully they work in a much more perly manner.

SEE ALSO

the LSF::Batch manpage, the LSF::Job manpage, the LSF::JobHistory manpage, the LSF::JobManager manpage, the LSF::JobGroup manpage, the LSF::Queue manpage, bsub, bhist, bjobs, bswitch, bdel, bkill, bstop, bmod, btop, bbot, brun, bqueues, bgadd, bgdel, bgmod, bghold, bgrel

AUTHOR

Mark Southern (mark_southern@merck.com)

COPYRIGHT

Copyright (c) 2002, Merck & Co. Inc. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the terms of the Perl Artistic License (see http://www.perl.com/perl/misc/Artistic.html)

Information