Page History

There are several ways of defining the suite definition. See Definition creation strategies.

This tutorial will give examples for both the plain text and Python methods.

Text Method¶

Create a file called test.def,using your favourite text editor, with the following contents

...

 Definition of the suite test

suite test
   edit ECF_HOME "$HOME/course"  # replace '$HOME' with the path to your home directory
   task t1

...

endsuite

This file contains the suite definition of a suite called test.
This suite contains a single task called t1.
Let us go through the lines one by one:

This line is a comment line. Any characters between the # and the end of line are ignored
The second line is empty
This line defines a new suite by the name of test.
Here we define a ecflow variable called ECF_HOME. This variable defines the directory where all the unix files that will be used by the suite test will reside. For the rest of the course all file names will be given relative to this directory. Be sure to replace $HOME with the path to your home directory
This defines a task named t1
The endsuite finishes the definition of the suite test

Enter the following python code into a file, i.e test.py :

#!/usr/bin/env python2.

...

import os
import ecflow 
   

...

print

...

Creating suite definition

...

defs

...

 ecflow.Defs()
suite = defs.add_suite("test")
suite.add_variable("ECF_HOME", os.getenv("HOME") + "/course")
suite.add_task("t1")

Then run as a python script:

python test.py

Note

All the following python examples should be run in the same way.

Initially try both plain text and python examples. Later examples are only in python.
Type in the suite definition file.