Hprc banner tamu.png

Difference between revisions of "Ada:Compile:Intro"

From TAMU HPRC
Jump to: navigation, search
(Toolchain selection)
(Toolchain selection)
 
(8 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
=== Toolchain selection ===
 
=== Toolchain selection ===
  
For developing code on ada we recommend using the '''intel''' software stack (which is often referenced as a "toolchain" here at HPRC), which includes the Intel compilers (icc/icpc/ifort), the Intel Math Kernel Library (MKL), and the Intel MPI. Additionally, the Intel compilers are the only compilers able to compile programs for the Phi co-processors.
+
For developing code on Ada we recommend using the '''intel''' software stack (which is often referenced as a "toolchain" here at HPRC), which includes the Intel compilers (icc/icpc/ifort), the Intel Math Kernel Library (MKL), and the Intel MPI. '''A note for Ada Users:''' the Intel compilers are the only compilers able to compile programs for the Phi co-processors.
 
 
To load the latest (and possibly untested) Intel software stack, enter:
 
 
 
<pre>
 
module load intel
 
</pre>
 
 
 
However we highly recommend users select a particular toolchain and stick with modules that use it.
 
 
 
At present, we support the following toolchains:
 
  
 +
We highly recommend users select a particular toolchain and stick with modules that use it. At present, we support the following toolchains:
 
* '''intel''' - described above
 
* '''intel''' - described above
 
* '''iomkl''' - which substitutes OpenMPI for Intel's MPI
 
* '''iomkl''' - which substitutes OpenMPI for Intel's MPI
 
* '''foss''' - which is entirely Free and Open-Source Software (GCC/OpenMPI/BLAS/LAPACK/etc)
 
* '''foss''' - which is entirely Free and Open-Source Software (GCC/OpenMPI/BLAS/LAPACK/etc)
  
At present, we support the following toolchain releases:
+
<font color=teal>Detailed information about each of the currently supported toolchain releases can be found on our [[SW:Toolchains | Toolchains]] page.</font><br>
  
* '''intel/2015B''' - This has evolved over the lifetime of Ada and has the most libraries presently available. Given its evolution it isn't the crispest in terms of versioning but is well tested.
+
Toolchains, like software packages on our clusters, are organized with the [[SW:Modules | Modules System]]. You can load a toolchain with the following command:
* '''intel/2016a''' -This is the current development environment for new projects.  It isn't as rich in terms of libraries but is better versioned.
+
[ netID@cluser ~]$ '''module load ''[toolchain Name]'''''
* '''intel/2016b''' - This will likely play a role in the future but isn't being supported yet. (for new C++)
+
<font color=teal>'''Important Note:''' Do '''NOT''' mix modules from different toolchains. Remember to '''ALWAYS''' purge all modules when switching toolchains.</font><br>
* '''iomkl/2015B''' - Primarily created for R but has other uses.
+
More information on using the Modules System can be found on our [[SW:Modules | Modules System]] page.
* '''iomkl/2016a''' - Similar to 2015B
 
* '''goolf/1.7.20''' - The precursor to the other '''foss''' toolchains and probably the richest but stalest of the FOSS toolchain libraries.
 
* '''foss/2016a''' - For new FOSS development
 
* '''foss/2016b''' - Available, but not supported yet (for new C++)
 
 
 
Each of those has their own distinct combination of compiler/MPI/math.  The newer ones will have more appeal to those using newer C++ codes. The older ones are probably more of interest to those with legacy code.
 
 
 
After you decide upon a toolchain, you can do something like:
 
<pre>
 
module load intel/2016a
 
# or
 
ml intel/2016a  # "ml" == "module load" in this case
 
</pre>
 
followed by:
 
<pre>
 
module list
 
# or
 
ml              # "ml" == "module list" in this case
 
</pre>
 
to see what components are in the toolchain. Be sure to do a:
 
<pre>
 
module purge
 
# or
 
ml purge        # "ml" == "module" in this case
 
</pre>
 
when switching between toolchains.
 
 
 
'''DO NOT MIX MODULES FROM DIFFERENT TOOLCHAINS'''... it only causes grief.
 
 
 
For more information about the module system on ada, please visit the [[Ada:Computing_Environment#Modules|modules]] page.
 
  
 
=== Using the intel toolchain ===
 
=== Using the intel toolchain ===
  
After initializing the compiler environment, you can use the &quot;man&quot; command to obtain a complete list of the available compilation options for the language you plan to use. For example:
+
After initializing the compiler environment, you can use the &quot;man&quot; command to obtain a complete list of the available compilation options for the language you plan to use. The following three commands will provide information on the C, C++, and Fortran compilers, respectively.
 
+
[ netID@cluster ~]$ '''man icc'''
<pre> 
+
[ netID@cluster ~]$ '''man icpc'''
    man icc
+
[ netID@cluster ~]$ '''man ifort'''
    man icpc
 
    man ifort
 
</pre>
 
 
 
will provide information on the C, the C++ and the Fortran compilers, respectively.
 
  
 
Each compiler requires appropriate file name extensions. These extensions are meant to identify files with different programming language contents, thereby enabling the compiler script to hand these files to the appropriate compiling subsystem: preprocessor, compiler, linker, etc. See table below for valid extensions for each language.
 
Each compiler requires appropriate file name extensions. These extensions are meant to identify files with different programming language contents, thereby enabling the compiler script to hand these files to the appropriate compiling subsystem: preprocessor, compiler, linker, etc. See table below for valid extensions for each language.
  
{| class="wikitable" style="text-align: center;"
+
{| class="<!-- mw-collapsible mw-collapsed--> wikitable" style="text-align: center;"
 +
|+ Basic Valid File Extensions
 
! Extension
 
! Extension
 
! Compiler
 
! Compiler
Line 85: Line 42:
 
| .f, .for, .ftn
 
| .f, .for, .ftn
 
| ifort
 
| ifort
| fixed form Fortran source code passd to the compiler.
+
| Fixed form Fortran source code passd to the compiler.
 
|-
 
|-
 
| .fpp
 
| .fpp
Line 93: Line 50:
 
| .f90
 
| .f90
 
| ifort
 
| ifort
| free form Fortran 90/95 source code passed to the compiler.
+
| Free form Fortran 90/95 source code passed to the compiler.
 
|-
 
|-
 
| .F
 
| .F
Line 101: Line 58:
 
| .o
 
| .o
 
| icc/icpc/ifort
 
| icc/icpc/ifort
| compiled object file--generated with the -c option--passed to the linker.
+
| Compiled object file--generated with the -c option--passed to the linker.
 
|}
 
|}
  
 
+
'''Note:''' The icpc command ("C++" compiler) uses the same compiler options as the icc ("C" compiler) command. Invoking the compiler using icpc compiles '.c', and '.i' files as C++. Invoking the compiler using icc compiles '.c' and '.i' files as C. Using icpc always links in C++ libraries. Using icc only links in C++ libraries if C++ source is provided on the command line.
'''NOTE:''' The icpc command ("C++" compiler) uses the same compiler options as the icc ("C" compiler) command. Invoking the compiler using icpc compiles '.c', and '.i' files as C++. Invoking the compiler using icc compiles '.c' and '.i' files as C. Using icpc always links in C++ libraries. Using icc only links in C++ libraries if C++ source is provided on the command line.
 
  
  
 
[[Category:Ada]]
 
[[Category:Ada]]
[[Category:Eos]]
+
[[Category:Terra]]

Latest revision as of 09:56, 25 April 2018

Getting Started

Toolchain selection

For developing code on Ada we recommend using the intel software stack (which is often referenced as a "toolchain" here at HPRC), which includes the Intel compilers (icc/icpc/ifort), the Intel Math Kernel Library (MKL), and the Intel MPI. A note for Ada Users: the Intel compilers are the only compilers able to compile programs for the Phi co-processors.

We highly recommend users select a particular toolchain and stick with modules that use it. At present, we support the following toolchains:

  • intel - described above
  • iomkl - which substitutes OpenMPI for Intel's MPI
  • foss - which is entirely Free and Open-Source Software (GCC/OpenMPI/BLAS/LAPACK/etc)

Detailed information about each of the currently supported toolchain releases can be found on our Toolchains page.

Toolchains, like software packages on our clusters, are organized with the Modules System. You can load a toolchain with the following command:

[ netID@cluser ~]$ module load [toolchain Name]

Important Note: Do NOT mix modules from different toolchains. Remember to ALWAYS purge all modules when switching toolchains.
More information on using the Modules System can be found on our Modules System page.

Using the intel toolchain

After initializing the compiler environment, you can use the "man" command to obtain a complete list of the available compilation options for the language you plan to use. The following three commands will provide information on the C, C++, and Fortran compilers, respectively.

[ netID@cluster ~]$ man icc
[ netID@cluster ~]$ man icpc
[ netID@cluster ~]$ man ifort

Each compiler requires appropriate file name extensions. These extensions are meant to identify files with different programming language contents, thereby enabling the compiler script to hand these files to the appropriate compiling subsystem: preprocessor, compiler, linker, etc. See table below for valid extensions for each language.

Basic Valid File Extensions
Extension Compiler Description
.c icc C source code passed to the compiler.
.C, .CC, .cc, .cpp, .cxx icpc C++ source code passed to the compiler.
.f, .for, .ftn ifort Fixed form Fortran source code passd to the compiler.
.fpp ifort Fortran fixed form source code that can be preprocessed by the Intel Fortran preprocessor fpp.
.f90 ifort Free form Fortran 90/95 source code passed to the compiler.
.F ifort Fortran fixed form source code, will be passed to preprocessor (fpp) and then passed to the Fortran compiler.
.o icc/icpc/ifort Compiled object file--generated with the -c option--passed to the linker.

Note: The icpc command ("C++" compiler) uses the same compiler options as the icc ("C" compiler) command. Invoking the compiler using icpc compiles '.c', and '.i' files as C++. Invoking the compiler using icc compiles '.c' and '.i' files as C. Using icpc always links in C++ libraries. Using icc only links in C++ libraries if C++ source is provided on the command line.