ECFLOW USERS GUIDE
December 2015
This document is produced as a supplement to the online training course.
© Copyright 2012
European Centre for Medium Range Weather Forecasts Shinfield Park, Reading, RG2 9AX, United Kingdom
Literary and scientific copyrights belong to ECMWF and are reserved in all countries.
The information within this publication is given in good faith and considered to be true, but ECMWF accepts no liability for error, omission and for loss or damage arising from its use.Table of Contents
Table of Contents
1 Introduction to ECFLOW
2 Running ECFLOW
2.1 Overview
2.2 Status of a task
2.3 Status of a family or suite
2.4 Using ECFLOW
2.5 Suite Definitions
2.6 Writing ECFLOW scripts
2.7 Time Critical tasks
2.8 Running tasks on remote systems
2.9 Moving suites between ECFLOW servers
2.10 Debugging definition files
2.11 Debugging ECFLOW scripts
3 The ECFLOW Pre-processor
3.1 Locating '.ecf' file
3.2 ECFLOW Manual pages
3.3 Include files
3.4 Comments
3.5 Stopping pre-processing
3.6 ECF_MICRO
3.7 How a job file is created from an ecFlow file
4 ECFLOW variables
4.1 Variable inheritance
4.2 ECFLOW Server environment variables
4.3 Environment variables for the ECFLOW client
4.4 ECFLOW suite definition variables
4.5 Generated Variables
4.6 Variables and Substitution
5 Text based suite definition format
5.1 Defining a suite, using the text definition file format
5.2 Dependencies
5.3 Attributes
6 Defining a suite using the python API
6.2 Defining a suite, using the Python API
6.3 Dependencies
6.4 Attributes
6.5 Control Structures and Looping
6.6 Adding externs automatically
6.7 Checking the suite definition
6.8 Checking Job Generation
6.9 Handling Dummy Tasks
6.10 Simulation of a running suite
6.11 Error Handling
7 The ecFlow Server
7.1 Starting the ecFlow Server
7.2 Stopping ecFlow servers
7.3 Checking if an ECFLOW server is running on a host
7.4 Start-up files for ECFLOW server
7.5 Security
7.6 Security: ECFLOW White list file
7.7 Handling Output
8 ECFLOW CLI (Command Level Interface)
8.1 get
8.2 CLI scripting in batch
8.3 Configuring ECFLOW
8.4 Compiler and OS requirements
9 Flags used by ECFLOW
10 ecflowview
10.1 Main window menus
10.2 ecflowview "buttons"
10.3 Menus
10.4 The Collector
10.5 Searching
10.6 Dependencies
10.7 Editing scripts
10.8 Zombies