ecflow.Suite

class ecflow.Suite

Bases: NodeContainer

A suite is a collection of Families,Tasks,Variables, repeat and clock definitions

Suite is the only node that can be started using the begin API. There are several ways of adding a suite, see example below and ecflow.Defs.add_suite

Constructor:

Suite(name, Nodes | attributes)
    string name : The Suite name. name must consist of alpha numeric characters or
                  underscore or dot. The first character cannot be a dot, as this
                  will interfere with trigger expressions. Case is significant
    Nodes | Attributes:(optional)

Exception:

• Throws a RuntimeError if the name is not valid

• Throws a RuntimeError if duplicate suite names added

Usage:

defs = Defs()                  # create a empty definition. Root of all Suites
suite = Suite('suite_1')       # create a stand alone suite
defs.add_suite(suite)          # add suite to definition
suite2 = defs.add_suite('s2')  # create a suite and add it to the defs

defs = Defs(
         Suite('s1',
            Family('f1',
               Task('t1'))))   # create in in-place

Suite.add_clock((Suite)arg1, (Clock)arg2) → Suite

Suite.add_end_clock((Suite)arg1, (Clock)arg2) → Suite :

End clock, used to mark end of simulation

Suite.begun((Suite)arg1) → bool :

Returns true if the suite has begun, false otherwise

Suite.get_clock((Suite)arg1) → Clock :

Returns the suite clock

Suite.get_end_clock((Suite)arg1) → Clock :

Return the suite’s end clock. Can be NULL