SURFEX

Libraries package

Minvielle — 2026-02-02T16:35:39Z

LIB-SURFEX-9-1-0.tar.gz

Install an run a pre-defined experiment

Minvielle — 2026-01-29T15:30:54Z

How to install a pre-defined experiment:

in new terminal, in src/ directory
export VER_USER=FORC
run ./configure
./configure
execute the profile file corresponding to this user version of surfex
. ../conf/profile_surfex-LXgfortran-SFX-V9-1-0-FORC-MPIAUTO-O2-X0
run make user and make installuser to create the specific executables in directory exe/
make user
make installuser
go into MY_RUN/FORCING directory and run prepare_forcing.bash with a name of experiment as argument. For example, here, the experiment 'hapex'
./prepare_forcing.bash hapex
A namelist MY_PARAM.nam will open (vi editor). For the first time, it's not necessary to modify this namelist. So, you can simply quit (use command :q)
Some information will then be written on the screen and should look like:
— namelist NAM_MY_PARAM read
> ==========================================
> PREP_INPUT_EXPERIMENT: YEXPER = HAPEX
> PREP_INPUT_EXPERIMENT: INI = 1
> PREP_INPUT_EXPERIMENT: INPTS = 17521
> PREP_INPUT_EXPERIMENT: JNPTS = 17521
> PREP_INPUT_EXPERIMENT: ZTSTEPFRC = 1800.
> PREP_INPUT_EXPERIMENT: YFORCING_FILETYPE = NETCDF
> ===========================================
YFILE_FORCIN=../DATA/hapex/HAPEX.DAT.30
– rw-r—r— 1 lemoigne mc2 1543644 jui 22 16:51 /home/lemoigne/surfex/open_SURFEX_V8_1/MY_RUN/FORCING/FORCING.nc
==============================================
> input files moved to /home/lemoigne/surfex/open_SURFEX_V8_1/MY_RUN/KTEST/hapex
==============================================
Once the installation is done, go to $SRC_SURFEX/MY_RUN/KTEST/hapex directory and launch successively:
./pgd.exe
./prep.exe
./offline.exe
If you code is correctly installed and compiled, PGD, PREP and OFFLINE PGD should run correctly, and you should get .TXT output files in your run directory.

Compilation options

Minvielle — 2026-01-23T16:51:51Z

To change the default options of compilation : export OPTION=myoption
For exemple, to compile without MPI library
export VER_MPI=NOMPI

Options for VER_MPI:
- NOMPI (no MPI), MPIAUTO (default MPI library on the PC), specific libraries to be defined
Options for VER_OMP:
- NOOMP (no Open-mp), OMP (Open-mp)
Options for OPTLEVEL ( optimization level ) :
- DEBUG, O2
Options for VER_CDF ( Netcdf library):
- CDFAUTO (included in SURFEX), CDFCTI (installed on CNRM computers), other pre-installed libraries on computers.
Options for VER_DRHOOK ( DR_HOOK library):
- BYPASS (dummies), MINI (minimal HOOK, no parallelization), SIMPLE (simplified DRHOOK)
Options for VER_OASIS (OASIS library):
- NOmct (no OASIS), mct (OASIS)

Recompiling your own sources

Minvielle — 2026-01-23T15:59:22Z

You may develop and modify the original (MASTER) version of the SURFEX code.
Here we explain how to compile your own sources only.

Suppose you want to create a "MYSRC" version.

1. Prepare your source directory
Put your own sources in a subdirectory of "$SRC_SURFEX/src" named $SRC_SURFEX/src/MYSRC

2. Recompiling
Logout of the current session to be sure to unset all the environnement variables loaded with the your 'master 'profile_surfex'. Login again and go in your src/ directory
- set the variable "VER_USER" with the name of your "USER VERSION",
- set also the optional ARCH, VER_MPI... you want to use.
and run again the "./configure" command

export VER_USER=MYSRC
./configure

This will regenerate the "profile-surfex" file and a copy of this with the extent "profile_surfex...$VER_USER..."
As for the compilation of the MASTER version, load it & and compile with the command "make user"

. ../conf/profile_surfex-LXgfortran-SFX-V9-0-0-MYSRC-MPIAUTO-OMP-O2-X0
make user

This will compile only your sources and the files depending on your sources and generate the new executables in your own directory dir_obj-**/MYSRC/

3. Install the new binaries in the $SRC_SURFEX/exe/

make installuser

Installing SURFEX on your Météo-France/CNRM computer

Minvielle — 2026-01-22T18:02:04Z

On Météo-France/CNRM computers, the './configure' is tuned to identify the computer on which the command is used so the good compiler, MPI & netCDF libraries, ... are automatically chosen.

OPEN-SURFEX
So you don't need to install anything before compiling the code.

SURFEX from GIT repository (opensource)
So you don't need to install anything before compiling the code.

SURFEX from GITHUB repository
Starting with SURFEX 9.1 and above, certain libraries (previously included in the repository) have been externalized and are available for download. Only if you need to use OASIS and/or XIOS, and only for a SURFEX version 9.1 (and above) installation :

download the libraries package which corresponds to your code version
copy this package in the src/LIB directory of your SURFEX repository
untar the package (tar -xzvf LIB-SURFEX-9-1-0.tar.gz)

Compiling SURFEX

Minvielle — 2026-01-22T15:39:42Z

Compilation must be done in the src/ directory. Go to the src/ directory. For the installation process, you could now use the ./configure script. Compilation options by default are:
- the compiler choosen to be "gfortran" => ARCH=LXgfortran
- the MPI library to be the MPIAUTO => VER_MPI=MPIAUTO
- the level of optimization for the compiler => OPTLEVEL=O2
To change these options, please refer to the section dedicated to the compilation options.

./configure

This will create a configuration file "profile_surfex-***" with an extension reflecting the different "choices" made automatically to match the computer on which you want to install SURFEX. The name of the profile created is indicated on your screen at the end of the execution of the ./configure (this exemple of compilation is indicated with default options of compilation).

. ../conf/profile_surfex-LXgfortran-SFX-V9-0-0-MPIAUTO-OMP-O2-X0

Run the compilation by executing 'make' (if you have a multi-processor machine you can speedup the compilation, for example on four cores, with make -j 4)

make

The object files "*.o" & main executables of SURFEX (PGD, PREP, OFFLINE, SODA) are compiled in one step and created in the directory dir_obj-$(ARCH).../MASTER/ . The exact name of this "dir_obj..." depends on the different environnement variables set by the "profile_surfex...." which you have loaded before the compilation.
This allows by loading different "profile_surfex.." files to compile in the same source/installation directory different versions of SURFEX, with different compilers, different versions of MPI, different USER sources... To install the new compiled program in the "$SRC_SURFEX/exe" directory, after compilation, just run :

make installmaster

The executables with their full name, including $ARCH, compiler, MPI and level of optimization, will be linked in the "../exe" directory.
The "make installmaster" need to be done only one time by "version". If you only change/add source, you have to do "make".

Installing SURFEX on your Linux computer

Minvielle — 2026-01-22T09:58:39Z

To run SURFEX, several packages need to be installed on a Linux PC. Before to install SURFEX, please verify these packages are present on your computer.

shell KSH
glibc, make, a fortran compiler (if none is ever installed, choose Gfortran+GCC)
C++
cmake

Optional :

MPI library (OPENMPI for exemple)
If MPI is not installed, SURFEX needs to be compiled without parallelization. See details in the section options of compilation.

Additional packages for Ubuntu 20.04 LTS / Ubuntu 22.04 LTS and Ubuntu 24.04 LTS:

curl (with gnutls flavour): packages curl and libcurl4-gnutls-dev

OPEN-SURFEX
If you have dowloaded the open-SURFEX code directly on the website, first untar the file open_surfex_v9_0_0_20231024.tar.gz where you want. For example, in your home directory:

cd $HOME
tar -xvfz open_surfex_v9_0_0_20231024.tar.gz

SURFEX from GIT repository (opensource)
No additionnal action before compiling

SURFEX from GITHUB repository
Starting with SURFEX version 9.1, certain libraries (previously included in the repository) have been externalized and are available for download. For a SURFEX version 9.1 (and above) installation :

download the libraries package which corresponds to your code version
copy this package in the src/LIB directory of your SURFEX repository
untar the package (tar -xzvf LIB-SURFEX-9-1-0.tar.gz)