4. Application Development Environment
- 4.1 Information on the available modules
- 4.2 Loading, unloading and swapping modules
- 4.3 Things to watch out for
- 4.4 Compiler wrapper scripts
- 4.5 Available compiler suites
- 4.6 Using dynamic linking/libraries
- 4.7 Compiling for Postprocessing/Serial Nodes
- Switching to older/newer programming environment releases
The application development environment on ARCHER is primarily controlled through the modules environment. By loading and switching modules you control the compilers, libraries and software available.
This means that for compiling on ARCHER you typically swap to the correct Programming Environment ("PrgEnv-" modules, one for each different compiler suite), load all the required library modules (e.g. numerical libraries, IO format libraries) and compile your code using the compiler wrapper script (described in detail below). The combination of the modules environment and the wrapper scripts ensures that all the correct headers and library files are included for you.
By default, all users on ARCHER start with the Cray programming environment loaded (PrgEnv-cray) and the MPI (cray-mpich) and Cray LibSci (cray-libsci includes BLAS, LAPACK and ScaLAPACK) libraries included in their environment.
Details of the ARCHER software and application development environment are available online through the Software Catalogue.
Basic usage of the module command on ARCHER is covered below. For full documentation please see:
4.1 Information on the available modules
Finding out which modules (and hence which compilers, libraries and software) are available on the system is performed using the module avail command:
user@system:~> module avail ...
This will list all the names and versions of the modules available on the service. Not all of them will work in your account though due to, for example, licencing restrictions. You will notice that for many modules we have more than one version, each of which is identified by a version number. One of these versions is marked as the default. As the service develops the default version will change.
You can list all the modules of a particular type by providing an argument to the module avail command. For example, to list all available versions of the Cray Compiler Environment (CCE) type:
user@system:~> module avail cce ...
If you want more info on any of the modules, you can use the module help command:
user@system:~> module help cce ...
The simple module list command will give the names of the modules and their versions you have presently loaded
user@system:~> module list ...
4.2 Loading, unloading and swapping modules
To load a module to use module add or module load. For example, to load the Fastest Fourier Transform in the West (FFTW) library into the development environment:
module add fftw
This will load the default version of the FFTW Library. If you need a specfic version of the module, you can add more information:
module add fftw/220.127.116.11
will load version 18.104.22.168 for you, regardless of the default. If you want to clean up, module remove will remove a loaded module:
module remove fftw
(or module rm fftw or module unload fftw) will unload what ever version of fftw (even if it is not the default) you might have loaded. There are many situations in which you might want to change the presently loaded version to a different one, such as trying the latest version which is not yet the default or using a legacy version to keep compatibility with old data. This can be achieved most easily by using module swap oldmodule newmodule. Suppose you have loaded version 22.214.171.124, say, of FFTW, the following command will change to version 126.96.36.199:
module swap fftw fftw/188.8.131.52
This swapping mechanism is often used to select a diffent compiler suite from the default on the system (which is the Cray compiler: "PrgEnv-cray"). For example, to switch to the GNU compilers:
module swap PrgEnv-cray PrgEnv-gnu
Details of the available compiler environments are provided below.
4.3 Module conflicts and dependencies
Modules can depend or conflict with each other. A conflict between modules may be detected and reported. For example you might see something like the following:
user@eslogin008:~> module load PrgEnv-intel PrgEnv-intel/5.1.29(10):ERROR:150: Module 'PrgEnv-intel/5.1.29' conflicts with the currently loaded module(s) 'PrgEnv-cray/5.1.29' PrgEnv-intel/5.1.29(10):ERROR:102: Tcl command execution failed: conflict PrgEnv-cray
if you have failed to unload the existing programming environment before attempting to load another. To resolve this use module swap PrgEnv-cray PrgEnv-intel instead.
4.4 Compiler Wrapper Scripts
Code compiled on ARCHER should use the compiler wrapper scripts to ensure that all the correct libraries and header files are included in both the compile and link stages. Note: loading a module will automatically set the necessary paths and link flags for that software, eliminating the need to specify them manually using the LDFLAGS variable or another mechanism. For example, the cray-libsci module is loaded by default on log in and sets the the wrappers to link in BLAS, LAPACK and ScaLAPACK functionality without the need for the user to provide an explicit "-llib_sci".
The compiler wrapper scripts are available for Fortran, C, and C++:
The wrapper scripts can be used to compile both sequential and parallel codes. Further information on the wrapper scripts can be obtained from the man pages, for example:
4.5 Available Compiler Suites
ARCHER has 3 compiler suites available:
- The Cray Compiling Environment (CCE). This is the default on ARCHER.
- The GNU Compiler Collection (GCC).
- The Intel compiler suite.
The manual pages for the different compiler suites are available once the programming environment has been switched in and are:
- Fortran man crayftn ,
- C man craycc ,
- C++ man crayCC
- Fortran man gfortran ,
- C/C++ man gcc
- Fortran man ifort ,
- C/C++ man icc
4.5.1 Switching compiler suites
You use the module swap command along with the "PrgEnv-" modules to switch between the compiler suites on ARCHER. The application development environment (modules and wrapper scripts) then ensures that the correct paths are used for all the libraries and compilers when compiling and linking your code.
For example, to switch from the default Cray compiler suite to the GNU compiler suite:
module swap PrgEnv-cray PrgEnv-gnu
Please note: changing between compiler suites (e.g. Cray to GNU, etc.) must be carried out via the PrgEnv modules. Along with selecting the compiler, the programming environment also determines which numerical and MPI libraries are picked up. Attempts to change compiler suite without changing the programming environment may result in the wrong numerical or MPI libraries being used and your code may not compile or may fail to execute as a result.
4.5.2 Changing compiler versions
You can also change compiler versions within each compiler suite if required; for example, you may wish to use an older version of the compiler for compatibility reasons. This process is also controlled by modules. The names of the compiler modules used to switch versions depends on the compiler suite (PrgEnv-) module you have loaded:
- cce module
- gcc module
- intel module
For example, to switch to an older version of the Cray compiler you would use something like:
module swap cce cce/8.2.6
Note: you must change to the correct compiler suite before changing the compiler version.
4.5.3 Useful compiler options
Whilst difference codes will benefit from compiler optimisations in different ways, for reasonable performance on ARCHER, at least initially, we suggest the following compiler options:
- The default options are sufficient
- -O2 -ftree-vectorize -funroll-loops -ffast-math
When you have a code that you are happy is working correctly and has reasonable performance you may wish to investigate some more aggressive compiler optimisations. Below is a list of some further optimisations that you can try on your application (Note: these optimisations may result in incorrect output for programs that depend on an exact implementation of IEEE or ISO rules/specifications for math functions):
- -O3 -hfp3
- -Ofast -funroll-loops
Vectorisation, which is one of the important compiler optimisations for ARCHER, is enabled by default as follows:
- At -O1 and above
- At -O2 and above
- At -O3 and above or when using -ftree-vectorize
To promote integer and real variables from four to eight byte precision for FORTRAN codes the following compiler flags can be used:
- -s real64 -s integer64
- -real-size 64 -integer-size 64 -xAVX
(Sometimes the Intel compiler incorrectly generates AVX2 instructions if the
-r8options are set. Using the
-xAVXoption prevents this.)
- -freal-4-real-8 -finteger-4-integer-8
4.5.4 Intel compilers and GCC for C++ 11
Compiling C++ code to C++ 11 standards is possible with the GNU and Intel compilers on ARCHER. Both use the GNU flag -std=c++11, however the Intel compiler relies on the GNU header files for C++11 support which means that you need to load the gcc module as well as the Intel Programming Enviromnent on ARCHER to perform such compilations. This can be done using the command module load gcc with the PrgEnv-intel module loaded to ensure the Intel compilers are used. e.g.
module swap PrgEnv-cray PrgEnv-intel module load gcc/6.3.0
4.6 Using dynamic linking/libraries
By default, executables on ARCHER are built using static libraries (that is, all of the object code of referenced libraries are contained in the executable file) when using the wrapper scripts. This has the advantage that once an executable is created, whenever it is run in the future, it will always use the same object code and thus give the same results from the same input. However, executables compiled with static libraries have the potential disadvantage that when multiple instances are running simultaneously multiple copies of the libraries used are held in memory. This can lead to large amounts of memory being used to hold the executable and not application data.
Alternatively, applications can be compiled to use shared/dynamic libraries (i.e. libraries which are loaded at run-time as and when needed by the application). This may be because static versions of certain libraries are unavailable, or to reduce the amount of memory executables take by sharing common sections of object codes between applications which use the same library.
To create an application that uses shared/dynamic libraries you must pass extra flags during compilation, or set an environment variable. You can either:
- Use the -dynamic flag when invoking the compiler for linking.
- Set the environment variable CRAYPE_LINK_TYPE=dynamic without any extra compilation/linking options.
By default an application compiled this way to use shared libraries will use the default version of the library installed on the system (just like any other Linux executable), even if the system modules were set differently at compile time. This means that the application may potentially be using slightly different object code each time the application runs as the defaults may change. This is usually the desired behaviour for many applications as any fixes or improvements to the default linked libraries are used without having to recompile the application, however some users may feel this is not the desired behaviour for their applications.
Instead, users may choose to hard code the location of the libraries used during compilation and linking into the resulting executable by setting the CRAY_ADD_RPATH=yes environment variable. The same object code, from the original shared libraries, will be used each time the executable is run, as long as the library files exist. This is very similar to how statically linked executables behave.
Finally, users may wish to choose which version of a library is used through the standard module environment. This is done prepending the value of CRAY_LD_LIBRARY_PATH to the standard LD_LIBRAY_PATH environment variable once all the modules are loaded. This will place all the paths to libraries specified in the modules files ahead of the defaults and allow the Operating System to select the specified versions from the modules in place of the defaults.
Use the UNIX command ldd exe_file to check whether you are using an executable that depends on shared libraries. This utility will also report the shared libraries this executable will use with the current value of LD_LIBRARY_PATH (not CRAY_LD_LIBRARY_PATH ).
4.7 Compiling for Postprocessing/Serial Nodes
If you see an "Illegal Instruction" error when trying to use the postprocessing/serial nodes then it means you are trying to use code compiled for the compute nodes. Please follow the instructions below to compile the code for the postprocessing/serial nodes.
If you wish to use serial executables you compile yourself on the postprocessing/serial nodes (accessed through the Serial Jobs mechanism detailed in the Job Submission System chapter) then you need to compile on the postprocessing/serial nodes themselves using the bare compiler commands rather than the compiler wrapper scripts (i.e. cc, ftn, CC) provided in the Cray Application Developer Environment. This is beacuse the processor architecture used on these nodes is different from that used on the ARCHER login, service and compute nodes.
You can access the postprocessing/serial nodes for compilation either by submitting a serial job with the compile commands in the script or, if you prefer to compile interactively, by submitting an interactive job to the serial queues. Instructions on how to write postprocessing/serial job scripts and on how to run interactive jobs can be found in the Job Submission System chapter at:
The compiler commands you need depend on the programming environment you wish to use. Note, that you must still switch programming environments as described above to be able to access the bare compiler commands. The table below lists the compiler commands for the different programming environments.
Note that the Cray compiler environment does not support compiling code for the architecture on the PP nodes so you should only use the GNU or Intel programming environments.
Note AVX instructions are not available on the serial/PP nodes.
|PrgEnv-cray||Unsupported||Unsupported||Unsupported||Not supported on PP nodes.|
For example, to compile a single source file interactively using the GNU compilers (remember to change the budget code to your own one):
user@eslogin005:~> ssh espp2 user@esPP002:~> module swap PrgEnv-cray PrgEnv-gnu user@esPP002:~> gfortran -o simple_prog.x simple_prog.f90
4.7.1 Including Libraries in Serial Builds
Please note that header and library paths set by the module enviornment do not apply to the bare compilers. You may see errors relating to missing includes such as:
user@eslogin006:~> module load cray-netcdf user@eslogin006:~> gcc test.c test.c:2:20: fatal error: netcdf.h: No such file or directory #include <netcdf.h> ^ compilation terminated.
user@eslogin006:~> module load cray-netcdf user@eslogin006:~> icc test.c test.c(2): catastrophic error: cannot open source file "netcdf.h" #include <netcdf.h> ^ compilation aborted for test.c (code 4)
You can resolve this by explicitly specifying the paths when compiling. Model your commands on the following:
gcc -I/opt/cray/netcdf/4.3.0/GNU/48/include -L/opt/cray/netcdf/4.3.0/GNU/48/lib -lnetcdff -lnetcdf test.c
icc -I/opt/cray/netcdf/4.3.0/INTEL/130/include -L/opt/cray/netcdf/4.3.0/INTEL/130/lib -lnetcdff -lnetcdf test.c
To locate the paths you need, "module show
user@eslogin006:~> module show cray-netcdf ... prepend-path CRAY_LD_LIBRARY_PATH /opt/cray/netcdf/4.3.0/INTEL/130/lib -------------------------------------------------------------------
indicates the cray-netcdf library path for the Intel compiler. These paths may change depending on the currently loaded PrgEnv module.
4.8 Switching to older/newer programming environment releases
The default programming environment (compilers, libraries, etc.) is periodically updated on ARCHER by changing the default versions of many modules. Users are informed in advance of these changes via e-mail and Twitter. Sometimes you may wish to switch back to an old programming environment release (as you code has a dependency on a particular compiler/library version that you have not yet been able to fix) or switch to a newer programming environment release to test compatibility before the defaults on the system are changed.
You can do this by sourceing a special set of files on the system. For example, to switch back to the old April 2014 Programming Environment release, you would enter the command:
user@eslogin006:~> source $EPCC_PE_RELEASE/jan2015
Once this command has been issued, module list should reveal that you now have the old versions of modules loaded. Note that switching to a different release will result in PrgEnv-cray being loaded no matter what PrgEnv you had loaded before the switch. You can then swap to a different PrgEnv if you wish. You can see which Programming Enviroments are available by searching for the associated module files:
user@eslogin006:~> module avail cray-pe-defaults ------------------------- /opt/modules/packages-archer ------------------------- cray-pe-defaults/feb2015 cray-pe-defaults/jan2015 cray-pe-defaults/nov2015
Using the command module help on the cray-pe-defaults modules will reveal information about when they were the default on ARCHER (if ever):
user@eslogin006:~> module help cray-pe-defaults/nov2015 ----------- Module Specific Help for 'cray-pe-defaults/nov2015' --------------------------- Cray Programming Environment: November 2015 ============================================ Set the module defaults to match that of the November 2015 Cray Programming environment. This is the current default on ARCHER (as of 10 Feb 2016). You can reset your environment to this historical version with the command: source $EPCC_PE_RELEASE/nov2015 Installed by: A. Turner, EPCC Date: 11 Februrary 2014
Note: if you want to perform the switch in your job submission script then you must load the epcc-tools module in the script to set the EPCC_PE_RELEASE environment variable before you use the source command. e.g. you would add the following lines to get the Jan 2015 PE release in your job script:
module load epcc-tools source $EPCC_PE_RELEASE/jan2015