carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | Static Public Attributes | List of all members
carputils.machines.vsc5.VSC5 Class Reference

Run on VSC-5 at the Vienna Scientific Cluster. More...

Inheritance diagram for carputils.machines.vsc5.VSC5:
carputils.machines.general.BatchPlatform carputils.machines.general.Platform

Public Member Functions

def add_launcher (cls, carp_cmd, nproc, nproc_job=0, ddt=False, cuda=False, *args, **kwargs)
 
def add_python_launcher (cls, exe_cmd)
 Add python launcher to exe command. More...
 
def header (cls, jobID, nproc, walltime, queue, cuda, email, config=None)
 Generate the header for a run script on this platform. More...
 
def polling (cls, polling_opts, nproc, nproc_job, script)
 
- Public Member Functions inherited from carputils.machines.general.BatchPlatform
def determine_queue (cls, user_selected=None)
 Determine the correct queue. More...
 
def footer (cls)
 Generate the footer for a run script on this platform. More...
 
- Public Member Functions inherited from carputils.machines.general.Platform
def LAUNCHER (cls)
 A little trickery to prevent cyclic import. More...
 
def add_launcher (cls, carp_cmd, nproc, nproc_job=0, gdb_procs=None, ddd_procs=None, ddt=False, valgrind=None, map=False, cuda=False, with_ft=None)
 Add MPI launcher to openCARP command. More...
 

Static Public Attributes

string SUBMIT = 'sbatch'
 
string LAUNCHER = 'mpirun'
 
string BATCH_EXT = '.slrm'
 
- Static Public Attributes inherited from carputils.machines.general.BatchPlatform
bool BATCH = True
 
 BATCH_EXT = None
 
 DEFAULT_QUEUE = None
 
 AVAILABLE_QUEUES = None
 
- Static Public Attributes inherited from carputils.machines.general.Platform
bool BATCH = False
 
 SUBMIT = None
 

Detailed Description

Run on VSC-5 at the Vienna Scientific Cluster.

Info http://vsc.ac.at/systems/vsc-5/

Member Function Documentation

◆ add_launcher()

def carputils.machines.vsc5.VSC5.add_launcher (   cls,
  carp_cmd,
  nproc,
  nproc_job = 0,
  ddt = False,
  cuda = False,
args,
**  kwargs 
)

◆ add_python_launcher()

def carputils.machines.vsc5.VSC5.add_python_launcher (   cls,
  exe_cmd 
)

Add python launcher to exe command.

   Parameters
   ----------

exe_cmd list Python list of CARP command, with arguments

Returns

list List of command line options with launcher added

Reimplemented from carputils.machines.general.BatchPlatform.

◆ header()

def carputils.machines.vsc5.VSC5.header (   cls,
  jobID,
  nproc,
  walltime,
  queue,
  cuda,
  email,
  config = None 
)

Generate the header for a run script on this platform.

   Parameters
   ----------

jobID str Identifier for this job in batch system nproc int Number of processes to use walltime str Walltime string of format HH:MM:SS queue str Specify a queue to submit to cuda bool True if running a CUDA executable email str Email address to notify when done

Returns

str The generated header

Reimplemented from carputils.machines.general.BatchPlatform.

◆ polling()

def carputils.machines.vsc5.VSC5.polling (   cls,
  polling_opts,
  nproc,
  nproc_job,
  script 
)

Member Data Documentation

◆ BATCH_EXT

string carputils.machines.vsc5.VSC5.BATCH_EXT = '.slrm'
static

◆ LAUNCHER

string carputils.machines.vsc5.VSC5.LAUNCHER = 'mpirun'
static

◆ SUBMIT

string carputils.machines.vsc5.VSC5.SUBMIT = 'sbatch'
static

The documentation for this class was generated from the following file: