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

  • Create a directory called course in your home directory (mkdir course)

  • Open a new window, change the current directory to course (cd course) and start an ecf_server: If you are using a shared machine then type:

    > ecf_start.sh

    This will start an ecf_server running on your system with a port number unique to your user ID. ECF log files and check point files are created in the current directory by default.

    Please keep a note of the Host and Port given from your ecf_start output for later. Note that the default for ECF log files is the ~/ecf_server directory. The host and program number uniquely identify your ECF server. When you want to access this server with ecFlow Python Api or ecFlowview you need to know these numbers. By setting the value of the variable ECF_NODE and ECF_PORT you identify the server you wish to access. Multiple ecf_server‘s can run on the same system.

    Alternatively if you are running on your own local machine type:

    > ecf_server

    at the unix prompt.

    This will start an ecf_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 port number, then you will get an “Address in use” error. To start the server on a specific port number you can use:

    > ecf_server --port=3500

    or

    > export ECF_PORT=3500; ecf_server

    ECF 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 ECF server in the past it will also attempt to recover from a previous ecf checkpoint file if available

  • In another window, change the current directory to course and copy the file head.h and tail.h into it.

head.h

#!/bin/ksh
set -e # stop the shell on first error
set -u # fail when using an undefined variable
set -x # echo script lines as they are executed


# Defines the variables that are needed for any communication with ECF
export ECF_PORT=%ECF_PORT%    # The server port number
export ECF_NODE=%ECF_NODE%    # The name of ecf host that issued this task
export ECF_NAME=%ECF_NAME%    # The name of this current task
export ECF_PASS=%ECF_PASS%    # A unique password
export ECF_TRYNO=%ECF_TRYNO%  # Current try number of the task
export ECF_RID=$$


# Tell ecFlow we have stated
ecf_client --init=$$


# Defined a error hanlder
ERROR() {
   set +e                      # Clear -e flag, so we don't fail
   ecf_client --abort=trap     # Notify ecFlow that something went wrong, using 'trap' as the reason
   trap 0                      # Remove the trap
   exit 0                      # End the script
}


# Trap any calls to exit and errors caught by the -e flag
trap ERROR 0


# Trap any signal that may cause the script to fail
trap '{ echo "Killed by a signal"; ERROR ; }' 1 2 3 4 5 6 7 8 10 12 13 15

tail.h

ecf_client --complete  # Notify ecFlow of a normal end
trap 0                 # Remove all traps
exit 0                 # End the shell
  • No labels