*************************************************************************
*                                                                       *
*                 HeteroMPI Programming Environment                     *
*                 ============================                          *
*                                                                       *
*  Copyright (c) 2002          Department of Computer Science,          *
*                              University College Dublin.               *
*                                                                       *
*  All rights reserved. We assume no responsibility for the use         *
*  or reliability of our software.                                      *
*                                                                       *
*************************************************************************


Direct requests, comments, questions, and error reports to:

   M. Ravi Reddy
   Department of Computer Science
   University College Dublin
   Email: manumachu.reddy@ucd.ie

   Alexey L. Lastovetsky
   Department of Computer Science
   University College Dublin
   Email: Alexey.Lastovetsky@ucd.ie

The file tree is compressed: tar and gzip are used (suffix: .tar.gz)

To uncompress the file tree use:

   gzip -d heterompi-X.Y.Z.tar.gz
   tar -xvf heterompi-X.Y.Z.tar

where X.Y.Z stands for the installed version of the HeteroMPI library
(say 1.2.3, 2.0.2 or 2.0.3)

The directory 'heterompi-X.Y.Z' will be created; execute

   cd heterompi-X.Y.Z

The subdirectories of heterompi-X.Y.Z and their contents are as follows:

directory       contents
------------------------------------------------------------------------
INSTALL         this file
install_hmpi	Script that installs the HeteroMPI library
Makefile        installation and test of the compiler and environment
docs            Installation and users guide in pdf format
man             manual pages for the HeteroMPI interface
src             library source
include         header files
tests		HeteroMPI source files, subdirectories and makefiles for
		testing HeteroMPI library
tools		HeteroMPI tools to load the binary, clean the HeteroMPI 
                repository
Third_Party_Software
		contains Graph partitioning libraries

Platforms:
----------

The HeteroMPI programming environment has been installed and tested on the following
platforms:
SunOS 5.9 (gcc version 3.4.1)
Linux 2.6.5-1.358smp (gcc version 3.3.3 20040412 (Red Hat Linux 3.3.3-7))
Linux 2.6.8-1.521smp (gcc version 3.3.3 20040412 (Red Hat Linux 3.3.3-7))
Linux 2.6.5-1.358 (gcc version 3.3.3 20040412 (Red Hat Linux 3.3.3-7))
Linux 2.4.18-3 ((gcc version 2.96 20000731 (Red Hat Linux 7.3 2.96-110))

The HeteroMPI programming environment has been successfully tested on LAM 7.1.1 and MPICH-1.2.5.2.

If you got problems during installation on another platform, please,
send your comments to the authors whose details are given at the beginning 
of this file.

Before Installation:
--------------------

MPI and MPC should be installed before the installation of the HeteroMPI environment.

Installation:
-------------

The Makefile at the global level (heterompi-X.Y.Z/Makefile) controls the
compilation and installation of the HeteroMPI software. It activates
subdirectory specific Makefiles.

Export the variable HMPI_HOME to point to the installation directory 
(directory where binaries of HeteroMPI will be installed)

shell$ cd heterompi-X.Y.Z

To compile all the programs execute:

shell$ ./install_hmpi

To clean up:

shell$ make clean

to remove object files and executables from source directories.

To uninstall HeteroMPI,

shell$ ./uninstall

How to use the HeteroMPI programming environment:
-------------------------------------------------

See HeteroMPI User's Guide for more details.

Each test in the $HMPI_HOME/tests directory has a README, which 
explains the purpose of the test.
