carputils.machines.general.BatchPlatform Class Reference

Generic class for batch platforms. More...

Inheritance diagram for carputils.machines.general.BatchPlatform:

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)
def	determine_queue (cls, user_selected=None)
	Determine the correct queue. More...
def	header (cls, jobID, nproc, walltime, queue, cuda, email, config=None)
	Generate the header for a run script on this platform. 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...
def	add_python_launcher (cls, exe_cmd)
	Add python launcher to exe command. More...

Static Public Attributes
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

Generic class for batch platforms.

Member Function Documentation

add_launcher()

def carputils.machines.general.BatchPlatform.add_launcher	(		cls,
			carp_cmd,
			nproc,
			nproc_job = 0,
			ddt = False,
			cuda = False,
			args,
			kwargs
	)

add_python_launcher()

def carputils.machines.general.BatchPlatform.add_python_launcher	(		cls,
			exe_cmd
	)

determine_queue()

def carputils.machines.general.BatchPlatform.determine_queue	(		cls,
			user_selected = None
	)

Determine the correct queue.

footer()

def carputils.machines.general.BatchPlatform.footer

(

cls

)

Generate the footer for a run script on this platform.

header()

def carputils.machines.general.BatchPlatform.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

Member Data Documentation

AVAILABLE_QUEUES

carputils.machines.general.BatchPlatform.AVAILABLE_QUEUES = None

static

BATCH

bool carputils.machines.general.BatchPlatform.BATCH = True

static

BATCH_EXT

carputils.machines.general.BatchPlatform.BATCH_EXT = None

static

DEFAULT_QUEUE

carputils.machines.general.BatchPlatform.DEFAULT_QUEUE = None

static

---

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

• carputils/machines/general.py