Page History

Text Method

The python method is recommended unless you are planning a simple suite.

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

#

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

1. This line is a comment line. Any characters between the # and the end of line are ignored
2. This line defines a new suite by the name of test.
3. 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
4. This defines a task named t1
5. The endsuite finishes the definition of the suite test 
   
   

Python Method

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

import os
from ecflow import Defs,Suite,Task,Edit
   
print("Creating suite definition")
home = os.path.join(os.getenv("HOME"),"course")
defs = Defs( 
        Suite('test',
            Edit(ECF_HOME=home),
            Task('t1')))
print(defs)

Then run as a python script:   

python3 test.py

#!/usr/bin/env python3            
...

chmod +x test.py
./test.py  # this uses shebang, see below, searches for specified python variant in $PATH

You should see the text "Creating suite definition" and then your definition as your output.