Page tree
Skip to end of metadata
Go to start of metadata

First ensure that the paths to ecFlow executables are accessible. At ECMWF this is done using module command. Hence type the following at the command line.

module load ecflow/4.12.0

Create a directory called course in your home directory and change to that directory. If you do not use modules you will need to add the correct path to your ecFlow binaries:

e.g.  in ksh   export PATH=/usr/local/apps/ecflow/4.12.0/bin:$PATH

mkdir course; cd course

In order to use ecFlow we first need to start the ecflow_server

Shared Machine

On a shared machine multiple users and ecFlow servers can coexist. To allow this we have a startup script "" that will start an ecflow_server.  This will start an ecflow_server running on your system with a port number unique to your user ID. By default this script creates ecFlow log and check point files in the directory $HOME/ecflow_server. You can change the location of the log and checkpoint files using the -d option, e.g. to output these file in the course directory: -d $HOME/course

Please keep a note of the Host and Port given from your output for later. The host and port number uniquely identify your ecflow_server . When you want to access this server using ecflow_client Client Server API or ecflow_ui you need to know these information. By setting the value of the environment variables ECF_HOST and ECF_PORT you identify the server you wish to access. Multiple ecflow_servers can run on the same system using different port numbers.

Local Machine

We prefer to start the ecFlow server with the script to help prevent unintentional shared usage of the server. However, you could use the default ECF_PORT and started a server running on your own local machine using the following command:


at the UNIX prompt. 

This will start an ecflow_server running on your system with a default host name of “localhost” and port number of 3141. If another program on your machine is using this same port number, then you will get an “Address in use” error. To start the server on a specific port number you can use:

ecflow_server --port=3500


export ECF_PORT=3500; ecflow_server

ecflow_server log files and check point files are created in the current directory by default, and have a prefix <machine_name>.<port_number>. As this allows multiple servers to run on the same machine. If you had previously run the same ecflow_server in the past it will also attempt to recover the suite definition from the check point file.

What to do

  1. Type   module load ecflow/4.12.0   to set up up the paths.

  2. Create the $HOME/course directory

  3. Start the server using -d $HOME/course

  4. Make a note of the ECF_HOST and ECF_PORT variables.
  5. Note: If in the subsequent sections, you have the need to start a new shell, and want access to the server, then ensure that ECF_PORT is set.(also call module load ecflow/4.12.0, in each new shell)




  • No labels