def family_limiter():
""" alternative example """
return (
Family("limiter").add(
Limit("total", 10),
Inlimit("total"),
Task("alarm").add(
Complete("limits eq complete"),
Trigger("../limiter:total gt 8")), # relative path
Family("limits").add(
Defstatus("complete"),
Family("weaker").add( # weaker is located above, not to be shadowed
Trigger("../limiter:total le 10"),
[Family("%03d" % step).add(
Task("process"), Variables(STEP=step))
for step in range(0, 120, 3)]),
Family("prio").add( # favourite shall not lead weaker to starve
Trigger("../limiter:total le 15"),
[Family("%03d" % step).add(
Task("process"), Variables(STEP=step))
for step in range(0, 120, 3)]))))
def create(name=os.getenv("SUITE", "elearning")):
return Suite(name).add(
Defstatus("suspended"), # start immediately or not for this demo
Clock("real"),
Edit(ECF_INCLUDE=HOME, # header files
ECF_FILES=HOME, # script template .ecf
ECF_HOME=HOME), # job + local output files
Family("f1").add(
Task("t1").add(
Event(1),
Label("info", ""),
Meter("step", -1, 100)),
Task("t2").add(
Late("-c 01:00"),
Meter("step", -1, 100),
Event("a"),
Event("b"),
Trigger("t1:step gt 0")),
Task("t3").add(
Trigger("t2:a")),
Task("t4").add(
Complete("t2:b"),
Trigger("t2 eq complete and not t2:b"))),
Family("f2").add(
Task("t1").add(
Time("00:30 23:30 00:30")),
Task("t2").add(
Day("sunday")),
Task("t3").add(
Time("12:00"),
Date("1.*.*")),
Task("t4").add(
Time("+00:02")),
Task("t5").add(
Time("00:02"))))
def family_case():
""" case block as a family example """
return (
Family("case_var").add(
Task("case").add(
Defstatus("complete"),
Edit(VAR=1)),
Task("when_1").add(
Trigger("case:VAR == 1"),
Complete("case:VAR != 1")),
Task("when_2").add(
Trigger("case:VAR eq 2"),
Complete("case:VAR ne 2"))),
Family("case_meter").add(
Task("case").add(
Meter("STEP", -1, 48)),
Task("when_1").add(
Trigger("case:STEP eq 1"),
Complete("case==complete")),
Task("when_2").add(
Trigger("case:STEP eq 2"),
Complete("case eq complete"))))
def process():
""" provide 'daily' example family """
return (Family("process").add(
Trigger("process ne aborted"), # STOP ASAP
Family("daily").add(
Task("simple"), Repeat("YMD", 20180101, 20321212, kind="date"),
Family("decade").add(Task("simple"),
Label("info", "Show-Icons-Complete"),
Complete("../daily:YMD % 10 ne 0"))),
Family("monthly").add(
Task("simple"),
Trigger("monthly:YM lt daily:YMD / 100 or daily eq complete"),
Repeat(kind="enum",
name="YM",
start=[
"%d" % YM for YM in range(201801, 203212 + 1)
if (YM % 100) < 13 and (YM % 100) != 0
]),
Family("odd").add(Task("simple"),
Complete("../monthly:YM % 2 eq 0"))),
Family("yearly").add(
Task("simple"), Repeat("Y", 2018, 2032, kind="integer"),
Trigger("yearly:Y lt daily:YMD / 10000 or daily eq complete"),
Family("decade").add(Task("simple"),
Complete("(../yearly:Y % 10) ne 0")),
Family("century").add(Task("simple"),
Complete("(../yearly:Y % 100) ne 0")))))
def create(name):
""" suite provider """
return Suite(name).add(
Defstatus("suspended"),
Edit(ECF_INCLUDE=HOME, # header files
ECF_FILES=HOME, # script template .ecf
ECF_HOME=HOME), # job + local output files
Family("f1").add(
Task("t1").add(
Label("info", ""),
Late("-c 01:00"),
Meter("step", -1, 100)),
Task("t2").add(
Meter("step", -1, 100),
Event("a"),
Event("b"),
Trigger("t1:step gt 0")),
Task("t3").add(
Trigger("t2:a")),
Task("t4").add(
Complete("t2:b"),
Trigger("t2 eq complete and not t2:b"))),
Family("f2").add(
Task("t1").add(
Time("00:30 23:30 00:30")),
Task("t2").add(
Day("sunday")),
Task("t3").add(
Time("12:00"),
Date("1.*.*")),
Task("t4").add(
Time("+00:02")),
Task("t5").add(
Time("00:02"))))
def family_if():
""" if block as a family example """
return (
Family("if_then_else").add(
Task("if").add(Event(1)),
Task("then").add(Trigger("if:1"),
Complete("if==complete and not if:1")),
Task("else").add(Complete("if:1"),
Trigger("if eq complete and not if:1"))),
Family("if").add( # one script
Task("model").add(Event(1))),
Family("then").add(Trigger("if/model:1"),
Complete("if eq complete and not if/model:1"),
Task("model")),
Family("else").add(Complete("if/model:1"),
Trigger("if eq complete and not if/model:1"),
Task("model")))
def model(fclen=240, name="model", dependencies="acquisition"): # leaf task
deploy("""# task wrapper, turned into a job by ecFlow
%manual
useful information for Operators...
%end
%comment
# comment, ... ecflow_ui Edit
%end
%nopp
# no preprocessing here
%end
ID=%ID:-1% # model id, default value -1, -1: HRES, 0: CF, N: PF
ecflow_client --event 1 # ecflow hook: send an event
for i in $(seq 0 %FCLENGTH:240%); do # variable with default value
sleep %SLEEP:0%; ecflow_client --meter step $i # share progress with ecFlow
done
ecflow_client --label info "OK" # report a label to ecFlow""", files + name + extn)
return Task(name).add( # HRES
Trigger(dependencies + " eq complete"),
Variables(FCLENGTH=fclen), # python variable to suite variable
Meter("step", -1, fclen),
Label("info", ""))
#!/usr/bin/env python2.7
""" back archive example """
from __future__ import print_function
import os
import ecf as ecflow
from ecf import (Defs, Defstatus, Suite, Family, Task, Variables, Label,
Limit, Inlimit, Repeat, Trigger)
HOME = os.getenv("HOME") + "/ecflow_server"
NAME = "back_archiving"; FILES = HOME + "/back"; DEFS = Defs()
DEFS.add(Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Repeat(kind="day", step=1),
Variables(ECF_HOME=HOME, ECF_INCLUDE=HOME, ECF_FILES=FILES, SLEEP=2),
Limit("access", 2),
[Family(kind).add(
Repeat("DATE", 19900101, 19950712, kind="date"),
Variables(KIND=kind),
Task("get_old").add(Inlimit("access"), Label("info", "")),
Task("convert").add(Trigger("get_old == complete")),
Task("save_new").add(Trigger("convert eq complete"))
) for kind in ("analysis", "forecast", "climatology", "observations", "images")]))
# print(DEFS); DEFS.generate_scripts();
RESULT = DEFS.simulate(); print(RESULT)
CLIENT = ecflow.Client(os.getenv("ECF_HOST", "localhost"),
os.getenv("ECF_PORT", 2500))
CLIENT.replace("/%s" % NAME, DEFS)
def cycle_trigger(cyc):
if cyc == "12":
return Trigger("./00==complete")
return None
DEFS = Defs()
DEFS.add(
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Repeat(kind="day", step=1),
Variables(ECF_HOME=HOME,
ECF_INCLUDE=HOME + "/include",
ECF_FILES=HOME + "/files"),
[
Family(str(cycle)).add(
Variables(CYCLE=cycle, LAST_STEP=LAST_STEP[cycle]),
cycle_trigger(cycle),
Family("analysis").add(
Task("get_observations"),
Task("run_analysis").add(Trigger([
"get_observations",
])),
Task("post_processing").add(Trigger([
"run_analysis",
]))),
Family("forecast").add(
Trigger("analysis == complete"),
Task("get_input_data").add(Label("info", "")),
Task("run_forecast").add(
Trigger([
"get_input_data",
]), Meter("step", 0, LAST_STEP[cycle]))),
Family("archive").add(
Family("analysis").add(
Variables(TYPE="analysis", STEP=0),
Trigger([
from ecf import (Defstatus, Suite, Family, Task, Variables, Trigger, Event)
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
NAME = os.getenv("SUITE", "elearning")
DEFS = ecflow.Defs()
DEFS.add( # suite definition
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Variables( # add multiple variables at once:
ECF_HOME=ECF_HOME, # where job files are created by ecflow
ECF_FILES=ECF_HOME + "/files", # where to find script template
ECF_INCLUDE=ECF_HOME + "/include", # where to find head.h tail.h
SLEEP=5),
Family("f1").add(
Task("t1"),
Task("t2").add(
Trigger("t1 eq complete"),
Event("a"),
Event("1")),
Task("t3").add(
Trigger("t2:a")),
Task("t4").add(
Trigger("t2:1")))))
SCRIPT_TEMPLATE = """#!/bin/bash
%include <head.h>
echo "I will now sleep for %SLEEP:1% seconds"
sleep %SLEEP:1%; ecflow_client --event a # set first event
sleep %SLEEP:!%; ecflow_client --event 1 # set a second event
sleep %SLEEP:1%; # don't sleep too much anyway
%include <tail.h>
"""
from __future__ import print_function
import os
import ecf as ecflow
from ecf import (Date, Day, Defs, Defstatus, Suite, Family, Task,
If, # If attribute in use example
Edit, Label, Repeat, Time, Trigger, Defs, Client)
HOME = os.getenv("HOME") + "/ecflow_course"; NAME = "data_acquisition"; DEFS = Defs()
DEFS.add(Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Repeat(kind="day", step=1),
Edit(ECF_HOME=HOME, ECF_INCLUDE=HOME, ECF_FILES=HOME + "/acq", SLEEP=2),
[Family(city).add(
Family("archive").add(
[Family(obs_type).add(
If(test=city in ("Exeter", "Toulouse", "Offenbach"), then=Time("00:00 23:00 01:00")),
If(city in ("Washington"), Time("00:00 23:00 03:00")),
If(city in ("Tokyo"), Time("12:00")),
If(city in ("Melbourne"), Day("monday")),
If(city in ("Montreal"), Date("1.*.*")),
Task("get").add(Label("info", "")),
Task("process").add(Trigger("get eq complete")),
Task("store").add(Trigger("get eq complete")))
for obs_type in ("observations", "fields", "images")]))
for city in ("Exeter", "Toulouse", "Offenbach", "Washington",
"Tokyo", "Melbourne", "Montreal")]))
# print(DEFS); DEFS.generate_scripts();
RESULT = DEFS.simulate(); # print(RESULT)
CLIENT = Client(os.getenv("ECF_HOST", "localhost"),
os.getenv("ECF_PORT", 2500))
CLIENT.replace("/%s" % NAME, DEFS)
TASK3 = Task("t3") # a python object can be set, and added later to the suite
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
NAME = os.getenv("SUITE", "elearning")
DEFS = ecflow.Defs()
DEFS.add( # suite definition
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Variables(
ECF_HOME=ECF_HOME, # where job files are created by ecflow
ECF_FILES=ECF_HOME + "/files", # where to find script template
ECF_INCLUDE=ECF_HOME + "/include", # where to find head.h tail.h
SLEEP=1, ),
Family("f1").add(
Task("t1").add(Variables(SLEEP=5)),
Task("t2").add(Variables(SLEEP=7),
Trigger("t1 eq complete")),
TASK3,
Task("t4").add(Trigger(["t1", "t2"])))))
SCRIPT_TEMPLATE = """#!/bin/bash
%include <head.h>
echo "I will now sleep for %SLEEP:1% seconds"; sleep %SLEEP:1%
%include <tail.h>
"""
if __name__ == '__main__':
ecflow.USE_TRIGGER = True; # ecflow.USE_TRIGGER = False; # DEBUG
for num in (1, 2, 3, 4): # create task template files
with open(ECF_HOME + "/files/t%d.ecf" % num, "w") as t:
print(SCRIPT_TEMPLATE, file=t)
HOST = os.getenv("ECF_HOST", "localhost")
ECF_INCLUDE=home + "/include", # include files location
# ECF_OUT=home, # output files location on remote systems,
# no directory created there by ecflow...
ECF_EXTN=extn,
), # task wrapper extension
Task(acq).add(Event(1)),
Family("ensemble").add( # ENS
Complete(acq + ":1"),
[
Family("%02d" % num).add(
Edit(ID=num), model(
360, dependencies="../../" + acq)) # relative path...
for num in range(0, 10)
]),
model(240, dependencies=acq), # HRES
Task(post).add(Trigger("model eq complete"), Label("info", "")))
#####################################################################
head = """#!/bin/bash
set -e # stop the shell on first error
set -u # fail when using an undefined variable
set -x # echo script lines as they are executed
# Defines the variables that are needed for any communication with ECF
export ECF_PORT=%ECF_PORT% # The server port number
export ECF_HOST=%ECF_HOST% # where the server is running
export ECF_NAME=%ECF_NAME% # The name of this current task
export ECF_PASS=%ECF_PASS% # A unique password
export ECF_TRYNO=%ECF_TRYNO% # Current try number of the task
export ECF_RID=$$ # record the process id. Also used for
# zombie detection
def trigger(expression):
""" use a function to filter/debug/intercept """
return Trigger(expression)
from ecf import (Defstatus, Suite, Family, Task, Variables, Trigger, Event,
Meter)
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
NAME = os.getenv("SUITE", "elearning")
DEFS = ecflow.Defs()
DEFS.add( # suite definition
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Variables( # add multiple variables at once
ECF_HOME=ECF_HOME, # where job files are created by ecflow
ECF_FILES=ECF_HOME + "/files", # where to find script templates
ECF_INCLUDE=ECF_HOME + "/include", # where to find head.h tail.h
SLEEP=2),
Family("f2").add(
Task("t1").add(Meter("step", -1, 240)),
Task("t2").add(Trigger("t1 eq complete"), Event("a"), Event("b")),
Task("t3").add(Trigger("t2:a")),
Task("t4").add(Trigger("t2:b")),
Task("t5").add(Trigger("t1:step ge 24")),
Task("t6").add(Trigger("t1:step ge 48")),
Task("t7").add(Trigger("t1:step ge 120")))))
SCRIPT_TEMPLATE = """#!/bin/bash
%include <head.h>
STEP=0
while [[ $STEP -le 240 ]] ; do
ecflow_client --meter step $STEP # share progress
msg="The date is now $(date)"; sleep %SLEEP:1%
(( STEP = STEP + 1))
done
%include <tail.h>
TASK3 = Task("t3") # a python object can be set, and added later to the suite
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
NAME = os.getenv("SUITE", "elearning")
DEFS = ecflow.Defs()
DEFS.add( # suite definition
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Variables(
ECF_HOME=ECF_HOME, # where job files are created by ecflow
ECF_FILES=ECF_HOME + "/files", # where to find script template
ECF_INCLUDE=ECF_HOME + "/include", # where to find head.h tail.h
SLEEP=1,
),
Family("f1").add(
Task("t1").add(Variables(SLEEP=5)),
Task("t2").add(Variables(SLEEP=7), Trigger("t1 eq complete")),
TASK3,
Task("t4").add(Trigger(["t1", "t2"])))))
SCRIPT_TEMPLATE = """#!/bin/bash
%include <head.h>
echo "I will now sleep for %SLEEP:1% seconds"; sleep %SLEEP:1%
%include <tail.h>
"""
if __name__ == '__main__':
ecflow.USE_TRIGGER = True
# ecflow.USE_TRIGGER = False; # DEBUG
for num in (1, 2, 3, 4): # create task template files
with open(ECF_HOME + "/files/t%d.ecf" % num, "w") as t:
print(SCRIPT_TEMPLATE, file=t)
Variables(ECF_HOME=home, # jobs files are created there by ecflow
ECF_FILES=home + "/files", # task-wrappers location
ECF_INCLUDE=home + "/include", # include files location
# ECF_OUT=home, # output files location on remote systems,
# no directory created there by ecflow...
ECF_EXTN=extn, ), # task wrapper extension
Task(acq).add(Event(1)),
Family("ensemble").add( # ENS
Complete(acq + ":1"),
[Family("%02d" % num).add(
Variables(ID=num),
model(360, dependencies="../../" + acq)) # relative path...
for num in xrange(0, 10)]),
model(240, dependencies=acq), # HRES
Task(post).add(
Trigger("model eq complete"),
Label("info", "")))
#####################################################################
head = """#!/bin/bash
set -e # stop the shell on first error
set -u # fail when using an undefined variable
set -x # echo script lines as they are executed
# Defines the variables that are needed for any communication with ECF
export ECF_PORT=%ECF_PORT% # The server port number
export ECF_HOST=%ECF_HOST% # where the server is running
export ECF_NAME=%ECF_NAME% # The name of this current task
export ECF_PASS=%ECF_PASS% # A unique password
export ECF_TRYNO=%ECF_TRYNO% # Current try number of the task
from ecf import (Defstatus, Suite, Family, Task, Variables, Trigger, Event,
Complete)
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
NAME = os.getenv("SUITE", "elearning")
DEFS = ecflow.Defs()
DEFS.add( # suite definition
Suite(NAME).add(
Defstatus("suspended"), # so that jobs do not start immediately
Variables( # add multiple variables at once:
ECF_HOME=ECF_HOME, # where job files are created by ecflow
ECF_FILES=ECF_HOME + "/files", # where to find script template
ECF_INCLUDE=ECF_HOME + "/include", # where to find head.h tail.h
SLEEP=5),
Family("f1").add(
Task("t1"),
Task("t2").add(Trigger("t1 eq complete"), Event("a"), Event("1")),
Task("t3").add(Trigger("t2:a")),
Task("t4").add(
Complete("t2:1"),
Trigger("t2 eq complete"),
))))
if __name__ == '__main__':
HOST = os.getenv("ECF_HOST", "localhost")
PORT = int(os.getenv("ECF_PORT", "%d" % (1500 + os.getuid())))
CLIENT = ecflow.Client(HOST, PORT)
NODE = "/" + NAME # replace top
CLIENT.replace(NODE, DEFS)
print("replaced node %s into" % NODE, HOST, PORT)