|
|
= Quickstart for the impatient
|
|
|
1. **Requirements**
|
|
|
* libtool
|
|
|
* automake
|
|
|
* autoconf >= 2.60
|
|
|
* HDF5 >= 1.8.x
|
|
|
* (optional) MPI implementation (openmpi, ...)
|
|
|
[[br]][[br]]
|
|
|
1. **Run autotools**
|
|
|
{{{
|
|
|
./autogen.sh
|
|
|
}}}
|
|
|
1. **Configure**[[br]]
|
|
|
For the serial implementation
|
|
|
{{{
|
|
|
./configure
|
|
|
}}}
|
|
|
For the parallel implementation configure with
|
|
|
{{{
|
|
|
./configure --enable-parallel
|
|
|
}}}
|
|
|
If you want to build Fortran bindings, add `--enable-fortran` to the configure line.
|
|
|
[[br]][[br]]
|
|
|
1. **Build the Library**[[br]]
|
|
|
Run
|
|
|
{{{
|
|
|
make
|
|
|
}}}
|
|
|
to build the library. The libraries are named accordingly
|
|
|
* `libH5hutC`: C API
|
|
|
* `libH5hutF`: Fortran API
|
|
|
* `libH5hut`: core functions used by the C and Fortran APIs.
|
|
|
[[br]][[br]]
|
|
|
1. **Run Regression Tests (optional)**[[br]]
|
|
|
[[NoteBox(note, The step is optional - but sometimes very helpful to get your toolchain working. In many cases it's a problem with MPI.)]]
|
|
|
Run
|
|
|
{{{
|
|
|
make test
|
|
|
}}}
|
|
|
[[br]][[br]]
|
|
|
1. **Install**[[br]]
|
|
|
Run
|
|
|
{{{
|
|
|
make install
|
|
|
}}}
|
|
|
to install H5hut. The default prefix is `/usr/local`.
|
|
|
|
|
|
= Details for H5hut Configure and Build =
|
|
|
== Configure Options ==
|
|
|
`--prefix=PREFIX`:: Install architecture-independent files in `PREFIX`. Default = `/usr/local`.
|
|
|
|
|
|
`--exec-prefix=EPREFIX`:: Install architecture-dependent files in `EPREFIX`. Default = `PREFIX`.
|
|
|
|
|
|
`--enable-debug`:: Compile with debug flags. Default = no.
|
|
|
|
|
|
`--enable-c`:: Compile the C API. Default = yes.
|
|
|
|
|
|
`--enable-fortran`:: Compile the Fortran API. Default = no.
|
|
|
|
|
|
`--enable-parallel`:: Compile the MPI/IO interface. Default = no.
|
|
|
|
|
|
`--with-hdf5`:: Path to HDF5 installation. Default = "".
|
|
|
|
|
|
`--with-mpi`:: Path to MPI installation. Default = "".
|
|
|
|
|
|
`--with-lustre`:: Path to Lustre user API. Default = "".
|
|
|
|
|
|
== Environment Variables for Configure ==
|
|
|
|
|
|
`CC`:: C compiler command
|
|
|
`CFLAGS`:: C compiler flags
|
|
|
`LDFLAGS`:: Linker flags, e.g. -L<lib dir> if you have libraries in a nonstandard directory <lib dir>
|
|
|
`LIBS`:: Libraries to pass to the linker, e.g. -l<library>
|
|
|
`CPPFLAGS`:: C/C++ preprocessor flags, e.g. -I<include dir> if you have headers in a nonstandard directory <include dir>
|
|
|
`CXX`:: C++ compiler command
|
|
|
`CXXFLAGS`:: C++ compiler flags
|
|
|
`CPP`:: C preprocessor
|
|
|
`CXXCPP`:: C++ preprocessor
|
|
|
`FC`:: Fortran compiler command
|
|
|
`FCFLAGS`:: Fortran compiler flags |