ecFlow's documentation is now on readthedocs!

The previous exercises on limit/inlimit all affect how tasks are constrained.

However, we may also need to constrain how many suites/families are allowed to run in parallel.

In the exercise below we will limit families.

When a family is limited, the child tasks are unconstrained. In this case, only two families can run at a time. All the tasks in the family can start at once

Text

Let us modify our suite definition file:

# Definition of the suite test.
suite test
 edit ECF_INCLUDE "$HOME/course"
 edit ECF_HOME    "$HOME/course"
 edit SLEEP 20
 limit fam 2
 family lf1
     inlimit -n fam
     task t1 ;  task t2 ; task t3 ; task t4; task t5 ; task t6; task t7; task t8 ; task t9
 endfamily
 family lf2
     inlimit -n fam
     task t1 ;  task t2 ; task t3 ; task t4; task t5 ; task t6; task t7; task t8 ; task t9
 endfamily
 family lf3
     inlimit -n fam
     task t1 ;  task t2 ; task t3 ; task t4; task t5 ; task t6; task t7; task t8 ; task t9
 endfamily
endsuite

Python

$HOME/course/test.py
import os
from ecflow import Defs,Suite,Family,Task,Edit,Trigger,Complete,Event,Meter,Time,Day,Date,Label, \
                   RepeatString,RepeatInteger,RepeatDate,InLimit,Limit
        
def create_family(name) :
    return Family(name,
            # limit_name(fam),limit_path(""),no_of_tokens_to_consume(1),limit node(True), limit submission(False)
            InLimit("fam","",1,True,False), 
            [ Task('t{}'.format(i)) for i in range(1,10) ] )
    
print("Creating suite definition")  
home = os.path.join(os.getenv("HOME"),"course")
defs = Defs( 
        Suite("test",
            Edit(ECF_INCLUDE=home,ECF_HOME=home,SLEEP=20),
            Limit("fam",2),
            create_family("lf1"),create_family("lf2"),create_family("lf3") ))
print(defs) 

print("Checking job creation: .ecf -> .job0")  
print(defs.check_job_creation())

print("Checking trigger expressions and inlimits")
assert len(defs.check()) == 0,defs.check() 

print("Saving definition to file 'test.def'")
defs.save_as_defs("test.def")

What to do

  1. Edit the changes i.e. cp -r f5 lf1; cp -r f5 lf2; cp -r f5 lf3; 
  2. Replace the suite definition
  3. In ecflow_ui , observe the effects
  4. How could you change suite to also limit tasks as well as families. i.e. only allow 1 task to run in each family?