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

Generic platform oject outlying the interface. More...

Inheritance diagram for carputils.machines.general.Platform:
carputils.machines.desktop.Desktop carputils.machines.general.BatchPlatform carputils.machines.archer24c.ARCHER24C carputils.machines.archer2.ARCHER2 carputils.machines.archer2_e756.ARCHER2E756 carputils.machines.archer.Archer carputils.machines.archer_camel.ArcherCamel carputils.machines.archer_intel.ArcherIntel carputils.machines.bwunicluster.BwUniCluster carputils.machines.curie.Curie carputils.machines.horeka.HoreKa carputils.machines.marconi.Marconi carputils.machines.marconi_slurm.MarconiDebug carputils.machines.marconi_slurm.MarconiSlurm carputils.machines.medbionode.MedBioNode carputils.machines.medtronic.Medtronic carputils.machines.mephisto.Mephisto carputils.machines.supermuc.SuperMUCAbstract carputils.machines.vsc2.VSC2 carputils.machines.vsc3.VSC3 carputils.machines.wopr.Wopr

Public Member Functions

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 = False
 
 SUBMIT = None
 

Detailed Description

Generic platform oject outlying the interface.

Member Function Documentation

◆ add_launcher()

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

Parameters

carp_cmd list Python list of openCARP command, with arguments nproc int Number of processes to use gdb_procs list or None None no gdb, empty list - gdb on all procs, non-empty list - debug specific proc(s) ddd_procs list or None None no ddd, empty list - ddd on all procs, non-empty list - debug specific proc(s) ddt bool Debug with Allinea DDT valgrind list or None None no valgrind, list - valgrind with given options map bool Profile with Allinea MAP cuda bool Job is being run with CUDA with_ft str or None None no fault tolerance, str - OpenMPI fault tolerance mode)

  Returns
  -------
  list
      List of command line options with launcher and debug opts added

◆ add_python_launcher()

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

◆ LAUNCHER()

def carputils.machines.general.Platform.LAUNCHER (   cls)

A little trickery to prevent cyclic import.

Member Data Documentation

◆ BATCH

bool carputils.machines.general.Platform.BATCH = False
static

◆ SUBMIT

carputils.machines.general.Platform.SUBMIT = None
static

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