Skip to content

Latest commit

 

History

History
89 lines (83 loc) · 3.95 KB

INSTALL.md

File metadata and controls

89 lines (83 loc) · 3.95 KB

The Log VOL connector - Build Instructions

Software Requirements

  • Minimum HDF5 1.14
    • Configured with parallel I/O support (--enable-parallel)
  • MPI C and C++ compilers
    • The plugin uses the constant initializer; a C++ compiler supporting std 17 is required
  • Autotools utility

Building HDF5 libraries

  • HDF5 1.14.0 and later (required)
    • Download HDF5's official latest release. 
      % wget https://github.com/HDFGroup/hdf5/releases/latest/download/hdf5.tar.gz
    • Configure HDF5 with parallel I/O enabled. 
      % tar -zxf hdf5.tar.gz
% cd hdf5-*
% ./configure --prefix=${HOME}/HDF5/latest --enable-parallel CC=mpicc
% make -j4 install
    • The above example commands will install the HD5 library under the folder ${HOME}/HDF5/latest.

Building the Log VOL connector

  • Obtain the source code package by either downloading the official release or cloning the github repository.

    • Download the latest official release version 1.1.0. 
      % wget https://github.com/HDFGroup/vol-log-based/archive/refs/tags/logvol.1.1.0.tar.gz
% tar -zxf logvol.1.1.0.tar.gz
% cd vol-log-based-logvol.1.1.0
    • Clone from the github repository. 
      % git clone https://github.com/HDFGroup/vol-log-based.git
% cd log_io_vol
% autoreconf -i

  • Example configure and make commands are given below.

    % ./configure --prefix=${HOME}/Log_IO_VOL --with-hdf5=${HOME}/HDF5/latest
% make -j 4 install
    • The above commands will install the log-vol library under the folder ${HOME}/Log_IO_VOL.

  • Check the Log VOL connector build

    • Command make tests compiles the test programs (build only, no run).
    • Command make check runs test programs on a single process.
    • Command make ptest runs test programs on 4 MPI processes in parallel.

  • Configure command-line options

    • The full list of configure command-line options can be obtained by running the following command: 
      % ./configure --help
    • Important configure options
      • --enable-shared Shared libraries are required if users intent to enable the Log VOL connector through setting the two HDF5 VOL environment variables, HDF5_VOL_CONNECTOR and HDF5_PLUGIN_PATH. [default: enabled]. See Usage Guide for details.
      • --enable-zlib to enable metadata compression using zlib. [default: disabled].
      • --enable-test-qmcpack to enable tests using QMCPACK [default: disabled]. This option first downloads and builds QMCPACK. Its test program restart.c will be used to test the Log VOL connector during make check.
      • --enable-test-hdf5-iotest to enable tests using hdf5-iotest [default: disabled]. This option first downloads and builds hdf5-iotest. Its test program hdf5_iotest.c will be used to test the Log VOL connector during make check.
      • --enable-test-openpmd to enable tests using OpenPMD [default: disabled]. This option first downloads and builds OpenPMD. Its test program 8a_benchmark_write_parallel.c and 8b_benchmark_read_parallel.c will be used to test the Log VOL connector during make check.
      • --enable-test-netcdf4[=INC,LIB | =DIR] to enable tests using NetCDF-C [default: disabled]. This option can be used to provide the NetCDF installation path(s). It first downloads a few test programs from NetCDF-C, which will be to test the Log VOL connector during make check.