Labels

Sometime it is very useful to see task specific information in ecflow_ui. For this we can define a label. A label is a string that is attached to a task and that can be updated using the child command ecflow_client –label

Ecf Script

We will create new family f3 with a task t1. Create ecf script $HOME/course/test/f3/t1.ecf

Listing 41 $HOME/course/test/label/t1.ecf

%include <head.h>

n=1
while [[ $n -le 5 ]]                  # Loop 5 times
do
   msg="The date is now $(date)"
   ecflow_client --label=info "$msg"  # Set the label
   sleep 60                           # Wait a one minute
   (( n = $n + 1 ))
done

ecflow_client --label=info "I have now finished my work."

%include <tail.h>

Text

# Definition of the suite test. Note Family f1,f2 from previous pages are omitted
suite test
   edit ECF_INCLUDE "$HOME/course"
   edit ECF_HOME    "$HOME/course"
   family label
      task t1
            label info ""
   endfamily
endsuite

Python

The following section shows how to add a ecflow.Label in Python. (Note: families f1 and f2 are omitted for brevity).

Listing 42 $HOME/course/test.py

import os
from ecflow import (
    Defs,
    Suite,
    Family,
    Task,
    Edit,
    Trigger,
    Complete,
    Event,
    Meter,
    Time,
    Day,
    Date,
    Label,
)


def create_family_label():
    return Family("label", Task("t1", Label("info", "")))


print("Creating suite definition")
home = os.path.join(os.getenv("HOME"), "course")
defs = Defs(Suite("test", Edit(ECF_INCLUDE=home, ECF_HOME=home), create_family_label()))
print(defs)

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

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

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

What to do

Modify the suite definition file or python script
Create the new ecf script file $HOME/course/test/f3/t1.ecf
Replace the suite definition
Watch in ecflow_ui
Change the label colour in ecFlowUI, Tools > Preferences… > Appearance > Node Labels