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 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 create_families():
""" provider """
return (Family("f4").add(
Variables(SLEEP=2),
Repeat("NAME", ["a", "b", "c", "d", "e", "f"], kind="enumerated"),
Task("t1")), Family("f5").add(
Repeat("DATE", 20170101, 20200105, kind="date"),
Task("t1").add(Repeat("PARAM", 1, 10, kind="integer"),
Label("info", ""))))
def family_for():
""" for family """
return (
Family("for").add(
process(),
Repeat(kind="integer", name="STEP", start=1, end=240, step=3)),
Family("loop").add(process(), Repeat("PARAM", PARAMS, kind="string")),
Family("parallel").add(Limit("lim", 2), Inlimit("lim"), [
Family(param).add(Edit(PARAM=param),
process().add(Label("info", param)))
for param in PARAMS
]),
Family("explode").add(
Limit("lim", 2),
Inlimit("lim"),
# LIST COMPREHENSION:
[Task("t%d" % num) for num in range(1, 5 + 1)]))
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 call_consumer(selection):
lead = "/%s/consumer/admin/leader:1" % selection
prod = "/%s/consumer/produce" % selection
return Family("consumer").add(
Defstatus("suspended"),
Edit(SLEEP=10,
PRODUCE="no",
CONSUME="no"),
Family("limit").add(
Defstatus("complete"),
Limit("consume", 7),),
Family("admin").add(
# set manually with the GUI or alter the event 1 so
# that producer 1 becomes leader
# default: producer0 leads
Task("leader").add(
Event("1"), # text this task is dummy task not designed to run
Defstatus("complete"))),
Edit(PRODUCE="yes", # default : task does both produce/consume
CONSUME="yes"),
call_task("produce", beg, fin, by).add(
# this task will do both produde/consume serially
Label("info", "both produce and consume in one task")),
Family("produce0").add(
# loop inside the task, report progress with a Meter
not_consumer(),
Label("info", "loop inside the job"),
call_task("produce", beg, fin, by)),
Family("produce1").add(
# choice is to submit a new job for each step, here
Label("info", "loop in the suite (repeat), submit one job per step"),
not_consumer(),
call_task("produce", '%STEP%', "%STEP%", by).add(
Repeat("STEP", beg, fin, by, kind="integer"))),
Family("consume").add(
Label("info", "use ecflow_client --wait %TRIGGER% in the job"),
not_producer(),
Inlimit("limit:consume"),
Edit(CALL_WAITER=1,
# $step will be interpreted in the job!
TRIGGER="../produce:step gt consume:$step or " +
"../produce eq complete"),
call_task("consume", beg, fin, by)),
Family("consume0or1").add(
Label("info", "an event may indicate the leader to trigger from"),
not_producer(),
Inlimit("limit:consume"),
call_task("consume", "%STEP%", "%STEP%", by),
Repeat("STEP", beg, fin, by, kind="integer"),
trigger("(%s and (consume0or1:STEP lt %s1/produce:STEP" % (
lead, prod) + " or %s==complete)) or " % prod +
"(not %s and (consume0or1:STEP lt %s0/produce:step" % (
lead, prod) + " or %s0/produce==complete))" % prod)),
Family("consume1").add(
Label("info", "spread consumer in multiple families"),
not_producer(),
Inlimit("limit:consume"),
consume1(producer=prod)),
Family("consume2").add(
# change manually with the GUI the limit to reduce/increase the load
Label("info", "one family per step to consume"),
Inlimit("limit:consume"),
not_producer(),
consume2(beg, fin, prod)))
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
export ECF_RID=$$ # record the process id. Also used for
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
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)
ECF_HOME = os.path.join(os.getenv("HOME"), "ecflow_server")
ECF_INCLUDE = ECF_HOME + "/include"
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( # we can 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_INCLUDE, # where to find head.h tail.h
SLEEP=2,
),
Family("f3").add(
Task("t1").add(Label("info", "none"), Meter("step", -1, 240)))))
SCRIPT_TEMPLATE = """#!/bin/bash
%include <head.h>
STEP=0
while [[ $STEP -le 240 ]] ; do
sleep %SLEEP:1%; ecflow_client --meter step $STEP # share progress
msg="The date is now $(date)"
ecflow_client --label info "$msg"
(( STEP = STEP + 1))
done
ecflow_client --label info "job's done"
%include <tail.h>
"""
if __name__ == '__main__':
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([
"../analysis/run_analysis",
]), Task("save"), [
Family("step_%02d" % i).add(
Variables(TYPE="forecast", STEP=i),
Trigger(
"../../forecast/run_forecast:step ge %d" %
i), Task("save"))