Difference between revisions of "FLEXPART Model/FLEXPARTCompilerSettings"

From mn/geo/geoit
Jump to: navigation, search
(Compiling FLEXPART in a 64-bit environment)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
This is the README file included now with the FLEXPART distribution
+
FLEXPART has been compiled on UIO servers so if you do not need to modify the source code, we suggest you use the pre-compiled version. If you have never used FLEXPART, the pre-compiled version is also helpful to become familiar with this new package. Some tutorials/examples are available on UIO servers.
  
 
== Compiling FLEXPART in a 64-bit environment ==
 
== Compiling FLEXPART in a 64-bit environment ==
Line 15: Line 15:
 
All of the required settings for FLEXPART are already made in the cmake configuration files (cmake directory) included in the FLEXPART distribution.
 
All of the required settings for FLEXPART are already made in the cmake configuration files (cmake directory) included in the FLEXPART distribution.
  
<br/>Recommended compilation steps using the gfortran or absoft compiler
+
<br />Recommended compilation steps using the gfortran or intel compiler
  
----
 
  
*&nbsp;JPEG compression is used FLEXPART WINDFIELDS and this requires to compile GRIB-API with jpeg support ([http://www.ece.uvic.ca/~frodo/jasper/ JASPER ]&nbsp; library). On UIO servers GRIB-API and Jasper are already installed.
 
  
 +
*&nbsp;JPEG compression is used FLEXPART WINDFIELDS and this requires to compile GRIB-API with jpeg support ([http://www.ece.uvic.ca/~frodo/jasper/ JASPER] &nbsp; library). On UIO servers GRIB-API and Jasper are already installed.
  
 +
<br />Even if you wish to compile your own FLEXPART version, the best is to set-up your environment by loading an existing version of flexpart:
  
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To set-up your environment:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To set-up your environment:
  
  
<pre>                      module load grib_api</pre>
+
<pre>                      module load flexpart</pre>
<br/><br/>Please note that grib_api will be loaded automatically when loading flexpart.
+
<br />You then get the right set of compilers and libraries to compile your own version of FLEXPART. Use the following environment variables:
  
 
+
*'''GRIB_API_HOME''': points to the directory where GRIB-API has been installed
 
+
*'''FLEXPART_HOME''': points to the directory where FLEXPART_HOME has been installed.  
*&nbsp;FLEXPART:
+
*'''FLEXPART_HOME/src''': points to the source code used to compile FLEXPART. the corresponding Makefile is also available in the same src directory. (on abel search for *_abel or use makefile.ecmwf_ifort_geo and on sverdrup for *_geo*)
 
 
Flexpart has already been compiled on sverdrup.uio.no and [http://www.uio.no/english/services/it/research/hpc/abel/ Abel].
 
 
 
 
 
 
 
To check which version is available on abel:
 
<pre>module avail flexpart
 
</pre>
 
To set-up your environment on Abel:
 
<pre>module load flexpart</pre>
 
<br/>This will load the default version of flexpart. The default version of flexpart may not be the latest version. If you start new development, we advice you to load the latest version (highest version number!):
 
<pre>module load flexpart/9.2</pre>
 
&nbsp;
 
 
 
'''FLEXPART_HOME''': directory where flexpart has been compiled/installed. You will find the source code for FLEXPART.<br/>'''FLEXPART_WINDS''': directory where FLEXPART windfields are stored. This directory contains windfields necessary to run all our tutorials/examples.<br/>'''FLEXPART_EXAMPLES''': directory where FLEXPART examples can be found.
 
 
 
&nbsp;
 
 
 
=== Running tutorials ===
 
 
 
To run FLEXPART examples, the best is to copy them in your own directory:
 
<pre>cp -R $FLEXPART_EXAMPLES .
 
 
 
cd HelloWorld
 
 
 
FLEXPART</pre>
 
The name of the main executable is FLEXPART. FLEXPART uses an input file called pathnames where you shall specify the options directory, the output directory and the location of AVAILABLE file for WINDFIELDS.
 
 
 
 
 
 
 
=== How to change and add new code ===
 

Latest revision as of 10:38, 26 April 2017

FLEXPART has been compiled on UIO servers so if you do not need to modify the source code, we suggest you use the pre-compiled version. If you have never used FLEXPART, the pre-compiled version is also helpful to become familiar with this new package. Some tutorials/examples are available on UIO servers.

Compiling FLEXPART in a 64-bit environment

This file describes the required compiler flags for compiling FLEXPART  in a 64-bit computing environment for the gfortran compiler (version 4.2 and onward) and absoft compiler (version 10.1).

Using 64-bit environment brings the advantage of using >2GB main memory for FLEXPART data arrays. However, this requires certain adjustments to the compilation settings of FLEXPART and the external libraries GRIB_API and JASPER (the latter as required by GRIB_API).

The main point to be considered for running FLEXPART in a 64-bit environment is the possiblity to allocate data arrays >2GB. This requires to use the compiler flag -mcmodel=medium. Note that this memory model slows down calculations, if data arrays of less than 2GB are allocated, the use of -mcmodel=small is said to provide slightly better performance.

An additional requirement is that the external libraries must be compiled with the flag -fPIC to allow for the libraries to be located at any position in the computer's main memory. Without this flag, a 'relocation truncated to fit' error will result when linking FLEXPART.

If the compilers are not set to generate 64-bit binaries by default, the flag -m64 should be included for FLEXPART and the external libraries.

All of the required settings for FLEXPART are already made in the cmake configuration files (cmake directory) included in the FLEXPART distribution.


Recommended compilation steps using the gfortran or intel compiler


  •  JPEG compression is used FLEXPART WINDFIELDS and this requires to compile GRIB-API with jpeg support (JASPER   library). On UIO servers GRIB-API and Jasper are already installed.


Even if you wish to compile your own FLEXPART version, the best is to set-up your environment by loading an existing version of flexpart:

            To set-up your environment:


                       module load flexpart


You then get the right set of compilers and libraries to compile your own version of FLEXPART. Use the following environment variables:

  • GRIB_API_HOME: points to the directory where GRIB-API has been installed
  • FLEXPART_HOME: points to the directory where FLEXPART_HOME has been installed.
  • FLEXPART_HOME/src: points to the source code used to compile FLEXPART. the corresponding Makefile is also available in the same src directory. (on abel search for *_abel or use makefile.ecmwf_ifort_geo and on sverdrup for *_geo*)