3.4.2. sciexp2.expdef.system.System

Methods

assumes()

The set of variables that must be present on the launchers.

build(types, *filters)

Generate a sequence with the jobs matching the given criteria.

compute_state()

Compute the current state of jobs.

defines()

The set of variables that must not be present on the launchers.

get_relative_path(path[, cwd])

Get path (relative to base) as relative to cwd.

post_generate(base, path, instance, xlator)

Post-process the generation of file path.

Attributes

ASSUMES

DEFINES

class System(base_path, launchers, depends, submit_args)

Bases: ABC

Abstract job manager.

Each system must implement the abstract methods defined in this class and define two class attributes:

Name

Description

ASSUMES

List of variables that are assumed to be present in the launchers instance group for the system to work.

DEFINES

List of variables that the system internally defines and thus must not be present in the launchers instance group.

See also

compute_state
Parameters:
base_pathstr

Base directory where launchers are located.

launchersInstanceGroup

Group describing the launchers.

dependssequence of str

Variable names to which jobs depend.

submit_argssequence of str

Extra arguments to the job-submitting program.

ASSUMES = ['LAUNCHER', 'DONE', 'FAIL']
DEFINES = ['_STATE', 'LAUNCHER_BASE']
get_relative_path(path, cwd=None)

Get path (relative to base) as relative to cwd.

build(types, *filters)

Generate a sequence with the jobs matching the given criteria.

Parameters:
typesset

Set of states that the jobs must be on.

filterslist of filters

List of filters that the jobs must match.

See also

Job
classmethod assumes()

The set of variables that must be present on the launchers.

classmethod defines()

The set of variables that must not be present on the launchers.

abstractmethod compute_state()

Compute the current state of jobs.

The implementation must set the _jobs attribute with an InstanceGroup of Job instances. This can be computed using the contents of the _launchers attribute.

static post_generate(base, path, instance, xlator)

Post-process the generation of file path.