source: CONFIG/UNIFORM/v6/LMDZOR_v6.3/compile_lmdzor.sh @ 6860

#!/bin/bash
#set -vx
# Default options
#
#
#
date
#### 1  Set up the compiling options
#### Define some directories
submitdir=$( pwd )
modipsl=$submitdir/../..
arch_path=$submitdir/ARCH 

#### Set default options 
# Optimization mode
# optmode=prod/dev/debug
optmode=prod
# Resolution of LMDZ in regular mode
resol_atm=144x142x79
# Also compile ce0l subprogram to LMDZ (y/n)
ce0l=y

# fcm_arch
fcm_arch=default
# Default values to be overritten
parallel=mpi_omp
# Compilation with rrtm or ecrad radiative code (default rad=rrtm)
rad=rrtm
opt_rad=""
# Compilation with Cosp (cosp=NONE/v1/v2 ; default=NONE)
cosp=NONE

# Compilation with flag StratAer (option -strataer)
opt_strataer=""

export fcm_arch parallel xios
full_flag=""
full_xios=""
full_lmdz=""
full_orch=""

# Default netcdf_lib is used for XIOS but can be change by argument
netcdf_lib=""

## Arguments in order to compress temporary files after compilation
tar=no
comp_tar=yes

# Output text file for compilation of each component
datestr=`LC_ALL=C date +"%Y%m%dT%H%M"`
outfile=$submitdir/out_compile_lmdzor.$datestr
echo > $outfile
echo; echo "Text output from compilation will be stored in file out_compile_lmdzor.$datestr"; echo 

#### Read arguments 
# Loop over all arguments to modify default set up
while (($# > 0)) ; do
    case $1 in
        "-h") cat <<end_help
########################################################################
# Usage of the script compile_lmdzor.sh
#
########################################################################

./compile_config [Options] 

Options: 
  [-full]: full recompilation of all components 
  [-debug], [-dev], [-prod](default): use compilation options for debug, dev or production mode, only one option can be used
  [-resol_atm]: set resolution of LMDZ in regular mode
  [-tar]: option to compress XIOS and/or LMDZ/libo repositories that takes many inodes without compilation
  [-comp_tar]: option to compile and compress XIOS and LMDZ/libo repositories if compilation succed (default option)
  [-notar]: do not compress XIOS and LMDZ/libo repositories

Example 1: Default compilation of LMDZ-ORCHIDEE with XIOS and IOIPSL
./compile_lmdzor.sh

Example 2: Compile in debug mode
./compile_lmdzor.sh -debug

Example 3: Default compilation with full recompilation of all components
./compile_lmdzor.sh -full

Example 4: Compilation of LMDZ in regular lat-lon for other dimensions (default: 144x142x79) 
The dimension can be changed to any other 3d dimension.
./compile_lmdzor.sh -resol_atm 96x95x79

Example 5: Compile without compressing XIOS and LMDZ/libo in tar files
./compile_lmdzor.sh -notar

end_help
exit;;
        "-parallel")        parallel=$2 ; shift ; shift ;; 
        "-rad")             rad=$2 ; shift ; shift ;;
        "-cosp")            cosp=$2 ; shift ; shift ;;
        "-strataer")        opt_strataer="-strataer true" ; shift ; shift ;;
        "-arch")            fcm_arch="$2" ; shift ; shift ;;
        "-xios")            xios="$2" ; shift ; shift ;;
        "-debug")           optmode=debug ; shift ;;
        "-dev")             optmode=dev ; shift ;;
        "-prod")            optmode=prod ; shift ;;
        "-resol_atm")       resol_atm=$2 ; shift ; shift ;;
        "CE0L")             ce0l=y ; shift ;;
        "-full")            full_flag="-full"; full_xios="--full" ; full_lmdz="-full" ; full_orch="-full" ; shift ;;
        "-full_xios")       full_xios="--full" ; shift ;;  # Note only full_xios is using double dash: --full
        "-full_lmdz")       full_lmdz="-full"  ; shift ;;
        "-full_orch")       full_orch="-full"  ; shift ;;
        "-netcdf_lib_seq")  netcdf_lib="--netcdf_lib netcdf4_seq"; shift ;;
        "-tar")             tar=yes ; shift ;;
        "-comp_tar")        comp_tar=yes ; shift ;;
        "-notar")           comp_tar=no ; shift ;;
        *)                  echo "unknown option "$1" , exiting..." ; exit 
    esac
done

echo "Following options are set in current compiling:" >> $outfile 
echo "   resol_atm=${resol_atm}" >> $outfile 
echo "   ce0l=${ce0l}" >> $outfile 
echo "   optmode = $optmode, parallel = $parallel, fcm_arch = $fcm_arch " >> $outfile 
echo "   full_flag=$full_flag, full_xios=$full_xios, full_lmdz=$full_lmdz, full_orch=$full_orch" >> $outfile 
echo "   tar=$tar, comp_tar=$comp_tar" >> $outfile
echo >> $outfile

if [ $cosp = v1 ] ; then
    opt_cosp="-cosp true"
elif [ $cosp = v2 ] ; then
    opt_cosp="-cospv2 true"
else
    opt_cosp=""
fi


# Compress XIOS and LMDZ/libo without compiling if tar=yes
if [ $tar == yes ] ; then
    echo "Option tar activated to compress XIOS and LMDZ/libo. No compilation will be done."
    echo >> $outfile
    echo "Option tar activated to compress XIOS and LMDZ/libo. No compilation will be done." >> $outfile
    if [[ -d $modipsl/modeles/XIOS ]] ; then
        echo " Now tar XIOS repository"
        echo " Now tar XIOS repository" >> $outfile
        tar -cf $modipsl/modeles/XIOS.tar $modipsl/modeles/XIOS
        rm -rf $modipsl/modeles/XIOS
    else
        echo " No XIOS repository to compress"
        echo " No XIOS repository to compress" >> $outfile
    fi

    if [[ -d $modipsl/modeles/LMDZ/libo ]] ; then
        echo "Now tar LMDZ/libo repository"
        echo "Now tar LMDZ/libo repository" >> $outfile
        tar -cf $modipsl/modeles/LMDZ/libo.tar $modipsl/modeles/LMDZ/libo
        rm -rf $modipsl/modeles/LMDZ/libo
    else
        echo " No LMDZ/libo repository to compress"
        echo " No LMDZ/libo repository to compress" >> $outfile
    fi
        
    echo "END OF SCRIPT"
    echo "END OF SCRIPT" >> $outfile
    exit
fi

### Read host dependent default values
### These variables will not be changed if they were set as argument
###./host.sh $host
# Later : Following lines should be set in host.sh file
# begin host.sh
if [ $fcm_arch == default ] ; then
    # Find out current host and source specific paths and commands for the host
    case $( hostname -s ) in
        jean-zay*)
            if [[ $( hostname -s ) != *"pp"* ]] ; then
                echo "Warning! You MUST compile on jean-zay-pp."
                echo "EXIT"
                exit
            else
                fcm_arch=X64_JEANZAY
            fi ;;
        irene170|irene171|irene190|irene191|irene192|irene193)
            fcm_arch=X64_IRENE;;
        irene172|irene173|irene194|irene195)
            fcm_arch=X64_IRENE-AMD;;
        asterix*|obelix*)
            fcm_arch=ifort_LSCE
            if [ "${parallel}" == "mpi_omp" ] ; then 
                echo "Warning!! Currently at Obelix hybrid mode is not possible."
                echo "          Option -parallel mpi_omp is now changed to -parallel mpi"
                echo ""
                parallel=mpi
            else
                echo "You used -parallel" $parallel
            fi ;;
        spirit*)
            fcm_arch=ifort_MESOIPSL;;
        ciclad*|climserv*|loholt*|camelot*)
            fcm_arch=ifort_CICLAD;;
        *)
            echo Current host is not known. You must use option -arch to specify which architecuture files to use.
            echo Exit now.
            exit
    esac
fi

# Set a link to arch.env if arch-${fcm_arch}.env file exist for current fcm_arch.
# The link arch.env is also set in config.card and will be used by libIGCM to ensure the same running environnement.
if [ -f ARCH/arch-${fcm_arch}.env ] ; then
    echo >> $outfile
    echo "The file ARCH/arch-${fcm_arch}.env will now be sourced with modules needed for compilation for all components."
    echo "Note that this new environement might be kept after compilation." 
    echo "If this is the case, source again your personal environment after compilation. "
    echo " Personal module list before sourcing of ARCH/arch.env file:"    >> $outfile  
    module list   >> $outfile 2>&1 
    # Get initial svn version
    svn_version=$(module list -t | grep subversion)
    
    # Make a link to this file, to be used also in config.card
    rm -f ARCH/arch.env
    ln -s arch-${fcm_arch}.env ARCH/arch.env

    # Source the file
    source ARCH/arch.env   >> $outfile 2>&1 
    if [ X$svn_version != X ] ; then
        # Put back initial version of svn
        module load ${svn_version}
    fi

    echo >> $outfile 
    echo " New module list after sourcing of ARCH/arch.env file:"    >> $outfile  
    module list   >> $outfile 2>&1 
fi


#### 2 Do the compilation 
## 2.1 Compile ioipsl
cd $modipsl/modeles/IOIPSL
echo; echo "NOW COMPILE IOIPSL"
echo >> $outfile ; echo " NOW COMPILE IOIPSL"   >> $outfile 

# Check if compilation with fcm is included in IOIPSL
if [ ! -f makeioipsl_fcm ] ; then
  echo "The file makeiopsl_fcm do not exist. Probably this is not the right version of IOIPSL."
  echo "Version of IOIPSL with fcm compilation is needed to compile with this script. Stop now."
  exit
fi

echo ./makeioipsl_fcm -$optmode -arch ${fcm_arch} -arch_path $arch_path -j 8 $full_flag   >> $outfile 
     ./makeioipsl_fcm -$optmode -arch ${fcm_arch} -arch_path $arch_path -j 8 $full_flag   >> $outfile 2>&1
# Test if compiling succeded 
if [[ $? != 0 ]] ; then 
    echo "THERE IS A PROBLEM IN IOIPSL COMPILATION - STOP"
    exit
fi

## 2.2 Compile xios

echo; echo "NOW DECOMPRESS XIOS IF NEEDED"
# First check if XIOS needs to be decompressed
# In priority search for modeles/XIOS_${optmode}.tar but if it doesn't exist take
# the first which is found. 
if [[ -d $modipsl/modeles/XIOS ]] ; then
    echo "Found XIOS -> no decompress needs to be do";  >> $outfile
elif [[ -f $modipsl/modeles/XIOS_${optmode}.tar ]]; then
    echo >> $outfile
    echo "Found XIOS_${optmode}.tar -> decompress repository" >> $outfile
    # Do not write "tar -xf ... -C $modipsl/modeles because it's modeles/XIOS that is compressed, not only XIOS/
    tar -xf $modipsl/modeles/XIOS_${optmode}.tar -C $modipsl/ >> $outfile 2>&1
elif [[ -f $modipsl/modeles/XIOS_prod.tar ]]; then
    echo >> $outfile
    echo "Found XIOS_prod.tar -> decompress repository" >> $outfile
    tar -xf $modipsl/modeles/XIOS_prod.tar -C $modipsl/ >> $outfile 2>&1
elif [[ -f $modipsl/modeles/XIOS_debug.tar ]]; then
    echo >> $outfile
    echo "Found XIOS_debug.tar -> decompress repository" >> $outfile
    tar -xf $modipsl/modeles/XIOS_debug.tar -C $modipsl/ >> $outfile 2>&1
elif [[ -f $modipsl/modeles/XIOS_dev.tar ]]; then
    echo >> $outfile
    echo "Found XIOS_dev.tar -> decompress repository" >> $outfile
    tar -xf $modipsl/modeles/XIOS_dev.tar -C $modipsl/ >> $outfile 2>&1
elif [[ -f $modipsl/modeles/XIOS.tar ]]; then
    echo >> $outfile
    echo "Found XIOS.tar -> decompress repository" >> $outfile
    tar -xf $modipsl/modeles/XIOS.tar -C $modipsl/ >> $outfile 2>&1
else
    echo "XIOS source code was not found. Exit"
    echo "XIOS source code was not found. Exit" >> $outfile
    exit
fi


cd $modipsl/modeles/XIOS
echo; echo "NOW COMPILE XIOS"
echo >> $outfile ; echo " NOW COMPILE XIOS"   >> $outfile 
echo ./make_xios --$optmode --arch $fcm_arch --arch_path $arch_path ${netcdf_lib} --job 4 $full_xios   >> $outfile 
     ./make_xios --$optmode --arch $fcm_arch --arch_path $arch_path ${netcdf_lib} --job 4 $full_xios   >> $outfile 2>&1
# Test if compiling succeded 
if [[ $? != 0 ]] ; then 
    echo "THERE IS A PROBLEM IN XIOS COMPILATION - STOP"
    exit
fi
# Move executables to modipsl/bin
if [ -f $modipsl/modeles/XIOS/bin/xios_server.exe ] ; then 
    mv $modipsl/modeles/XIOS/bin/xios_server.exe $modipsl/bin/xios_server_${optmode}.exe
else
    echo "THERE IS A PROBLEM IN XIOS COMPILATION EXECUTABLE MISSING - STOP"
    exit
fi


## 2.3 Compile orchidee
cd $modipsl/modeles/ORCHIDEE
echo; echo "NOW COMPILE ORCHIDEE"
echo >> $outfile ; echo " NOW COMPILE ORCHIDEE"   >> $outfile 


# Check if the compilation of ORCHIDEE was previsouly interupted prematured. 
# In that case, the files fcm.bld.lock exist. If the file exist, it is here removed to avoid makeorchidee_fcm 
# to ask question and wait for interactivly answer from the user.
if [ -f build/fcm.bld.lock ] ; then
    echo >> $outfile
    echo " WARNING!! The file ORCHIDEE/build/fcm.bld.lock exist. "   >> $outfile
    echo "           This means that the compilation is either currently on going in another terminal was previous interupted before the end."   >> $outfile
    echo "           The file will now be removed. "   >> $outfile
    echo >> $outfile
    rm -f build/fcm.bld.lock
fi

echo    ./makeorchidee_fcm -j 8 -xios -parallel $parallel -$optmode -arch ${fcm_arch} -arch_path $arch_path $full_orch -driver   >> $outfile 
        ./makeorchidee_fcm -j 8 -xios -parallel $parallel -$optmode -arch ${fcm_arch} -arch_path $arch_path $full_orch -driver    >> $outfile 2>&1
# Test if compiling finished
if [[ $? != 0 ]] ; then
    echo "THERE IS A PROBLEM IN ORCHIDEE COMPILATION - STOP"
    exit
fi

# Rename executables to contain $optmode
if [ -f $modipsl/bin/orchidee_ol ] ; then mv $modipsl/bin/orchidee_ol  $modipsl/bin/orchidee_ol_${optmode} ; fi
if [ -f $modipsl/bin/orchideedriver ] ; then mv $modipsl/bin/orchideedriver  $modipsl/bin/orchideedriver_${optmode} ; fi


## 2.4 Compile LMDZ for regular latlon configuration
cd $modipsl/modeles/LMDZ

# First check if LMDZ/libo exist or if it could be decompressed
# If neither LMDZ/libo or LMDZ/libo_${optmode}.tar exists, nothing is done. It'll be created
# during the compilation.
echo; echo "NOW DECOMPRESS LMDZ/libo IF NEEDED"
if [[ -d $modipsl/modeles/LMDZ/libo ]] ; then
    echo "Found LMDZ/libo -> no decompress needs to be done"; >> $outfile
elif [[ -f $modipsl/modeles/LMDZ/libo_${optmode}.tar ]]; then
    echo "Found LMDZ/libo_${optmode}.tar -> decompress repository"; >> $outfile
    echo >> $outfile
    tar -xf $modipsl/modeles/LMDZ/libo_${optmode}.tar -C $modipsl/ >> $outfile 2>&1
fi


# Compile LMDZ regular lat-lon executable
echo; echo "NOW COMPILE LMDZ REGULAR LAT-LON MODE. Resolution = ${resol_atm}"
echo >> $outfile ; echo " NOW COMPILE LMDZ REGULAR LAT-LON MODE. Resolution = ${resol_atm}"   >> $outfile 
# Retrieve the final svn release number, needed for radiative code suffix of executable
lmdzsvn=`svnversion . | egrep -o "[0-9]+"  | awk 'NR==1'`
echo >> $outfile ; echo "lmdzsvn= $lmdzsvn "   >> $outfile

# Check if the compilation of LMDZ was previsouly interupted prematured. 
# In that case, the files dimension.h and .lock exist. If the files exist, they are here removed to avoid makelmdz_fcm 
# to ask question and wait for interactivly answer from the user.
if [ -f libf/grid/dimensions.h ] || [ -f .lock ] ; then
  echo >> $outfile
  echo " WARNING!! The file LMDZ/libf/grid/dimension.h and/or the LMDZ/.lock exist. "   >> $outfile
  echo "           This means that the compilation is either currently on going in another terminal was previous interupted before the end."   >> $outfile
  echo "           The files dimension.h and .lock will now be removed. "   >> $outfile
  echo >> $outfile
  rm -f libf/grid/dimensions.h
  rm -f .lock
fi

# Need to define the proper option for radiative code compilation. By default, we use rrtm
case $rad in
    oldrad) opt_rad="" ;;
    rrtm)   if [ $lmdzsvn -le 4185 ] ; then opt_rad="-rrtm true" ; else opt_rad="-rad rrtm" ; fi ;;
    ecrad)  opt_rad="-rad ecrad" ;;
    *) echo Only oldrad rrtm ecrad for rad option ; exit
esac

if [ $lmdzsvn -le 4185 -a $rad = "ecrad" ] ; then echo "ecrad only available for LMDZ rev starting with 4186 " ; exit ; fi


echo ./makelmdz_fcm -d ${resol_atm} -p lmd  $opt_rad $opt_cosp $opt_strataer -$optmode -parallel $parallel -io xios -v orchidee2.1 -arch $fcm_arch -arch_path $arch_path -j 8 $full_lmdz gcm    >> $outfile 
./makelmdz_fcm -d ${resol_atm} -p lmd  $opt_rad $opt_strataer -$optmode -parallel $parallel -io xios -v orchidee2.1 -arch $fcm_arch -arch_path $arch_path -j 8 $full_lmdz gcm    >> $outfile 2>&1
# Test if compiling finished
if [[ $? != 0 ]] ; then
    echo "THERE IS A PROBLEM IN LMDZ REGULAR LATLON COMPILATION - STOP"
    exit
fi

# Move executables to modipsl/bin folder
echo >> $outfile
echo "Move gcm.e executable to modipsl/bin" >> $outfile
echo ls -lrt $modipsl/modeles/LMDZ/bin   >> $outfile
ls -lrt $modipsl/modeles/LMDZ/bin  >> $outfile
echo >> $outfile

suffix=${resol_atm}_phylmd
if [ $lmdzsvn -ge 4186 ] ; then suffix=${suffix}_${rad} ; fi
if [ $parallel == seq ] || [ $parallel == none ] ; then
    suffix=_${suffix}_seq_orch.e
else
    suffix=_${suffix}_para_mem_orch.e
fi
echo gcm suffix = $suffix

if [ -f $modipsl/modeles/LMDZ/bin/gcm${suffix} ] ;  then 
    mv $modipsl/modeles/LMDZ/bin/gcm${suffix} $modipsl/bin/gcm_${resol_atm}_${optmode}.e
else
    echo "ERROR gcm${suffix} executable does not exist." 
    echo "THERE IS A PROBLEM IN LMDZ REGULAR LATLON COMPILATION - STOP"
    exit
fi  


# Compile ce0l initialization program for LMDZ regular lat-lon exectuable
if [ $ce0l == y ] ; then
    echo; echo "NOW COMPILE CE0L OF LMDZ. Resolution = ${resol_atm}"
    echo >> $outfile ; echo " NOW COMPILE CE0L OF LMDZ. Resolution = ${resol_atm}"   >> $outfile 
    
    echo ./makelmdz_fcm -d ${resol_atm} -p lmd  $opt_rad -$optmode -arch $fcm_arch -arch_path $arch_path -j 8 $full_lmdz ce0l    >> $outfile 
    ./makelmdz_fcm -d ${resol_atm} -p lmd  $opt_rad -$optmode -arch $fcm_arch -arch_path $arch_path -j 8 $full_lmdz ce0l    >> $outfile 2>&1
    # Test if compiling finished
    if [[ $? != 0 ]] ; then
        echo "THERE IS A PROBLEM IN CE0L (LMDZ) REGULAR LATLON COMPILATION - STOP"
        exit
    fi

    
    # Move executables to modipsl/bin folder
    echo >> $outfile
    echo "Move ce0l.e executable to modipsl/bin" >> $outfile
    echo ls -lrt $modipsl/modeles/LMDZ/bin   >> $outfile
    ls -lrt $modipsl/modeles/LMDZ/bin  >> $outfile
    echo >> $outfile
    suffix=_${resol_atm}_phylmd_seq.e
    if [ $lmdzsvn -ge 4186 ] ; then suffix=_${resol_atm}_phylmd_${rad}_seq.e ; fi
    echo ce0l suffix = $suffix

    if [ -f $modipsl/modeles/LMDZ/bin/ce0l${suffix} ] ;  then 
        mv $modipsl/modeles/LMDZ/bin/ce0l${suffix} $modipsl/bin/ce0l_${resol_atm}_${optmode}.e
    else
        echo "ERROR ce0l${suffix} executable does not exist." 
        echo "THERE IS A PROBLEM IN CE0L (LMDZ) REGULAR LATLON COMPILATION - STOP"
        exit
    fi  
fi

# Compress XIOS and LMDZ/libo
if [ $comp_tar == yes ] && [ -d $modipsl/modeles/XIOS ] ; then
    echo "Option comp_tar activated, now compress XIOS and LMDZ/libo"
    echo "Option comp_tar activated, now compress XIOS and LMDZ/libo" >> $outfile 
    tar -cf $modipsl/modeles/XIOS_${optmode}.tar $modipsl/modeles/XIOS
    rm -rf $modipsl/modeles/XIOS
    tar -cf $modipsl/modeles/LMDZ/libo_${optmode}.tar $modipsl/modeles/LMDZ/libo
    rm -rf $modipsl/modeles/LMDZ/libo
fi

echo >>$outfile ; echo "ALL COMPILING FINISHED" >> $outfile
echo ls -lrt modipsl/bin >> $outfile
ls -lrt $modipsl/bin >> $outfile

echo; echo "ALL COMPILING FINISHED" ; echo
echo "Executables are found in modipsl/bin"
echo "Check that executable names correspond with the name set in config.card before launching the job"
echo ls -lrt modipsl/bin
ls -lrt $modipsl/bin

date

exit