#!/bin/bash
# ========================================================================
# Parameter file example for defining and installing a CNRM-CM5 experiment
# Version 4.2 - 25 juil. 2011
# ========================================================================

# This file, when executed, launches the installation of the experiment
# It must be named param_EXPID, where EXPID is your choice of experiment 
# identifier and does not include any "_"
EXPID=`basename $0 | sed -e 's/param_//g'`

# Syntax is according to your $SHELL
# Sections are :
#           DESCRIBING THE EXPERIMENT
#           PERIOD TO PROCESS, AND JOBS GRANULARITY
#           JOBS CHARACTERISTICS
#           OUTPUT FILES : DIAGNOSTICS, RESTART, LISITINGS 
#           NAMELISTS USED. 
#           RESTART FILES. 
#           FORCINGS AND THEIR EVOLUTION 
#           FOR ADVANCED USE


cat > $FTDIR/param_${EXPID} <<'EOF'

# ===================================================================
#           DESCRIBING THE EXPERIMENT
# ===================================================================
# The next string will be used to document diagnostic fields
TITRE="A CNRM-CM5 run for test"
# The experiment can belong to a group, which will drive directories 
# organization on front-end and archive machine (see section "ADVANCED 
# USE"). The whole paths will be automatically created
GROUP=TESTING

# E-mail to send error messages 
RUNMAIL=aurore.voldoire@meteo.fr

# ===================================================================
#           PERIOD TO PROCESS, AND JOBS GRANULARITY
# ===================================================================
# The period will be processed in multiple jobs. Each job will process 
# a number of months. The first month of the first job may begin at any 
# date in the month, provided there is a valid ocean initial state for 
# that date (either climatology or a restart).Later months will be 
# complete ones.

# Initial date of the run. Entirely your choice, but it makes more sense
# if it is consistent with the forcings.
INIDATE=18740101
# Last date of the run - 
# here we will have a two days long run
ENDDATE=18740102
# Start time of the run. You can choose mid-day if you wish
INITIME=0
# How many months should we process in each job (anyway, ENDDATE will apply)
NMONTH=12
#
# ===================================================================
#                        JOBS CHARACTERISTICS
# ===================================================================
# Next characteristics apply to each of the jobs in the loop. They may 
# be changed during the experiment in file $RELDIR/$EXPID/$EXPID_his (see 
# below for RELDIR)

# Number of processors dedicated to Arpege and to the Ocean model
# Make sure that you have the Nemo binary which fits the number of procs
# You also have to balance the procs between Arpege and Nemo for avoiding 
# wasting CPU time
NPROC_ARP=5 ; NPROC_OCE=2
# How many nodes and processors per node are used ?
NN=1 ;   NNP=8

# Elapsed time and memory usage on the sx computer. 
# Highly dependant on number of processors requested 
ELAPS=06:00:00 ; MEM=60gb
# Batch queue on the sx computer (can be test, giec, ...) 
QUEUE=vector

# Elapsed time and memory usage on the front-end computer 
ELAPSFRONT=01:00:00 ; MEMFRONT=8gb

# ===================================================================
#         OUTPUT FILES: DIAGNOSTICS, RESTART, LISITINGS 
# ===================================================================
# Listings are saved in the RELDIR directory
# Next line quotes the models which listing will be saved, by a key-letter 
# or keyword : all, A (Atm), O (ocean), R (River), G (Ice), C (Coupler), no
SAVE_LISTING=no

# Model outputs and restart files are saved on the archive machine according
# (by default) to the standard CNRM-CM file organization . See section
# "advanced use" and variables $(modele)[RES|OUT]ARCH for changing it.

# To save restarts every 6h (for nudging or Aladin) put 'all'
# Otherwise put the period (in month) for saving restart files:
#  if 1  ---> save restarts every month 
#  if 12 ---> save restarts every year
# Anyway, if the processed dates interval is less than this period,
# you will get a restart corresponding to the day after the last
# processed day.
SAVE_RESTART_PER=12

# ===================================================================
#                NAMELISTS USED. 
# ===================================================================
# Namelist files can be on any rcp-reachable remote machine or on cougar 
# If you want to share such a parameter file and the files it uses, 
# remember to use either absolute paths or the form "~account/..."

MACH_NAMELIST=tori
ATMNAMREF=~mrgu548/public/namelists_ar5/namarp_ar5
SFXNAMREF=~mrgu548/public/namelists_ar5/namsfx_ar5
OCENAMREF=~mrgu548/public/namelists_ar5/namoce_ar5
ICENAMREF=~mrgu548/public/namelists_ar5/namgel_ar5
CPLNAMREF=~mrgu548/public/namelists_ar5/namcpl_ar5
RIVNAMREF=~mrgu548/public/namelists_ar5/namtrp_ar5
IOXNAMREF=~mrgu548/public/namelists_ar5/namiox_ar5
IOSNAMREF=~mrgu548/public/namelists_ar5/namios_ar5

# ===================================================================
#               RESTART FILES. 
# ===================================================================
# Input restart files can be on any rcp-reachable remote machine or 
# on cougar. Just declare which it is
MACH_RESTART=cougar

# All restarts 
EXPREF=PICTL ; DATREF=18500101
restarts=/home/m/mgie/mgie003/AR5/$EXPREF
ATMREST=$restarts/atm/restart/$EXPREF.rst.atm.P$DATREF
SFXREST=$restarts/sfx/restart/$EXPREF.rst.sfx.P$DATREF
ICEREST=$restarts/oce/restart/$EXPREF.rst.ice.P$DATREF
RIVREST=$restarts/riv/restart/$EXPREF.rst.trp.P$DATREF
CPLATMRES=$restarts/cpl/restart/$EXPREF.cpl.atm.P$DATREF.nc
CPLOCERES=$restarts/cpl/restart/$EXPREF.cpl.oce.P$DATREF.nc
CPLRIVRES=$restarts/cpl/restart/$EXPREF.cpl.trp.P$DATREF.nc


#If intended Ocean initial state is the climatology, LOCEREST should be set to 0
LOCEREST=1
# Otherwise, do not forget to specify an oceanrestart file
OCEREST=$restarts/oce/restart/$EXPREF.rst.oce.P$DATREF.nc

# ===================================================================
#            FORCINGS AND THEIR EVOLUTION 
# ===================================================================
#      
#   For each forcing 2 variables : 
#     YEAR_XXX : defining how the forcing evolves depending on the year of the simulation
#     FORXXX   : pattern for filename used for the forcing, which can includes keywords YYYY 
#         and MM, where YYYY will be replaced by current year and MM will be replaced by current 
#         month at execution time, using the scheme described below
#
#     If the forcing is fixed, then FORXXX is the file name of the forcing to use
#     If the forcing evolves with a constant annual cycle, then MM has to be present un FORXXX
#     If the forcing evolves yearly : FORXXX must contain the string YYYY 
#                                    YEAR_XXX=SCEN_1950_2000 says that the forcing will evolve from 1950 to 2000
#                                    on a yearly basis. Before 1950, the 1950 forcing will be applied every year 
#                                     and similarly after 2000, the 2000forcing is applied each year.
#     If the forcing evolves on a decadal period : FORXXX must contain the string YYYY
#                                    YEAR_XXX=SCED_1950_2000 (similarly to the yearly case)
#  
# Here below (in the original file version) we set forcings to Pre-Industrial values
    
# Geometry for arpege - Used for computing forcing filenames
GEOM=tl127l31r

# Boundary conditions : orography, land use ...
# By exception, for boundary conditions, XXX=BCD but pattern is named BCOND
YEAR_BCD=no ;   BCOND=~mrga561/bcond/nclim4_${GEOM}_mMM

# GHG gases, and solar forcing
YEAR_GHG=1850 ; FORGHG=~mrgu548/forcages/ghg_et_solaire_cmip5/GHG_HIST.dat

# Volcanic aerosols - use of a fixed forcing from FORVOL file
YEAR_VOL=no   ; FORVOL=~mrgu556/clim/aero_volcans_${GEOM}/aero_Ammann_vo.globavg.ieee

# Base directory for aerosols, which are yet provided from 1855 to 1995
aerosols=~mrgu548/clim/aerosols_szopa_and_IPSL_${GEOM}
# Sulfate aerosols
YEAR_SUL=1855 ;   FORSUL=$aerosols/aero_szopa_and_IPSL_SO4.YYYYMM.ieee
# Black Carbon
YEAR_BCA=1855 ;   FORBCA=$aerosols/aero_szopa_and_IPSL_BC.YYYYMM.ieee
# Organic Carbon
YEAR_ORA=1855 ;   FORORA=$aerosols/aero_szopa_and_IPSL_POM.YYYYMM.ieee
# Sand Dust
YEAR_SDA=1855 ;   FORSDA=$aerosols/aero_szopa_and_IPSL_CIDUST.YYYYMM.ieee
# Sea Salt
YEAR_SSA=1855 ;   FORSSA=~mrgu548/clim/aerosols_SS_scales_tegen_${GEOM}/aero_baltegen_SS.YYYYMM.ieee

# Ozone forcing
YEAR_OZO=no   ;   FOROZO=~mrgs536/clim/ozone_sl_${GEOM}/PROBnecCOEF_60_v3.2_coeff7.MM.ieee

# ===================================================================
#                    FOR ADVANCED USE
# ===================================================================
# Where to find shell script tools
TOOL=~mrgu548/public/toolbox/v3.3
# Script implementing the coupled model
script=~mrgu548/public/couple/script_couple.4.4

# Models binaries, their data and related tools
ATMEXE=~mrga589/public/arp502/bin/ald502_export.01.exe 
UPDCLI=~mrgu556/arpege/library/updcli_gen_2     ;           UPDOZO=~mrgs536/arpege/library/updozo5.1.v5
# NEMO binary has to be recompiled if the user change the number of proc to be used (NPROC_OCE)
OCEEXE=~mrgu548/opa/opa9/NEMO3.3/bin/nemo3.3_o1.5.30.v10.6.2P.CPL ; DATA_OCE=~mrgu548/opa/opa9/NEMO3.3/data2
IOSEXE=~mrgu556/opa/opa9/NEMO3.3/bin/ioserverCPL
RIVEXE=~mrgu556/trip/library/routeDBL.ipcc      ;           DATA_RIV=~mrgu556/trip/data
CPLEXE=~mrgu556/oasis/v3.3.02/prism/SX8/bin/oasis3.MPI1.x ; DATA_CPL=~mrgu556/oasis/data/v3_1d_sfx_sophie.2m


# Temporary location to store output data. Better not to modifiy it. 
STORE_LOC=$FTDIR

# Archive directories on archiv used to save model outputs and
# restarts. Next lines follow the CNRM-CM5 standard file organization
# for CMIP5 outputs, but most tools will still work if you change it 
EXPARCHDIR=${GROUP%/}/$EXPID  
ATMARCH=$EXPARCHDIR/atm; ATMRESARCH=$ATMARCH/restart ; ATMOUTARCH=$ATMARCH/output
SFXARCH=$EXPARCHDIR/sfx; SFXRESARCH=$SFXARCH/restart ; SFXOUTARCH=$SFXARCH/output
OCEARCH=$EXPARCHDIR/oce; OCERESARCH=$OCEARCH/restart ; OCEOUTARCH=$OCEARCH/output
ICEARCH=$EXPARCHDIR/oce; ICERESARCH=$ICEARCH/restart ; ICEOUTARCH=$ICEARCH/output
RIVARCH=$EXPARCHDIR/riv; RIVRESARCH=$RIVARCH/restart ; RIVOUTARCH=$RIVARCH/output
CPLARCH=$EXPARCHDIR/cpl; CPLRESARCH=$CPLARCH/restart ; CPLOUTARCH=$CPLARCH/output

# Directory for automatic relance (and hence job outputs, listings, logs..)
# Default value is fine for most uses
RELDIR=$HOME/relances/$EXPARCHDIR

EOF

# Let us launch the installation script using the above parameters
INSTALLER=~mrgu548/public/couple/instexp_couple.4.3
cd $FTDIR
$INSTALLER $EXPID 
rm -f param_$EXPID