source: CDB_diags/branches/FBL/CO2_zonal.sh @ 7

##################### HELP ####################################
#
#
#THE CDB DEFINES THE FOLLOWING VARIABLES IN THE FILE cdb_header:
#
# PROGRAMS:
#
# CDB_CDO_PATH
# CDB_NCO_PATH
# CDB_PYTHON_PATH
#
# DIRECTORIES:
#
# CDB_TEMP_DIR
# CDB_OUT_DIR
# CDB_DIAG_DIR
# CDB_SCRIPT_DIR
# CDB_IN_DIR
# CDB_SOURCE_DIR
#
#
#THE DRIVER PASSES THE FOLLOWING INPUTS TO THIS SCRIPT:
#
# CDB_MODEL = MODEL NAME, E.G. CanESM2
# CDB_RUN_ID = RUN_ID, E.G. r1i1p1
# CDB_EXPT = EXPERIMENT NAME, E.G. rcp45
# CDB_YEARS = COMMA-SEPARATED YEAR BOUNDS, E.G. 2050,2099
#
# CDB_DIAG_NAME
#
#THIS SCRIPT RECOVERS REQUESTED VARIABLES AS AN ARRAY OF PATHNAMES
#
# IT ALSO FORMATS A NATURAL OUTPUT FILENAME:
# CDB_OUT_FILE with all run characteristics
#
################## END HELP ####################################

################ MODELS USED IN THIS SCRIPT  ##############
#
CDB_MODEL_LIST="\
"
#
############# END MODELS USED IN THIS SCRIPT  #############

################ EXPERIMENTS AND YEARS TO USE THIS SCRIPT ON  ##############
#
CDB_EXPT_LIST="\
historical:1965,2004;\
rcp45:2060,2099;\
"
#
#Can use the same experiment but for two time periods, ie:
#
#CDB_EXPT_LIST="\
#historical:1965,1984;\
#historical:1985,2004;\
#rcp45:2060,2099;\
#"
#
################ END EXPERIMENTS AND YEARS TO USE THIS SCRIPT ON  ##############

################ VARIABLES NEEDED IN THIS SCRIPT  ##############
#
# A space-separated list of variables names, frequencies, realm and MIP code must be
# stored in the variable CDB_VAR_LIST. For example, to recover
# daily surface temperature AND 3-hourly surface specific humidity:
# CDB_VAR_LIST="tas,day,atmos,day huss,3hr,atmos,3hr"
# To recover daily cloud area fraction AND monthly sea surface salinity:
# CDB_VAR_LIST="cl,day,atmos,cfDay sos,mon,atmos,Omon"
#CDB_VAR_LIST="tas,mon,atmos,Amon"
CDB_VAR_LIST="\
co2,mon,atmos,Amon;\
ta,mon,atmos,Amon;\
hus,mon,atmos,Amon;\
va,mon,atmos,Amon;\
ps,mon,atmos,Amon;\
"
#va,mon,atmos,Amon;\
#
# For each element 'var_name,freq' in CDB_VAR_LIST, the driver will
# create a bash variable 'CDB_VAR_var_name_freq' containing the
# path to the data.
#
############# END VARIABLES NEEDED IN THIS SCRIPT  #############

################ DO NOT ERASE BELOW  ##############
#
# SETUP THE QUERY
while getopts :hvme opt; do
  case $opt in
    h)
      echo "Help"
      echo "h: help"
      echo "v: prints the variables needed "
      echo "m: prints the models needed"
      echo "e: prints the experiments needed"
      exit
    ;;
    v)
        echo ${CDB_VAR_LIST}
        exit
    ;;
    m)
        echo ${CDB_MODEL_LIST}
        exit
    ;;
    e)
        echo ${CDB_EXPT_LIST}
        exit
    ;;
    \?)
      echo "Unknown option -$OPTARG use -h for help"
    ;;
  esac
done
#
#
#!START YEAR LOOP
######DO NOT ERASE PREVIOUS LINE
######It tells the driver to start a loop over the variable YEAR from
######YEAR_START to YEAR_END, included. It also produces the appropriate
######bash variables pointing towards the data file for each requested
######variables

############# END DO NOT ERASE  #############

###################  INSERT YEARLY SCRIPT BELOW #################


#ZONAL CO2 SCRIPT

#Perform the computation one month at a time for an efficient memory usage:
for MONTH in 01 02 03 04 05 06 07 08 09 10 11 12
do
    #Define a temp file from the CDB-provided CDB_OUT_FILE variable:
    CDB_TEMP_FILE=${CDB_OUT_FILE}_${CDB_YEAR}_${MONTH}

    #Define the remapping to gaussian grid. One can easily change the grid to another one by replacing
    #the 'n48' by another CDO-accepted grid description.
    REMAP="-remapcon,n48"
    #
    #Define the required pressure levels. These must be a subset of the standard level outputs.
    PRES_LEVS="100000,92500,85000,70000,60000,50000,40000,30000,25000"

    echo "Retrieving data from the archive"
    #Retrieve the monthly surface pressure from the CDB-provided CDB_VAR_ps_mon:
    cdo -selmon,$MONTH -selyear,${CDB_YEAR} -selname,co2 ${CDB_VAR_co2_mon} \
             ${CDB_TEMP_DIR}/${CDB_TEMP_FILE}.co2.tmp

    echo "Subsetting pressure levels and taking zonal mean:"
    #Select the levels and invert the levels so that increasing level index correspond to increasing pressure.
    #Note that this could have been put in the previous CDO call. However, a possible bug in CDO creates a
    #different vertical axis for each variable, even thought the levels are the same. Doing in two steps solves this issue:
    cdo -s -Q -setname,co2_zon -zonmean -invertlev -sellevel,${PRES_LEVS} ${CDB_TEMP_DIR}/${CDB_TEMP_FILE}.co2.tmp\
                                                                          ${CDB_TEMP_DIR}/${CDB_TEMP_FILE}.co2_zon
    rm ${CDB_TEMP_DIR}/${CDB_TEMP_FILE}.co2.tmp

done #MONTH

#Merge the monthly outputs. If one month was missing, output a data quality flag:
MONTHLY_CAT_LIST="co2_zon"
#Only the previous line should need to be changed if more than one file needs to be output.
#Be careful if modifying the next few lines
for VAR_ID in ${MONTHLY_CAT_LIST}; do
    NUMBER_OF_FILES=$(ls ${CDB_TEMP_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}_??.${VAR_ID} | wc -l) 
    if [ "$NUMBER_OF_FILES" -eq "12" ]; then
        cdo -Q -s mergetime ${CDB_TEMP_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}_??.${VAR_ID} ${CDB_TEMP_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}.${VAR_ID}
        mv ${CDB_TEMP_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}.${VAR_ID} ${CDB_OUT_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}.${VAR_ID}
        rm ${CDB_TEMP_DIR}/${CDB_OUT_FILE}_${CDB_YEAR}_??.${VAR_ID}
    else
        echo "QUALITY_ASSURANCE_FLAG: Some months are missing for ${VAR_ID} in year ${CDB_YEAR}."
    fi
done
###############  END INSERT YEARLY SCRIPT #################

#!END YEAR LOOP
######DO NOT ERASE PREVIOUS LINE
######It tells the driver to end the year loop

###############  INSERT POSTPROCESSING SCRIPT BELOW ############
#Note that bash variables defined in the yearly script will not carry over
#

#Merge the yearly files back together and we perform a MULTI-YEAR SEASONAL MEAN
YEARLY_CAT_LIST="co2_zon"
#Even if this list was defined previously, it still has to be defined here.
#Only the previous line of code should need to be changed if more than one file needs to be output.
#Be careful if modifying the next few lines.
for VAR_ID in ${YEARLY_CAT_LIST}; do
    NUMBER_OF_FILES=$(ls ${CDB_OUT_DIR}/${CDB_OUT_FILE}_????.${VAR_ID} | wc -l) 
    if [ "$NUMBER_OF_FILES" -eq "$((${CDB_YEAR_END}-${CDB_YEAR_START}+1))" ]; then
        cdo -s mergetime ${CDB_OUT_DIR}/${CDB_OUT_FILE}_????.${VAR_ID} ${CDB_OUT_DIR}/${CDB_OUT_FILE}.${VAR_ID}
        rm ${CDB_OUT_DIR}/${CDB_OUT_FILE}_????.${VAR_ID}
        
        #Multi-year seasonal mean:
        cdo yseasmean ${CDB_OUT_DIR}/${CDB_OUT_FILE}.${VAR_ID} ${CDB_OUT_DIR}/${CDB_OUT_FILE}.${VAR_ID}.yseas
        rm ${CDB_OUT_DIR}/${CDB_OUT_FILE}.${VAR_ID}
    else
        echo "QUALITY_ASSURANCE_FLAG: Some years are missing for ${VAR_ID}"
    fi
done

#This script outputs the following file for each model:
#${CDB_OUT_DIR}/${CDB_OUT_FILE}.full.pt.yseas