qtoolkit.io.pbs module

class qtoolkit.io.pbs.PBSIO

Bases: PBSIOBase

CANCEL_CMD: str | None = 'qdel'

SUBMIT_CMD: str | None = 'qsub'

default_unit: str = 'mb'

extract_job_id(stdout: str) → str | None

Extract the job ID from the submission output.

extract_job_id_from_cancel(stderr: str) → str | None

Extract the job ID from the cancellation output.

header_template: str = '#PBS -q $${queue}\n#PBS -N $${job_name}\n#PBS -A $${account}\n#PBS -l $${select}\n#PBS -l walltime=$${walltime}\n#PBS -l model=$${model}\n#PBS -l place=$${place}\n#PBS -W group_list=$${group_list}\n#PBS -M $${mail_user}\n#PBS -m $${mail_type}\n#PBS -o $${qout_path}\n#PBS -e $${qerr_path}\n#PBS -p $${priority}\n#PBS -r $${rerunnable}\n#PBS -J $${array}\n$${qverbatim}\n'

header_template_file: str = 'pbs'

parse_job_output(exit_code: int, stdout: str | bytes, stderr: str | bytes, job_id: str | None = None) → QJob | None

Parse the output of the qstat command for a single job.

parse_jobs_list_output(exit_code: int, stdout: str | bytes, stderr: str | bytes, job_ids: list[str] | None = None) → list[QJob]

Parse the output of the qstat command for a list of jobs.

power_labels: ClassVar[dict] = {'gb': 2, 'kb': 0, 'mb': 1, 'tb': 3}

sanitize_options(options: dict) → dict

Sanitize the values in the options used to generate the header.

Parameters:

options – Dictionary of options to sanitize.

Returns:

Sanitized options.

Return type:

dict

system_name: str = 'PBS'

class qtoolkit.io.pbs.PBSState(value)

Bases: QSubState

ARRAY_FINISHED = 'X'

ARRAY_RUNNING = 'B'

EXITING = 'E'

FINISHED = 'F'

HELD = 'H'

MOVED = 'M'

QUEUED = 'Q'

RUNNING = 'R'

SUSPENDED = 'S'

SUSPENDED_KEYBOARD = 'U'

TRANSITING = 'T'

WAITING = 'W'

property qstate: QState