fluiddyn.clusters.pbs

PBS clusters (fluiddyn.clusters.pbs)

Provides:

class fluiddyn.clusters.pbs.ClusterPBS(check_scheduler=True, **kwargs)

Bases: ClusterLocal

Base class for clusters with PBS job scheduler.

check_pbs()

Check if this script is run on a frontal with pbs installed.

check_name_cluster(env='HOSTNAME')

Check if self.name_cluster matches the environment variable.

submit_command(command, name_run='fluiddyn', nb_nodes=1, nb_cores_per_node=None, walltime=None, project=None, queue=None, nb_mpi_processes=None, omp_num_threads=1, nb_runs=1, path_launching_script=None, path_resume=None, retain_script=True, ask=True, bash=True, email=None, interactive=False, **kwargs)

Submit a command.

Parameters:

commandstring

Command which executes the run

name_runstring

Name of the run to be displayed in PBS queue

nb_nodesinteger

Number of nodes

nb_cores_per_nodeinteger

Defaults to a maximum is fixed for a cluster, as set by self.nb_cores_per_node. Set as 1 for a serial job. Set as 0 to spread jobs across nodes (starts job faster, maybe slower).

walltimestring

Minimum walltime for the job

projectstring

Sets the allocation to run the job under

queue: string

Sets the cluster queue to run the job on

nb_mpi_processesinteger

Number of MPI processes. Defaults to None (no MPI). If "auto", computed as nb_cores_per_node * nb_nodes.

omp_num_threadsinteger

Number of OpenMP threads

nb_runsinteger

Number of times to submit jobs (launch once using command and resume thereafter with path_resume script / command).

path_launching_script: string

Path of the PBS jobscript

path_resumestring

Path of the script to resume a job, which takes one argument - the path_run parsed from the output.

retain_scriptboolean

Retail or delete script after launching job

askboolean

Ask for user input to submit the jobscript or not

bashboolean

Submit jobscript via call_bash function

emailstring

In case of failure notify to the specified email address

interactiveboolean

Use cmd_run_interactive instead of cmd_run inside the jobscript

Classes

ClusterPBS([check_scheduler])

Base class for clusters with PBS job scheduler.