3.3. sciexp2.expdef.launcher

Source: sciexp2/expdef/launcher.py

Common interface to manage jobs created with expdef.

Each job is described with an Instance, as generated by launcher.

You can integrate job management into your application by instantiating the Launcher class.

Functions

load

Load a job description from a file.

save

Save an InstanceGroup as a job descriptor into a file.

Classes

Launcher

Common interface to manage jobs.

Exceptions

LauncherLoadError

Could not load given file.

3.3.2. load

load(file_name)

Load a job description from a file.

Parameters:
file_namestr

Path to source file.

Returns:
sciexp2.expdef.system.System

Instance of the execution system with the job descriptions.

Raises:
LauncherLoadError

The given file cannot be loaded as a Launcher.

See also

save

3.3.3. save

save(file_name, base_to_file, system, group, export, depends, submit_args)

Save an InstanceGroup as a job descriptor into a file.

Parameters:
file_namestr

Path to destination file.

base_to_filestr

Relative path from some base directory to the directory containing file_name.

systemSystem

Class of the execution system to use.

groupInstanceGroup

Job descriptors.

exportset

Variable names to export into the description file.

dependssequence of str

Variable names to which jobs depend.

submit_argssequence of str

Extra arguments to the job-submitting program.