carputils
Doxygen code documentation for the python framework controlling openCARP
All Classes Namespaces Files Functions Variables Properties Pages
Public Member Functions | Static Public Attributes | List of all members
carputils.machines.archer2.ARCHER2 Class Reference

Run on Archer2 Info https://www.archer2.ac.uk/. More...

Inheritance diagram for carputils.machines.archer2.ARCHER2:
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)
 
def header (cls, jobID, nproc, walltime, queue, cuda, email, config=None)
 
def polling (cls, polling_opts, nproc, nproc_job, script)
 
- Public Member Functions inherited from carputils.machines.general.BatchPlatform
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

string SUBMIT = 'sbatch'
 
string LAUNCHER = 'srun --distribution=block:block --hint=nomultithread '
 
string PYTHON = 'python'
 
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 Archer2 Info https://www.archer2.ac.uk/.

Member Function Documentation

◆ add_launcher()

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

◆ add_python_launcher()

def carputils.machines.archer2.ARCHER2.add_python_launcher (   cls,
  exe_cmd 
)

◆ header()

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

◆ polling()

def carputils.machines.archer2.ARCHER2.polling (   cls,
  polling_opts,
  nproc,
  nproc_job,
  script 
)

Member Data Documentation

◆ BATCH_EXT

string carputils.machines.archer2.ARCHER2.BATCH_EXT = '.slrm'
static

◆ LAUNCHER

string carputils.machines.archer2.ARCHER2.LAUNCHER = 'srun --distribution=block:block --hint=nomultithread '
static

◆ PYTHON

string carputils.machines.archer2.ARCHER2.PYTHON = 'python'
static

◆ SUBMIT

string carputils.machines.archer2.ARCHER2.SUBMIT = 'sbatch'
static

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