./src/queue.tcl

::pwtk::queue::init

::pwtk::queue::init

SYNOPSIS

proc ::pwtk::queue::init {queueSystem} {

PURPOSE

Initialization of generic batch queuing support for the $queueSystem. Actually it initializes the variables to which the batch queing system script will be stored, and creates ${queueSystem}_*** flavor of commands.

A given implementation of particular queuing system is likely to define it's own init proc (see for example ::pwtk::ll::init for parcticular implementation).

ARGUMENTS

queueSystem -- name of batch queuing system (e.g. slurm, ll, lsf, ...)

SOURCE

    variable scriptHead
    variable scriptSpecs
    variable scriptBody
    variable scriptTail
    variable opt_list
    
    set scriptHead($queueSystem) ""  
    set scriptSpecs($queueSystem)  ""   
    set scriptBody($queueSystem) ""
    set scriptTail($queueSystem) ""      
    array unset ::pwtk::queue::opt_list $queueSystem,*
                            
    # define the short-cuts $${queueSystem}_*** commands
    
    set QUEUE [string toupper $queueSystem]

    if { [info commands ::pwtk::${queueSystem}_setHead] == {} } {
        proc ::pwtk::${QUEUE} {args} "uplevel ::pwtk::queue::QUEUE $queueSystem \$args"

        proc ::pwtk::${queueSystem}_clear {{what {}}} "::pwtk::queue::clear $queueSystem \$what"; # clears the respective variables
        
        proc ::pwtk::${queueSystem}_setHead    {args}     "uplevel ::pwtk::queue::setHead   $queueSystem \$args "
        proc ::pwtk::${queueSystem}_setSpecs   {content}  "::pwtk::queue::setSpecs  $queueSystem \$content "
        proc ::pwtk::${queueSystem}_setVar     {content}  "::pwtk::queue::setVar    $queueSystem \$content "
        proc ::pwtk::${queueSystem}_setTail    {content}  "::pwtk::queue::setTail   $queueSystem \$content "
                                                          
        proc ::pwtk::${queueSystem}_getHead    {}         "::pwtk::queue::getHead   $queueSystem "
        proc ::pwtk::${queueSystem}_getSpecs   {}         "::pwtk::queue::getSpecs  $queueSystem "
        proc ::pwtk::${queueSystem}_getVar     {}         "::pwtk::queue::getVar    $queueSystem "
        proc ::pwtk::${queueSystem}_getBody    {}         "::pwtk::queue::getBody   $queueSystem "
        proc ::pwtk::${queueSystem}_getTail    {}         "::pwtk::queue::getTail   $queueSystem "
        proc ::pwtk::${queueSystem}_getScript  {}         "::pwtk::queue::getScript $queueSystem "
                                                          
        proc ::pwtk::${queueSystem}_run {program head}     "::pwtk::queue::run        $queueSystem \$program \$head "
        proc ::pwtk::${queueSystem}_runPW       {head}     "::pwtk::queue::runPW      $queueSystem \$head "
        proc ::pwtk::${queueSystem}_rerunPW     {head}     "::pwtk::queue::rerunPW    $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runPH       {head}     "::pwtk::queue::runPH      $queueSystem \$head "
        proc ::pwtk::${queueSystem}_rerunPH     {head}     "::pwtk::queue::runPH      $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runPROJWFC  {head}     "::pwtk::queue::runPROJWFC $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runPP       {head}     "::pwtk::queue::runPP      $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runNEB      {head}     "::pwtk::queue::runNEB     $queueSystem \$head "
        proc ::pwtk::${queueSystem}_rerunNEB    {head}     "::pwtk::queue::rerunNEB   $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runDOS      {head}     "::pwtk::queue::runDOS     $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runBANDS    {head}     "::pwtk::queue::runBANDS   $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runDYNMAT   {head}      "::pwtk::queue::runDYNMAT  $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runMOPDOS   {head}      "::pwtk::queue::runMOPDOS       $queueSystem \$head "
        proc ::pwtk::${queueSystem}_runMOLECULARPDOS {head} "::pwtk::queue::runMOLECULARPDOS  $queueSystem \$head "
        #proc ::pwtk::${queueSystem}_runFLO      {head}     "::pwtk::queue::runFLO     $queueSystem \$head "
        proc ::pwtk::${queueSystem}_get         {}         "::pwtk::queue::get        $queueSystem "
        proc ::pwtk::${queueSystem}_print       {}         "::pwtk::queue::print      $queueSystem "
        proc ::pwtk::${queueSystem}_fprint  {{scriptName ""}}     "::pwtk::queue::fprint  $queueSystem \$scriptName"
        proc ::pwtk::${queueSystem}_submit  {{scriptName ""}}     "::pwtk::queue::submit  $queueSystem \$scriptName"            
        proc ::pwtk::${queueSystem}_profile {profileName {content ""}} "::pwtk::queue::profile $queueSystem \$profileName \$content"            
        proc ::pwtk::${queueSystem}_profileDefault {profileName}  "::pwtk::queue::profileDefault $queueSystem \$profileName"            
    }
}

TABLE OF CONTENTS

::pwtk::queue::init