ecFlow's documentation is now on readthedocs!

Please go to https://ecflow.readthedocs.io/en/latest/index.html

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

<style type="text/css">
.highlight .hll

Unknown macro: { background-color}

.highlight

Unknown macro: { background}

.highlight .c

Unknown macro: { color}

/* Comment */
.highlight .err

Unknown macro: { border}

/* Error */
.highlight .k

Unknown macro: { color}

/* Keyword */
.highlight .o

Unknown macro: { color}

/* Operator */
.highlight .cm

Unknown macro: { color}

/* Comment.Multiline */
.highlight .cp

Unknown macro: { color}

/* Comment.Preproc */
.highlight .c1

Unknown macro: { color}

/* Comment.Single */
.highlight .cs

Unknown macro: { color}

/* Comment.Special */
.highlight .gd

Unknown macro: { color}

/* Generic.Deleted */
.highlight .ge

Unknown macro: { font-style}

/* Generic.Emph */
.highlight .gr

Unknown macro: { color}

/* Generic.Error */
.highlight .gh

Unknown macro: { color}

/* Generic.Heading */
.highlight .gi

Unknown macro: { color}

/* Generic.Inserted */
.highlight .go

Unknown macro: { color}

/* Generic.Output */
.highlight .gp

Unknown macro: { color}

/* Generic.Prompt */
.highlight .gs

Unknown macro: { font-weight}

/* Generic.Strong */
.highlight .gu

Unknown macro: { color}

/* Generic.Subheading */
.highlight .gt

Unknown macro: { color}

/* Generic.Traceback */
.highlight .kc

Unknown macro: { color}

/* Keyword.Constant */
.highlight .kd

Unknown macro: { color}

/* Keyword.Declaration */
.highlight .kn

Unknown macro: { color}

/* Keyword.Namespace */
.highlight .kp

Unknown macro: { color}

/* Keyword.Pseudo */
.highlight .kr

Unknown macro: { color}

/* Keyword.Reserved */
.highlight .kt

Unknown macro: { color}

/* Keyword.Type */
.highlight .m

Unknown macro: { color}

/* Literal.Number */
.highlight .s

Unknown macro: { color}

/* Literal.String */
.highlight .na

Unknown macro: { color}

/* Name.Attribute */
.highlight .nb

Unknown macro: { color}

/* Name.Builtin */
.highlight .nc

Unknown macro: { color}

/* Name.Class */
.highlight .no

Unknown macro: { color}

/* Name.Constant */
.highlight .nd

Unknown macro: { color}

/* Name.Decorator */
.highlight .ni

Unknown macro: { color}

/* Name.Entity */
.highlight .ne

Unknown macro: { color}

/* Name.Exception */
.highlight .nf

Unknown macro: { color}

/* Name.Function */
.highlight .nl

Unknown macro: { color}

/* Name.Label */
.highlight .nn

Unknown macro: { color}

/* Name.Namespace */
.highlight .nt

Unknown macro: { color}

/* Name.Tag */
.highlight .nv

Unknown macro: { color}

/* Name.Variable */
.highlight .ow

Unknown macro: { color}

/* Operator.Word */
.highlight .w

Unknown macro: { color}

/* Text.Whitespace */
.highlight .mf

Unknown macro: { color}

/* Literal.Number.Float */
.highlight .mh

Unknown macro: { color}

/* Literal.Number.Hex */
.highlight .mi

Unknown macro: { color}

/* Literal.Number.Integer */
.highlight .mo

Unknown macro: { color}

/* Literal.Number.Oct */
.highlight .sb

Unknown macro: { color}

/* Literal.String.Backtick */
.highlight .sc

Unknown macro: { color}

/* Literal.String.Char */
.highlight .sd

Unknown macro: { color}

/* Literal.String.Doc */
.highlight .s2

Unknown macro: { color}

/* Literal.String.Double */
.highlight .se

Unknown macro: { color}

/* Literal.String.Escape */
.highlight .sh

Unknown macro: { color}

/* Literal.String.Heredoc */
.highlight .si

Unknown macro: { color}

/* Literal.String.Interpol */
.highlight .sx

Unknown macro: { color}

/* Literal.String.Other */
.highlight .sr

Unknown macro: { color}

/* Literal.String.Regex */
.highlight .s1

Unknown macro: { color}

/* Literal.String.Single */
.highlight .ss

Unknown macro: { color}

/* Literal.String.Symbol */
.highlight .bp

Unknown macro: { color}

/* Name.Builtin.Pseudo */
.highlight .vc

Unknown macro: { color}

/* Name.Variable.Class */
.highlight .vg

Unknown macro: { color}

/* Name.Variable.Global */
.highlight .vi

Unknown macro: { color}

/* Name.Variable.Instance */
.highlight .il

Unknown macro: { color}

/* Literal.Number.Integer.Long */
</style>

Tasks can be logically grouped into family‘s.
You can picture a suite as a hierarchical structure very similar to a unix
file system, where the families are the directories and the tasks are the files.
The suite is a family with some extra attributes (See Dates and Clocks).
Like directories, families can themselves contain other families.
And like directories, different families can contain tasks with similar names
# Definition of the suite test.
suite test
   edit ECF_INCLUDE "$HOME/course"
   edit ECF_HOME    "$HOME/course"
   family f1
      task t1
      task t2
   endfamily
endsuite

If you are using the ecFlow Python Api:

#!/usr/bin/env python2.5
import os
import ecflow 
   
def create_family_f1():
    f1 = ecflow.Family("f1")
    f1.add_task("t1")
    f1.add_task("t2")
    return f1
      
defs = ecflow.Defs()
suite = defs.add_suite("test")
suite.add_variable("ECF_INCLUDE",os.getenv("HOME") + "/course")
suite.add_variable("ECF_HOME   ",os.getenv("HOME") + "/course")

suite.add_family( create_family_f1() )
Unless you tell ecFlow where to find specific files, the default behaviour
is to expect the file structure to reflect the structure of the suite.
In this case you will have to create a directory $HOME/course/test/f1,
and move t1.ecf and t2.ecf into it.
Conversely, the ecFlow jobs and the outputs will be created in this directory.
Because we have moved the scripts in another directory, ecFlow will not find
the two included file head.h and tail.h one directory up from
the scripts.
We could modify the scripts to search the include file two directories up,
but this would be very cumbersome.
The solution is to define a special ecFlow variable called ECF_INCLUDE
that points to the directory containing the include files.
We need to do the following changes to the ecf script‘s.

from:

%include "../head.h"
echo "I am part of a suite that lives in %ECF_HOME%"
%include "../tail.h"

to:

%include <head.h>
echo "I am part of a suite that lives in %ECF_HOME%"
%include <tail.h>
suite‘s, family‘s and task‘s are called node‘s.
Because of this analogy with the unix file system, nodes can be addressed
using full names: /test/f1/t1 refers to the task t1, and
/test/f1 refers to the family f1.
In some contexts, ecFlow will accept relative names, such as ../t1.

The hierarchy is shown as a tree in ecflowview.

What to do:

  1. Write the suite definition
  2. Create the directories needed, move the ecf script‘s
  3. Edit the script to include head.h and tail.h from the ECF_INCLUDE directory.
  4. Load and begin the suite again
  5. View the suite in ecflowview, notice the tree structure. You may have to unfold test and f1 to see the tasks, using the middle mouse button.
  • No labels