Compiling and Linking

Before compiling in the RC environment, first ssh to one of the Summit compile nodes via ssh scompile. Next, load those modules corresponding to the compiler, MPI version (if needed), and any third-party libraries required by your application. The load order should always be compiler first, MPI second, and third-party libraries last.

For example, suppose your application requires MPI and the HDF5 library. To compile using the Intel compiler and Intel MPI, the sequence of module commands would be:

module purge
module load intel
module load impi
module load hdf5

Supporting library-modules will be loaded as needed, and your environment will be updated so that the appropriate library directories are prepended to your $PATH and $LD_LIBRARY_PATH. The standard compiler variables FC, CC and CXX are set as appropriate for your compiler/MPI combination. These environment variables reference to the Fortran, C, and C++ compilers respectively

In addition, several environment variables are set that may be useful during the compilation process. These variables are prefixed by CURC and may easily be found by searching your environment for CURC via env | grep CURC. This will yield output similar to:

[johndoe@shas0137 ~]$ env | grep CURC
CURC_INTEL_BIN=/curc/sw/intel/17.4/bin
CURC_INTEL_INC=/curc/sw/intel/17.4/include
CURC_INTEL_ROOT=/curc/sw/intel/17.4
CURC_INTEL_LIB=/curc/sw/intel/17.4/lib
CURC_HDF5_ROOT=/curc/sw/hdf5/1.10.1/impi/17.3/intel/17.4
CURC_HDF5_INC=/curc/sw/hdf5/1.10.1/impi/17.3/intel/17.4/include
CURC_HDF5_BIN=/curc/sw/hdf5/1.10.1/impi/17.3/intel/17.4/bin
CURC_HDF5_LIB=/curc/sw/hdf5/1.10.1/impi/17.3/intel/17.4/lib
[...]

Once the relevant modules are loaded, you are ready to compile. For our HDF5 example, a compilation command that uses the environment variables set by the module system may look like:

$FC my_program.f90 -I$CURC_HDF5_INC -L$CURC_HDF5_LIB -lhdf5_fortran -o my_program

Note: Your run-time environment should reflect your compilation environment. Be sure to include the same sequence of module commands in your job script as that used at compile time.

Navigating the Software Stack

The RC module system is hierarchical in nature, and available software libraries become visible to the user only after the compiler and MPI implementations that they depend on have been loaded. As noted above, modules should be loaded in the order: compiler, MPI, third-party software. At each stage of the load, executing module avail will reveal a list of newly available modules. The module purge command can be used to unload all currently loaded modules.

For example, before choosing a compiler, we can view the available compilers with

[janedoe@shas0136 ~]$ module purge
[janedoe@shas0136 ~]$ module avail

This will yield output similar to

----------------------------------- Compilers --------------------------------------
   gcc/6.1.0    intel/16.0.3 (m)    intel/17.0.0 (m)    intel/17.4 (m,D)    pgi/16.5 ,

Several compiler-independent modules will also be displayed. Those modules (e.g., the Julia module) can be loaded at any time, irrespective of the compiler or MPI version in use.

If multiple versions of a package are available, a D is used to indicate the default version. When the version number is omitted during the module load command, the default version will be used. Considering the output above, the following two commands are equivalent:

[janedoe@shas0136 ~]$ module load intel

[janedoe@shas0136 ~]$ module load intel/17.4

Once the compiler is loaded, MPI-implementations and third-party serial libraries that depend on that compiler appear in the available module list until MPI Implementations and Compiler Dependent Applications:

[janedoe@shas0136 ~]$ module load intel
[janedoe@shas0136 ~]$ module avail
----------------------------------- MPI Implementations --------------------------------------
   impi/17.3
---------------------------------- Compiler Dependent Applications ---------------------------
   antlr/2.7.7    gdal/2.2.1    gsl/2.4        hdf5/1.10.1              (D)    jasper/1.900.1    mkl/17.3  (m)    ncview/2.1.7      openjpeg/2.2.0    szip/2.1.1
   fftw/3.3.4     geos/3.6.2    hdf5/1.8.18    intel_cluster_tools/17.3        jpeg/9b           nco/4.6.0        netcdf/4.4.1.1    proj/4.9.2        zlib/1.2.11

Choosing an MPI implementation will similarly reveal MPI-dependent software under the header MPI Dependent Applications:

[janedoe@shas0136 ~]$ module load impi
[janedoe@shas0136 ~]$ module avail
 ---------------------------------- MPI Dependent Applications -------------------
   boost/1.64.0        hdf5/1.8.18        lammps/31Mar17        perfsuite/1.1.4
   fftw/3.3.4   (D)    hdf5/1.10.1 (D)    netcdf/4.4.1.1 (D)    petsc/3.8.0

You may search for a particular software package using the module spider command. This is typically a two-stage process. First search on the general software name without including any version information. If the software exists on our system, a list of available versions will appear:

[janedoe@shas0136 ~]$ module spider hdf5
----------------------------------------------------------------
  hdf5:
----------------------------------------------------------------
    Description:
      HDF5 Tools and Library

     Versions:
        hdf5/1.8.15
        hdf5/1.8.18
        hdf5/1.10.0
        hdf5/1.10.1

Finally, to see which modules must be loaded to make your desired version available, run the module spider command again with the version information included:

[janedoe@shas0136 ~]$ module spider hdf5/1.10.1
------------------------------------------------------------------
  hdf5: hdf5/1.10.1
------------------------------------------------------------------
    Description:
      HDF5 Tools and Library

    You will need to load all module(s) on any one of the lines below before
    the "hdf5/1.10.1" module is available to load.

      intel/17.4
      intel/17.4  impi/17.3
[...]

Compiler and Optimization Recommendations

The Summit and Blanca clusters run on Intel-designed hardware. As such, we strongly recommend using the Intel compiler along with Intel’s MPI library when compiling software. For production, we suggest compiling with the -O2 or -O3 optimization flags along with the vectorization flags appropriate for the node you plan to run on. For Haswell nodes, this means compiling with the -xCORE-AVX2 flag. For the Xeon-Phi and Skylake nodes, use -xCORE-AVX512.

Compilation commands for a typical Summit Haswell node should resemble:

$FC -O3 -xCORE-AVX2 my_program.f90 -o my_program.out
$CC -O3 -xCORE-AVX2 my_program.c -o my_program.out
$CXX -O3 -xCORE-AVX2 my_program.cpp -o my_program.out

For the Phi and Skylake nodes, the appropriate commands would be:

$FC -O3 -xCORE-AVX512 my_program.f90 -o my_program.out
$CC -O3 -xCORE-AVX512 my_program.c -o my_program.out
$CXX -O3 -xCORE-AVX512 my_program.cpp -o my_program.out

Linking to the Math Kernel Library (MKL)

The Intel Math Kernel Library (MKL) provides optimized routines for a number of common mathematical operations. Notably, it provides interfaces to the LAPack and BLAS linear algebra libraries as well as the FFTW Fourier transform package.

If you wish to link MKL to your Intel-compiled application, use the -mkl flag:

$CXX -O3 -xCORE-AVX2 my_program.cpp -o my_program.out -mkl

If your application uses FFTW, you will also need to include MKL’s FFTW directory in your compilation command:

$CXX -O3 -xCORE-AVX2 -I$CURC_MKL_INC/fftw my_program.cpp -o my_program.out -mkl

For the GNU and PGI compilers, the link syntax becomes more complex. The Intel Link Advisor can be used to generate the appropriate linking syntax based on your application’s needs.

For the GNU compiler, linking against sequential MKL libraries, the appropriate Fortran linking syntax is:

$FC my_program.f90  -m64 -I$CURC_MKL_INC -o my_program.out  -L$CURC_MKL_LIB -Wl,--no-as-needed -lmkl_gf_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl

The comparable c/c++ syntax would be:

$FC my_program.cpp  -m64 -I$CURC_MKL_INC -o my_program.out   -L$CURC_MKL_LIB -Wl,--no-as-needed -lmkl_intel_lp64 -lmkl_sequential -lmkl_core -lpthread -lm -ldl

Note that if your application uses FFTW, you will must use the FFTW include flag just as with the Intel compiler. See the link advisor or contact rc-help@colorado.edu if you have additional questions about how to link MKL to your application.