3.7.1. sciexp2.expdef.templates.Template

Methods

get_description()	Get a full description.
get_short_description([get_long])	Get short description.

class Template(name)

Bases: object

A launcher template.

The non-string attributes must be specified in the template descriptor file as the string identifying the object name.

Attributes:

namestr

Template name (taken from the file name of descriptor file).

descriptionstr

Template description.

systemsciexp2.expdef.system.System, optional

Name of the execution system this template if for. Can be inherited from parent.

templatestr, optional

The template file this descriptor uses. For file name.tpl you must use name. Can be inherited from parent.

parentsciexp2.templates.Template, optional

Parent template to inherit from.

submit_argslist of str, optional

Extra arguments passed to the job submission program.

overridesdict, optional

Dictionary mapping variable names in the parent template to their corresponding values for this template.

defaultsdict, optional

Dictionary mapping variable names in the template to their corresponding values, in case the user provides none.

Notes

Template descriptor files can use the following variables to refer to the corresponding attributes set in their parent template:

• parent_submit_args

• parent_overrides

• parent_defaults

Argument submit_args can contain variable LAUNCHER_BASE, which contains the absolute path to the base output directory (expdef.experiments.Experiments.out).

Create a new template object from its descriptor file.

get_short_description(get_long=False)

Get short description.

get_description()

Get a full description.