lxm3.xm_cluster.GridEngine

class lxm3.xm_cluster.GridEngine(requirements: JobRequirements = NOTHING, resources: Dict[str, Any] = NOTHING, parallel_environments: Dict[str, int] = NOTHING, walltime: str | datetime | int | None = None, queue: str | None = None, reserved: bool | None = None, log_directory: str | None = None, merge_output: bool = True, shell: str = '/bin/bash', project: str | None = None, account: str | None = None, modules: Sequence[str] = NOTHING, max_parallel_tasks: int | None = None, extra_directives: Sequence[str] = NOTHING, skip_directives: Sequence[str] = NOTHING, singularity_options: SingularityOptions | None = None, docker_options: DockerOptions | None = None)

SGE executor.

requirements

placeholder, no effect right now.

Type:

lxm3.xm_cluster.requirements.JobRequirements

resources

Resources passed to qsub as -l key=value.

Type:

Dict[str, Any]

parallel_environments

Parallel environments in the form of --pe <name> <slots>.

Type:

Dict[str, int]

walltime

Maximum running time, -l h_rt=time. When an int is used, this is interpreted as seconds. A datetime.timedelta can also be used.

Type:

datetime.timedelta | None

queue

queue to submit the job to: -q.

Type:

str | None

reserved

If set, use -R y.

Type:

bool | None

log_directory

Log directory for stdout/stderr.

Type:

str | None

merge_output

If False, log to separate files.

Type:

bool

shell

Shell to use, default /bin/bash.

Type:

str

project

-P.

Type:

str | None

account

-A.

Type:

str | None

modules

Modules to load before running the job. See https://modules.readthedocs.io/en/latest/

Type:

Sequence[str]

max_parallel_tasks

-tc.

Type:

int | None

extra_directives

Extra directives to pass to qsub.

Type:

Sequence[str]

skip_directives

Directives to skip.

Type:

Sequence[str]

singularity_options

Options for singularity container.

Type:

lxm3.xm_cluster.executors.SingularityOptions | None

__init__(requirements: JobRequirements = NOTHING, resources: Dict[str, Any] = NOTHING, parallel_environments: Dict[str, int] = NOTHING, walltime: str | datetime | int | None = None, queue: str | None = None, reserved: bool | None = None, log_directory: str | None = None, merge_output: bool = True, shell: str = '/bin/bash', project: str | None = None, account: str | None = None, modules: Sequence[str] = NOTHING, max_parallel_tasks: int | None = None, extra_directives: Sequence[str] = NOTHING, skip_directives: Sequence[str] = NOTHING, singularity_options: SingularityOptions | None = None, docker_options: DockerOptions | None = None) None

Method generated by attrs for class GridEngine.

Methods

Spec()

__init__([requirements, resources, ...])

Method generated by attrs for class GridEngine.

Attributes

requirements

resources

parallel_environments

walltime

queue

reserved

log_directory

merge_output

shell

project

account

modules

max_parallel_tasks

extra_directives

skip_directives

singularity_options

docker_options