Installation

ESIO uses the GNU autotools suite (autoconf, automake, and libtool) for its development build system.

This system is popular among the Linux development community and provides a familiar build environment for end users.

To build ESIO starting from a release distribution, untar the distribution and enter the top-level directory.

> tar xvfz esio-$(VERSION).tar.gz
> cd esio-$(VERSION)/

Configuration Requirements

GNU Make

You must have GNU Make installed as ESIO's build system relies on many GNU extensions.

Compilers

You must have a working C and Fortran 90 compiler from the same vendor. Currently the GNU (gcc/gfortran) and Intel (icc/ifort) compilers are supported. If ESIO's configure script cannot automatically detect the correct compiler location, try setting $CC and $FC environment variables prior to running configure.

MPI

You must have a working Message Passing Interface (MPI) implementation. If ESIO's configure script cannot automatically detect your MPI installation, try setting the $MPICC and $MPIFC environment variables prior to running configure.

HDF5

You must have a working HDF5 installation compiled with MPI parallel support (see HDF5 configure's –enable-parallel option for details). HDF5 Fortran support is notrequired. The same MPI stack and Fortran compiler used to compile HDF5 must be used to build ESIO. ESIO's configure script should detect the appropriate information if HDF5's h5pcc compiler wrapper is in your path. If your HDF5 installation is not detected correctly, you may use ESIO's –with-hdf5 option to specify a location.

GRVY (optional)

ESIO can optionally use The Groovy Toolkit (GRVY) if it is detected at configure time. If your GRVY installation is not detected correctly, you may use ESIO's –with-grvy option to specify a location.

To configure ESIO, within the esio-0.1.9 directory issue

> ./configure

where you should add any additional configure options at the end of the command. One very useful option is the –prefix=DIR which sets your desired top-level installation directory for ESIO.

By default, ESIO builds both a shared and static library (for example, libesio.so and libesio.a, respectively). This will only succeed if your HDF5 installation was configured with –enable-shared. To disable one or the other, use the –disable-shared or –disable-static option to configure.

Library Build

Once configured, issue a make to build the software. If successful, this will build the ESIO library (static and dynamic versions), several examples, and some additional ESIO-related utilities.

> make 

If you see error messages regarding -fPIC, see the above configuration hints regarding building shared versus static versions of ESIO.

Build Verification (Optional)

To optionally verify that the software is working properly, a check target is provided to run a suite of functionality tests against the local build. To run these tests, issue

> make check 

Many of the tests require your MPI installation's mpiexec command to be usable. Such tests may not be executable on many public high performance computing platform login nodes.

Installation

After the build is complete, issue

> make install 

to install the library. The installation will consist of three top-level directories housing ESIO's include files, compiled libraries, and utilities.