ecFlow's documentation is now on readthedocs!

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

Compare with Current View Page History

« Previous Version 14 Next »

The aim of this tutorial is to go through most of ecFlow functionality by building a simple suite. Some extension exercises then follow.

Each page will introduce a new notion and provides a list of things to do. At the bottom of most pages, there is a list of hypertext links that point to relevant information in the online ECF documentation.

The course is designed in such a way that each student can follow it at their own pace.

ecFlow allows the suite definition to be entered in any language, including plain text, since there is a defined Definition file Grammar. This grammar does not support conditionals like (if,while,for) or the ability to define functions. However ecFlow provides this capability by using ecFlow Python Api

Note

The following tutorial will show examples in plain text, and python. However it recommended that you use python, since the later tutorial examples use conditionals like ‘if’ and looping constructs.

Throughout the course, we use the following typographic conventions:

  • The plain text

  • A new concept

  • A file name

  • A user interface element (i.e. menu, button,...)

  • invoking a command on a shell will preceded with >:

    > shell command
  • the contents of a file:

    File content, i.e definition file, python, script, or includes files
  • No labels