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 88 Next »

This page contains macros or features from a plugin which requires a valid license.

You will need to contact your administrator.

Previous Up Next

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

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

$HOME/course/test.def
# 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:
  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 :

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:  There are  a few ways to run  different python versions.

# python 2 is the default
module load python
python test.py

module load python3
python3 test.py

To always target a target a specific python version :

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

test.py

#!/usr/bin/env python2.7
print "hello world"

test.py

#!/usr/bin/env python3
print("hello world")

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

What to do

  1. Initially try both plain text and python examples. Later examples are only in python.
  2. Type in the suite definition file.
      
Previous Up Next
  • No labels