Copyright Notice

 Copyright I.N.R.A. - C.N.R.S.
 emmanuel.courcelle@toulouse.inra.fr
 jerome.gouzy@toulouse.inra.fr
 This software is a computer program whose purpose is to help you run 
 your scripts on parallel computers.
 This software is governed by the CeCILL  license under French law and
 abiding by the rules of distribution of free software.  You can  use, 
 modify and/ or redistribute the software under the terms of the CeCILL
 license as circulated by CEA, CNRS and INRIA at the following URL
 http://www.cecill.info";
 As a counterpart to the access to the source code and  rights to copy,
 modify and redistribute granted by the license, users are provided only
 with a limited warranty  and the software's author,  the holder of the
 economic rights,  and the successive licensors  have only  limited
 liability.
 In this respect, the user's attention is drawn to the risks associated
 with loading,  using,  modifying and/or developing or reproducing the
 software by the user in light of its specific status of free software,
 that may mean  that it is complicated to manipulate,  and  that  also
 therefore means  that it is reserved for developers  and  experienced
 professionals having in-depth computer knowledge. Users are therefore
 encouraged to load and test the software's suitability as regards their
 requirements in conditions enabling the security of their systems and/or 
 data to be ensured and,  more generally, to use and operate it in the 
 same conditions as regards security.
 The fact that you are presently reading this means that you have had
 knowledge of the CeCILL license and that you accept its terms.


NAME

PARALOOP::SCHEDULER::PBS - Scheduler object for use with PBS


Derives from...

PARALOOP::SCHEDULER::Scheduler


DESCRIPTION

This scheduler is used for a cluster, equipped with the batch system PBS. I just hope it will work with other batch systems.


CONFIGURATION FILE PARAMETERS

 PARALOOP_Scheduler 
     PBS
 PARALOOP_error_directory 
     The name of the error directory
 PARALOOP_qsub_params     
     String to pass to qsub
 PARALOOP_account         
     String to pass to the -A switch of PBS


PUBLIC METHODS

 WhatParaloopScheduler
    my $msg=$obj->WhatParaloopScheduler()
 Parameters
    my $msg=$obj->Parameters()
 New
    my $obj = PARALOOP::Dummy->New(-params => $params, -log => $log);
     
 IsSelfPossible
    If (&$obj->IsSelPossible()==1)...
 Submit
    my $job_id = $obj->Submit();
 RemTime
    my $rem_time = $obj->RemTime();
 JobId
    my $job_id = $obj->JobId();


METHODS AND SUBROUTINES - DETAILED DESCRIPTION

Function WhatParaloopScheduler

 Usage:    my $msg = PARALOOP::SCHEDULER::PBS::WhatParaloopScheduler()
        or my $msg = $obj->WhatParaloopScheduler()
 Function: Return some information (2 lines max) on the scheduler
           An object is NOT considered as a scheduler if this function is not implemented
 Arg:      none ($self is ignored)
 Return:   A message describing the plugin (1 or 2 lines)

Function Parameters

 Usage:    my $msg = PARALOOP::SCHEDULER::PBS::Parameters()
        or my $msg = $obj->Parameters()
 Function: Return the list of allowed parameters for this scheduler
           If your scheduler defines some parameters, it is good pratice adding this function,
           to display those parameters when the --parameters switch of paraloop.pl is used.
           However, this is not mandatory
 Arg:      none ($self is ignored)
 Return:   A message describing the scheduler parameters (1 line / parameter)

Function Submit

 Usage:     &$obj->Submit()
 Function:  Call a qsub.
 Arg :      none
 Return:    the job Id

Function JobId

 Usage:     my $job_id = $obj->JobId()
 Function:  Ask the system for the job id
            The environment variable PBS_JOBID is returned
 Arg :      none
 Return :   the job Id

Function RemTime

 Usage:    my $rem_time = &$obj->RemTime();
 Function: Asks the system for the number of seconds remainig before a kill
 Arg:      none
 Return:   $rem_time = The number of seconds remaining (in fact subtract 5% for security)

Function IsLaunched

 Usage:    If (&$obj->IsLaunched($job_id)==1)...
 Function: Check the presence of the job in the system
           Call qstat $job_id
 Arg:      job_id: the job Id to check
 Return:   0 ==> The job is not known by the system
           1 ==> The job is known (may be in different states: Run, Queue, etc)

Procedure KillJob

 Usage:    $obj->KillJob($job_id);
 Function: Kill the job passed by parameter
           Call qdel $job_id
 Arg:      job_id: the job Id to kill
 Return:   none

procedure IsSelfPossible

 Usage:  if ($obj->IsSelfPossible()) ... 
 Access: public (use New instead)
 function: return 1 if this scheduler accepts to submit himself, 0 if it doesn't
 Return:   0/1
 Args:     none
 globals:  none