NEMO 4.0 (beta) + XIOS 2.5

Tested with

gcc4.9, gcc5.4 on a linux system
gcc4.8 on a Mac (El Capitan OSX 10.11)

The code structure in NEMO 4.0 and the use of some commands are slightly different (at least in v9925) and will be documented below (please see the official NEMO annoucement for details). If you get errors that are not documented here, see if the XIOS1.0 NEMO3.6 page contains the relevant errors.

The assumption here is that the compiler is fixed and the packages (e.g., NetCDF4 and a MPI bindings) are configured to be consistent with the compilers. See here to check whether the binaries exist, where they are, and how they might be installed separately if need be. All the #CHANGE ME highlighted below needs be modified to point to the appropriate paths or binaries (soft links with ln -s are ok).

The instructions below uses gcc4.9 for demonstration (modifications with gcc5.4 as appropriate). I defined some extra variables on a Linux machine:

export $BD=/home/julian/testing/gcc4.9-builds # CHANGE ME

export C_INCLUDE_PATH=$BD/install/include:$C_INCLUDE_PATH
export CPLUS_INCLUDE_PATH=$BD/install/include:$CPLUS_INCLUDE_PATH
export LIBRARY_PATH=$BD/install/lib:$LIBRARY_PATH
export LD_LIBRARY_PATH=$BD/install/lib:$LD_LIBRARY_PATH

You shouldn’t need to do the above if the packages are forced to look at the right place (e.g. via -L and/or -I flags with path to libraries and include files respectively). Not all of these are necessary depending on whether you choose to build/have static or dynamic libraries, and the LD_LIBRARY_PATH seems to sort out a lot of problems with linking libraries.

On a Mac done through anaconda the above was not necessary. My understanding is that setting these variables might not actually do anything unless an option is specifically enabled in Xcode.

XIOS 2.5 (svn v1566)

Note

Looks like you could use XIOS 2.0 with NEMO 4.0, so if the following doesn’t work for you, try compiling XIOS 2.0 instead.

Do the following:

mkdir XIOS
cd XIOS
svn checkout -r 1566 http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS/branchs/xios-2.5 xios-2.5

To get XIOS to compile, the compilers and packages need to be pointed to first, via modifying files in arch. Since I am using gcc, I did the following just to make a fresh copy:

cd xios2.5/arch
cp arch-GCC_LINUX.env arch-GCC_local.env
cp arch-GCC_LINUX.fcm arch-GCC_local.fcm
cp arch-GCC_LINUX.path arch-GCC_local.path

The *.env file specifies where HDF5 and NetCDF4 libraries live. The *.fcm file specifies which compilers and options to use. The *.path file specifies which paths and options to include. My files look like the following:

# arch-GCC_local.env

export HDF5_INC_DIR=/usr/local/include       # CHANGE ME
export HDF5_LIB_DIR=/usr/local/lib           # CHANGE ME

export NETCDF_INC_DIR=/usr/local/include     # CHANGE ME
export NETCDF_LIB_DIR=/usr/local/lib         # CHANGE ME

You could get an idea where the HDF5 and NetCDF4 directories are by doing which h5copy and which nc-config (assuming these are on $PATH), which should give you a directory/bin, and it is the directory part you want. If you did install the libraries somewhere else as in other packages, say, then make sure the which commands are pointing to the right place.

# arch-GCC_local.fcm

################################################################################
###################                Projet XIOS               ###################
################################################################################

%CCOMPILER      /usr/local/bin/mpicc                # CHANGE ME
%FCOMPILER      /usr/local/bin/mpif90               # CHANGE ME
%LINKER         /usr/local/bin/mpif90               # CHANGE ME

%BASE_CFLAGS    -ansi -w
%PROD_CFLAGS    -O3 -DBOOST_DISABLE_ASSERTS
%DEV_CFLAGS     -g -O2
%DEBUG_CFLAGS   -g

%BASE_FFLAGS    -D__NONE__
%PROD_FFLAGS    -O3
%DEV_FFLAGS     -g -O2
%DEBUG_FFLAGS   -g

%BASE_INC       -D__NONE__
%BASE_LD        -lstdc++

%CPP            cpp-4.9                             # CHANGE ME
%FPP            cpp-4.9 -P                          # CHANGE ME
%MAKE           make

Check the MPI locations and versions by doing which mpicc and mpicc --version say. If they are the right ones you could just have mpicc instead of the full path as given above. MPI bindings are used here to avoid a possible error that may pop up in relation to the build trying to find mpi.h. The gmake command was swapped out by the make command (I don’t have cmake on the laptop).

Note

For gcc5.4 and maybe newer versions, doing just the above when compiling leads to a whole load of errors about clashing in C++:

.../include/boost/functional/hash/extensions.hpp:69:33: error: ‘template<class T, class A> std::size_t boost::hash_value’ conflicts with a previous declaration
 std::size_t hash_value(std::list<T, A> const& v)
                             ^

Adding -D_GLIBCXX_USE_CXX11_ABI=0 to %BASE_CFLAGS fixes these.

A difference I’ve found between XIOS 2.5 and other XIOS versions is that doing just the above might lead to an error like the following:

This file requires compiler and library support for the ISO C++ 2011 standard. This support is currently experimental, and must be enabled with the -std=c++11 or -std=gnu++11 compiler options.

Adding -std=c++11 to %BASE_CFLAGS seems to fix this.

You might also get the following:

SUBROUTINE cxios_set_interpolate_domain_read_write_convention(interpolate_domain_hdl, read_write_convention, read_write_conventi
                                                                                                                                1
Error: Unexpected junk in formal argument list at (1)

The Fortran lines are too long, so fix this by adding -ffree-line-length-none to %BASE_FFLAGS.

# arch-GCC_local.path

NETCDF_INCDIR="-I$NETCDF_INC_DIR"
NETCDF_LIBDIR="-Wl,'--allow-multiple-definition' -L$NETCDF_LIB_DIR"
NETCDF_LIB="-lnetcdff -lnetcdf"

MPI_INCDIR=""
MPI_LIBDIR=""
MPI_LIB=""

HDF5_INCDIR="-I$HDF5_INC_DIR"
HDF5_LIBDIR="-L$HDF5_LIB_DIR"
HDF5_LIB="-lhdf5_hl -lhdf5 -lhdf5 -lz"

The above has all the OASIS (the atmosphere / ocean coupler) keys removed. I added the -Wl,'--allow-multiple-definition' key for reasons I don’t remember anymore…

I went into bld.cfg, found the line

bld::tool::cflags    %CFLAGS %CBASE_INC -I${PWD}/extern/src_netcdf -I${PWD}/extern/boost/include -I${PWD}/extern/rapidxml/include -I${PWD}/extern/blitz/include

and changed src_netcdf to src_netcdf4 (see XIOS1.0 stuff for the reason).

Now it should be ready to compile. Assuming the current directory is xios2.5/arch:

cd ../
./make_xios --full --prod --arch GCC_local -j2 |& tee compile_log.txt

The -j2 option uses two processors to build. The tee command is to keep logs of potential errors (the |& is short for 2>&1 |) for debugging errors that may arise.

NEMO 4.0 (svn v9925)

There is a restructuring of folders (see the official annoucement for details) so the commands below will reflect this.

Check out a version of NEMO. I have another folder separate to the XIOS folders to contain the NEMO codes and binaries:

mkdir NEMO
cd NEMO
svn checkout -r 9925 http://forge.ipsl.jussieu.fr/nemo/svn/NEMO/trunk nemo4.0-9925

This checks out version 9925 (NEMO 4.0 beta) and dumps it into a folder called nemo4.0-9925 (change the target path to whatever you like).

Note

svn checkout https://forge.ipsl.jussieu.fr/nemo/svn/NEMO/releases/release-4.0 nemo4.0 would pull the official version

A similar procedure to specify compilers and where XIOS lives needs to be done for NEMO. Again, because of the compilers I am using:

cd nemo4.0-9925/arch
cp arch-linux_gfortran.fcm ./gfortran_local.fcm

None of the fcm files associated with gfortran actually worked for me out of the box so here is my build of it (click HERE for a detailed log of how I got to the following):

# gfortran_local.fcm

# generic gfortran compiler options for linux
# NCDF_INC    netcdf include file
# NCDF_LIB    netcdf library
# FC          Fortran compiler command
# FCFLAGS     Fortran compiler flags
# FFLAGS      Fortran 77 compiler flags
# LD          linker
# LDFLAGS     linker flags, e.g. -L<lib dir> if you have libraries in a
# FPPFLAGS    pre-processing flags
# AR          assembler
# ARFLAGS     assembler flags
# MK          make
# USER_INC    additional include files for the compiler,  e.g. -I<include dir>
# USER_LIB    additional libraries to pass to the linker, e.g. -l<library>

%NCDF_HOME           /usr/local                                        # CHANGE ME

%XIOS_HOME           /home/julian/testing/gcc4.9-builds/XIOS/xios-2.5  # CHANGE ME

%CPP                 cpp-4.9                                           # CHANGE ME
%CPPFLAGS            -P -traditional

%XIOS_INC            -I%XIOS_HOME/inc
%XIOS_LIB            -L%XIOS_HOME/lib -lxios

%NCDF_INC            -I%NCDF_HOME/include
%NCDF_LIB            -L%NCDF_HOME/lib -lnetcdf -lnetcdff -lstdc++
%FC                  mpif90                                            # CHANGE ME
%FCFLAGS             -fdefault-real-8 -O3 -funroll-all-loops -fcray-pointer -cpp -ffree-line-length-none
%FFLAGS              %FCFLAGS
%LD                  %FC
%LDFLAGS
%FPPFLAGS            -P -C -traditional
%AR                  ar
%ARFLAGS             -rs
%MK                  make
%USER_INC            %XIOS_INC %NCDF_INC
%USER_LIB            %XIOS_LIB %NCDF_LIB

The main changes are (see here for an attempt at the reasoning and a log of errors that motivates the changes):

added %NCDF_HOME to point to where NetCDF lives
added %XIOS_* keys to point to where XIOS lives
added %CPP and flags, consistent with using gcc4.9
added the -lnetcdff and -lstdc++ flags to NetCDF flags
using mpif90 which is a MPI binding of gfortran-4.9
added -cpp and -ffree-line-length-none to Fortran flags
swapped out gmake with make

Go into the configuration folder by

cd ../cfgs

One of the things I noticed is that makenemo now seems to work slightly differently (at least with this version). Normally you can do makenemo -r GYRE -n GYRE_testing -j0 -m gcc_fortran_local, which copies a configuration but does not compile it, so you can edit the cpp flags before compiling (and note that it adds an entry into works_cfgs.txt). However now it seems you have to specify a -r flag or a -d flag (which specifies what NEMO modules the configuration should have), whereas before just a -n flag would work by itself.

You could just compile as usual with makenemo (see NEMO 3.6 for syntax). The slightly untidy way to circumvent errors that I know will come up was to do the following:

Open refs_cfg.txt, copy the GYRE_PISCES OCE TOP line and paste it at the bottom, but then change the configuration name (GYRE_PISCES to GYRE_testing in my case), save and close it;
Then do

mkdir GYRE_testing
rsync -arv GYRE_PISCES/* GYRE_testing/

I opened /GYRE_testing/cpp_GYRE_testing.fcm and replaced key_top with key_nosignedzero (does not compile TOP for speed speeds, and make sure zeros are not signed), save it;
Compile with (because makenmemo is now one level up)

../makenemo -j2 -r GYRE_testing -m gfortran_local |& tee compile_log.txt

(note the -r rather than -n flag here).

Warning

See if this feature of makenemo has been modified in the trunk?

Note the executable opa is now called nemo (so make sure you change those submission scripts on the relevant clusters if you use NEMO on them). Check that it does run with the following:

cd GYRE_testing/EXP00
mpiexec -n 1 ./nemo

Note that what used to be solver.stat is now called run.stat, and there is an extra run.stat.nc for whatever reason. The ocean.output file is still the same.

Note

If your installation compiles but does not run with the following error

dyld: Library not loaded: @rpath/libnetcdff.6.dylib
Referenced from: /paths/./nemo
Reason: no suitable image found.  Did find:
/usr/local/lib/libnetcdff.6.dylib: stat() failed with errno=13

then it is not finding the right libraries. These could be fixed by adding the -Wl,-rpath,/fill me in/lib flag to the relevant flags bit in the *.fcm files (or possibly in XIOS the path and/or env ) to specify exactly where the libraries live. This can happen for example on a Mac or if the libraries are installed not at the usual place.

Note

One infuriating problem I had specifically with a Mac (though it might be a gcc4.8 issue) is that the run does not get beyond the initialisation stage. Going into ocean.output and searching for E R R O R shows that it complained about a misspelled namelist item (in my case it was in the namberg namelist). If you go into output.namelist.dyn and look for the offending namelist is that it might be reading in nonsense. This may happen if the comment character ! is right next to a variable, e.g.

ln_icebergs = .true.!this is a comment

Fix this by adding a white space, i.e.

ln_icebergs = .true. !this is a comment