Versions Compared

Old Version 90

changes.mady.by.user Unknown User (ma0)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (ma0)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Horizontal Navigation Bar


Button Group

Button Hyperlink
titlePrevious
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Getting+Started
Button Hyperlink
titleUp
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Tutorial
Button Hyperlink
titleNext
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Understanding+Includes


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

Code Block
title$HOME/course/test.def
linenumberstrue
# 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      test 

Python Method

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

Code Block
languagepy
title$HOME/course/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 :

  

Code Block
python3 test.py


Alternatively

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

Depending on which version you want to run,
add the following as the first line in test.py 


Code Block
languagepy
title$HOME/course/test.py
#!/usr/bin/env
python2.7
 python3            
...


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

....

test.py

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

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.

  3. Choose python invocation.  i.e.

...

  1.    python3 test.py    |    ./test.py.   

 

  


Horizontal Navigation Bar


Button Group

Button Hyperlink
titlePrevious
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Getting+Started
Button Hyperlink
titleUp
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Tutorial
Button Hyperlink
titleNext
typestandard
urlhttps://softwareconfluence.ecmwf.int/wiki/display/ECFLOW/Understanding+Includes


...