Quick start FT-MPI
==================

This is a short documentation for experienced users. Details to each
of the steps can either be found in the man-pages or in the detailed
documentation.  To start a FT-MPI job, the following steps have to be
taken:

1. FT-MPI uses a number of environment variables. These have to be set
   on all hosts. We recommend including them into your .profile (or
   similar files). A complete list of all required variables can be found
   in ${HARNESS-directory}/hcore/envs.[sh,csh]

2. Start the name-service on a host with the port-number
   specified in HARNESS_NS_HOST respectively HARNESS_NS_HOST_PORT 
   e.g

 	./name_service 

   Note that you can override the setting of the environment variable by
   specifying the portnumber as a calling argument to the name-service
   daemon, e.g

	./name_service 1935

   if you would like to use the port-number 1935.

3. Start the notifier service e.g.
	./ftmpi_notifier

   Note: if using the console, both daemons can be started up by 
         the console automatically. However, the output of these
         daemons are then not available.

4. For managing the actual jobs, the user has two possibilities:
   either start on each machine an instance of startup_d
   (manually or with the console, see below), or start on each host an
   instance of the general Harness daemon g_hcore_d and load the ftmpi-plugin. 
   We focus in the following on the first solution. To start startup-daemons
   on the hosts host1, host2 and host3 using the console, the following
   steps have to be taken:

 	bash> console
	cons> add host1 host2 host3

  or
	bash> console -f hostfile 

  where hostfile has the following format:
	host1
	host2
	host3

  or
        bash> console
        cons> add -f hostfile

5. Compile an ftmpi-job, either by using ftmpicc, e.g.
	ftmpicc -o myexec myexec.c

  or manually (required sometimes for more complex scenarios)
	cc -o myexec myexec.c -I${HARNESS_ROOT}/hcore/include 
           -L${HARNESS_ROOT}/hcore/lib/${HARNESS_ARCH} -lftmpi

6. Start an ftmpi job either manually, e.g.
	ftmpirun -np 4 -o ./myexec

  or using the console
	cons> spawn -np 4 -mpi -o ./myexec

Note: 
   - please use the -o option, if you would like to have the output 
     in the same window where you started your job.
   - IMPORTANT: please make sure, that the executable is 
     in your ${HARNESS_ROOT}/bin/${HARNESS_ARCH} directory
     This restrictive procedure has been introduced for security 
	 reasons.

For more information see the INSTALL, README and CONSOLE.README files.

