spawn.tasks

Simulation Tasks

class spawn.tasks.SimulationTask(*args, **kwargs)

Implementation of luigi.Task

property available_runners

Runners available for this task.

Can be overridden by derived tasks

complete()

Determine if this task is complete

Returns

True if this task is complete; otherwise False

Return type

bool

on_failure(exception)

Interprets any exceptions raised by the run method.

Attempts to find any logs associated with the runner.

Returns

A string representation of the error.

Return type

str

run()

Run this task

property run_name_with_path

Return the run name of this task

class spawn.tasks.SpawnTask(*args, **kwargs)

Implementation of luigi.Task that defines ID and dependencies parameters

complete()

Determine if this task is complete

Returns

True if this task is complete; otherwise False

Return type

bool

property metadata

Metadata for this task

requires()

The prerequisites for this task

run()

Run the task. Derived classes should implement this method.

class spawn.tasks.TaskListParameter(default=<object object>, is_global=False, significant=True, description=None, config_path=None, positional=True, always_in_help=False, batch_method=None, visibility=<ParameterVisibility.PUBLIC: 0>)

Implementation of luigi.Parameter to allow definitions of multiple tasks as dependencies

parse(x)

Parse the string

serialize(x)

Serialize this object