#*********************************************************
# C-shell control script for AMWG Diagnositics Package. 
# Written by Mark Stevens (stevens@ucar.edu) 2001-2002.
# Please see the AMWG diagnostics package webpage at 
# http://ww.cgd.ucar.edu/cms/diagnostics/
#
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#                   PLEASE READ THIS 
#                OR ELSE YOU MIGHT SCREW UP
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# This script can be placed in any directory provided that
# access to the working directory and local directories are 
# available (see below).
#
# Using this script your model output can be compared with
# CCM3.6 and CAM2.0 controls, observed and reanalysis data,
# or with another model run. With all the diagnostic sets 
# turned on the package will produce over 600 plots and 
# tables in your working directory. In addition, files are
# produced for the climatological monthly means and the DJF
# and JJA seasonal means, as well as the annual (ANN) means.
# 
# Input file names are of the standard CCSM type and
# they must be in netcdf format. Filenames are of the 
# form YYYY-MM.nc where YYYY are the model years and MM
# are the months, for example 00010-09.nc. The files
# can reside on the Mass Storage System (MSS), if they 
# are on the MSS the script will get them using msrcp.
# If your files are not on the MSS they must be in a local
# directory that Dataproc, the CGD Suns, Babyblue, etc can
# access.
#
# Normally 5 years of monthly means are used for the
# comparisons, however only 1 year of data will work. 
# The December just prior to the starting year is also
# needed for the DJF seasonal mean, or Jan and Feb of
# the year following the last full year. For example,  
# for 5-year means the following months are needed 
#
# 0000-12.nc      prior december
# 0001-01.nc      first year (must be 0001 or greater)
#  ...
# 0001-12.nc
#  ...
# 0005-01.nc      last year
#  ...
# 0005-12.nc
#
#--> OR you can do this 
#
# 0001-01.nc      first year (must be 0001 or greater)
#  ...
# 0001-12.nc
#  ...
# 0005-01.nc      last year full year
#  ...
# 0005-12.nc
# 0006-01.nc      following jan
# 0006-02.nc      following feb
#
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#                       USER MODIFY SECTION
#              Modify the folowing sections as needed.
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# NOTE: in the following "test case" refers to the model run to be
# compared with the "control case", which may be model or obs data.
#-----------------------------------------------------------------
#
# Set your working directory pathname. This is where all the 
# output postscript and ascii files will be written.
# Don't forget the trailing /.

setenv WKDIR /ptmp/stevens/

#*****************************************************************
# Get your TEST case MONTHLY files from the MSS?
# If yes, then set the MSS path and a local path to receive the
# test case monthly files. If no, then just set the local path 
# which has the monthly or climatological test case files. 
# Don't forget the trailing /.

set MSS_test = 1    # (0=get files from MSS, 1=files exist locally)

# if needed set MSS path    
set MSS_testpath = /CCSM/csm/b20.007/atm/hist/

set test_path = /ptmp/stevens/ccsm/b20.007/

#-----------------------------------------------------------------
# New file naming convention. Set the filename convention for your
# test files, if they use it.

 set conv_test = ""                     # use for older files
#set conv_test = "b20.007.cam2.h0."     # don't forget the trailing "."

#------------------------------------------------------------------         
# If getting monthly data from MSS, or computing climatological
# means from the local test case data, specify the first model 
# year of your data, and the number of years of data to be used.

set test_begin = 570        # first year (must be >= 1)
set test_nyrs  = 1          # number of yrs (must be >= 1)

#------------------------------------------------------------------         
# Set the identifying prefix for your test case run. This 
# will be used for the output netcdf filenames in $test_path.

set test_prefix = b20.007    # test case prefix

#*******************************************************************
# Select the type of control case to be compared with your model
# test case (select one). 

 set CNTL = OBS            # observed data (reanalysis etc)
#set CNTL = CAM20AMIP      # CAM 2.0 AMIP2 SST run (1979-1995)
#set CNTL = CAM20          # CAM 2.0 20-year climo SST control run 
#set CNTL = CCM36AMIP      # CCM 3.6 AMIP2 SST run (1979-1992)
#set CNTL = CCM36          # CCM 3.6 9-year climo SST control run 
#set CNTL = USER           # user defined model control (see below)
 
#******************************************************************
# NOTE: FOR CNTL == USER ONLY (otherwise skip this section)

# Get your CONTROL (cntl) MONTHLY files from the MSS?
# If yes, then set the MSS path and a local path to receive the
# control case monthly files. If no, then just set the local path 
# which has the monthly or climatological control case files. 
# Don't forget the trailing /.

set MSS_cntl = 1    # (0=get files from MSS, 1=files exist locally)

# if needed set MSS path   
set MSS_cntlpath = /CCSM/csm/b20.001/atm/hist/

set cntl_path = /ptmp/stevens/ccsm/b20.001/

#-----------------------------------------------------------------
# New file naming convention. Set the filename convention for your
# cntl files, if they use it.

 set conv_cntl = ""                   # use for older files
#set conv_cntl = "b20.001.cam1.h0."   # don't forget the trailing "."

#------------------------------------------------------------------         
# If getting monthly data from MSS, or computing climatological
# means from the local control case data, specify the first model 
# year of your data, and the number of years of data to be used.

set cntl_begin = 360           # first year (must be >= 1)
set cntl_nyrs  = 1             # number of yrs (must be >= 1)

#------------------------------------------------------------------         
# Set the identifying prefix for your control case run. This 
# will be used for the output netcdf filenames in $cntl_path.

set cntl_prefix = b20.001      # control case prefix

#******************************************************************         
# Select the output file type and style for plots.

 set p_type = ps         # postscript plots 
#set p_type = eps        # encapsulated postscript
#set p_type = epsi       # encapsulated postscript with bitmap 
#set p_type = ncgm       # ncar computer graphics metadata

#----------------------------------------------------------------
# Select the output color type for plots.

 set c_type = COLOR      # color
#set c_type = MONO       # black and white

# If needed select one of the following color schemes,
# you can see the colors by clicking on the links from
# http://www.cgd.ucar.edu/cms/diagnostics

 set color_bar = default           # the usual colors
#set color_bar = blue_red          # blue,red 
#set color_bar = blue_yellow_red   # blue,yellow,red (nice!) 

#----------------------------------------------------------------
# Turn ON/OFF date/time stamp at bottom of plots.
# Useful for plots in publications. Turn off for
# AIX systems (except Babyblue).

set time_stamp = 1       # (0=ON,1=OFF)

#---------------------------------------------------------------
# Turn ON/OFF tick marks and labels for sets 5,6, and 7
# Turning these OFF make the areas plotted larger, which makes
# the gif or jpg images easier to look at. 

set tick_marks = 1       # (0=ON,1=OFF)
 
#----------------------------------------------------------------
# Use custom case names for the plots instead of the 
# case names encoded in the netcdf files (default). 
# Also useful for publications.

set custom_names = 1     # (0=ON,1=OFF)

# if needed set the names
set test_name = b20.001b               # test case name 
set cntl_name = b20.001a               # control case name

#----------------------------------------------------------------
# Save the output netcdf files of the derived variables
# used to make the plots. These are normally deleted 
# after the plots are made. If you want to save the 
# netcdf files for your own uses then switch to ON. 

set save_ncdfs = 1       # (0=ON,1=OFF)

#****************************************************************
# Convert output postscript files to GIF or JPG image files 
# and place them in subdirectories along with html files.
# Then make a tar file of the web pages and GIF or JPG files.
# On Dataproc and CGD Suns GIF images are smallest since I built
# ImageMagick from source and compiled in the LZW compression.
# On Linux systems JPG will be smallest if you have an rpm or
# binary distribution of ImageMagick (and hence convert) since
# NO LZW compression is the default. Only works if you have
# convert on your system and for postscript files (p_type = ps).

set web_pages = 1    # (0=ON,1=OFF)  make gif or jpg and html files
set delete_ps = 1    # (0=ON,1=OFF)  delete postscript files 
set img_type  = 1    # (0=GIF,1=JPG) select image type

#----------------------------------------------------------------
# Enable copying of the tar file of web pages to a remote 
# system and then untar the file where needed. For example,
# I can run the diagnostics on Dataproc and then copy the 
# tar file to my system and install the web pages there.
# WARNING: the tarfile can be as large as 25 MB so make sure
# the remote system has enough disk space. Then send an e-mail
# message when everything is done. Only use this if you know
#  what you are doing!

set remote = 1           # (0=ON,1=OFF) 

# if needed set these
set remote_system = 'stevens@navajo.cgd.ucar.edu'
set remote_dir = /data/southern/d2/stevens/cam
set email_address = 'stevens@ucar.edu'

#******************************************************************
# Compute whether the means of the test case and control case 
# are significantly different from eachother at each grid point.
# Tests are performed only for model-to-model comparisons.  
# REQUIRES at least 10 years of model data for each case.
# Number of years from above (test_nyrs and cntl_nyrs) is used.
# Also set the significance level for the t-test.
 
set significance = 1         # (0=ON,1=OFF)

# if needed set default level
set sig_lvl = 0.05           # level of significance
 
#******************************************************************         
# Select TEST case climatological means to be COMPUTED. Note 
# these have to be done only once and before the sets below.
# Be sure to turn these off if you don't need to compute the means.

set test_ANN_climo = 1       # (0=ON,1=OFF)  annual mean climo 
set test_DJF_climo = 1       # (0=ON,1=OFF)  seasonal mean climo
set test_JJA_climo = 1       # (0=ON,1=OFF)  seasonal mean climo
set test_MON_climo = 1       # (0=ON,1=OFF)  monthly means climo

#-----------------------------------------------------------------
# NOTE: For CNTL == USER (otherwise skip) 
# Select CONTROL case climatological means to be COMPUTED. 
# Be sure to turn these off if you don't need to compute the means.

set cntl_ANN_climo = 1       # (0=ON,1=OFF)  annual mean climo 
set cntl_DJF_climo = 1       # (0=ON,1=OFF)  seasonal mean climo
set cntl_JJA_climo = 1       # (0=ON,1=OFF)  seasonal mean climo
set cntl_MON_climo = 1       # (0=ON,1=OFF)  monthly means climo

#******************************************************************         
# Select the climatological means to be PLOTTED or in tables.
# You must have the appropriate set(s) turned on to make plots.

set plot_ANN_climo = 1       # (0=ON,1=OFF) used by sets 1-7,11 
set plot_DJF_climo = 1       # (0=ON,1=OFF) used by sets 1,3-7,9,11
set plot_JJA_climo = 1       # (0=ON,1=OFF) used by sets 1,3-7,9,11
set plot_MON_climo = 1       # (0=ON,1=OFF) used by sets 8,10,12

#******************************************************************         
# Select the diagnostic sets to be done. You can do one at a
# time or as many as you want at one time, or all at once.

set all_sets = 1  # (0=ON,1=OFF)  Do all the sets (1-12) 

set set_1  = 1    # (0=ON,1=OFF)  tables of global,regional means
set set_2  = 1    # (0=ON,1=OFF)  implied transport plots 
set set_3  = 1    # (0=ON,1=OFF)  zonal mean line plots
set set_4  = 1    # (0=ON,1=OFF)  vertical zonal mean contour plots
set set_5  = 1    # (0=ON,1=OFF)  2D-field contour plots
set set_6  = 1    # (0=ON,1=OFF)  2D-field vector plots
set set_7  = 1    # (0=ON,1=OFF)  2D-field polar plots
set set_8  = 1    # (0=ON,1=OFF)  annual cycle (vs lat) contour plots
set set_9  = 1    # (0=ON,1=OFF)  DJF-JJA difference plots
set set_10 = 1    # (0=ON,1=OFF)  annual cycle line plots    
set set_11 = 1    # (0=ON,1=OFF)  scatter plots

#------------------------------------------------------------------         
# Select vertical profiles to be computed. Select from list below,
# or do all stations, or none. You must have computed the monthly
# climatological means for this to work. Preset to the 17 selected
# stations.

set set_12 = 1    # (0=selected stations, 1=NONE, 2=ALL stations)

# Specify selected stations for computing vertical profiles.
if ($set_12 == 0 || $all_sets == 0) then
# ARCTIC (60N-90N)
  set western_alaska      = 1  # (0=ON,1=OFF) 
  set whitehorse_canada   = 1  # (0=ON,1=OFF)
  set resolute_canada     = 0  # (0=ON,1=OFF)
  set thule_greenland     = 0  # (0=ON,1=OFF)
# NORTHERN MIDLATITUDES (23N-60N)
  set new_dehli_india     = 1  # (0=ON,1=OFF)
  set kagoshima_japan     = 1  # (0=ON,1=OFF)
  set tokyo_japan         = 1  # (0=ON,1=OFF)
  set midway_island       = 0  # (0=ON,1=OFF)
  set shipP_gulf_alaska   = 0  # (0=ON,1=OFF)
  set san_francisco_ca    = 0  # (0=ON,1=OFF)
  set denver_colorado     = 1  # (0=ON,1=OFF)
  set great_plains_usa    = 0  # (0=ON,1=OFF)
  set oklahoma_city_ok    = 1  # (0=ON,1=OFF)
  set miami_florida       = 0  # (0=ON,1=OFF)
  set new_york_usa        = 1  # (0=ON,1=OFF)
  set w_north_atlantic    = 1  # (0=ON,1=OFF)
  set shipC_n_atlantic    = 1  # (0=ON,1=OFF)
  set azores              = 1  # (0=ON,1=OFF)
  set gibraltor           = 1  # (0=ON,1=OFF)
  set london_england      = 1  # (0=ON,1=OFF)
  set western_europe      = 0  # (0=ON,1=OFF)
  set crete               = 1  # (0=ON,1=OFF)
# TROPICS (23N-23S)
  set central_india       = 1  # (0=ON,1=OFF)
  set madras_india        = 1  # (0=ON,1=OFF)
  set diego_garcia        = 0  # (0=ON,1=OFF)
  set cocos_islands       = 1  # (0=ON,1=OFF)
  set christmas_island    = 1  # (0=ON,1=OFF)
  set singapore           = 1  # (0=ON,1=OFF)
  set danang_vietnam      = 1  # (0=ON,1=OFF)
  set manila              = 1  # (0=ON,1=OFF)
  set darwin_australia    = 1  # (0=ON,1=OFF)
  set yap_island          = 0  # (0=ON,1=OFF)
  set port_moresby        = 1  # (0=ON,1=OFF)
  set truk_island         = 0  # (0=ON,1=OFF)
  set raoui_island        = 1  # (0=ON,1=OFF)
  set gilbert_islands     = 1  # (0=ON,1=OFF)
  set marshall_islands    = 0  # (0=ON,1=OFF)
  set samoa               = 1  # (0=ON,1=OFF)
  set hawaii              = 0  # (0=ON,1=OFF)
  set panama              = 0  # (0=ON,1=OFF)
  set mexico_city         = 1  # (0=ON,1=OFF)
  set lima_peru           = 1  # (0=ON,1=OFF)
  set san_juan_pr         = 1  # (0=ON,1=OFF)
  set recife_brazil       = 1  # (0=ON,1=OFF)
  set ascension_island    = 0  # (0=ON,1=OFF)
  set ethiopia            = 1  # (0=ON,1=OFF)
  set nairobi_kenya       = 1  # (0=ON,1=OFF)
# SOUTHERN MIDLATITUDES (23S-60S)
  set heard_island        = 1  # (0=ON,1=OFF)
  set w_desert_australia  = 1  # (0=ON,1=OFF)
  set sydney_australia    = 1  # (0=ON,1=OFF)
  set christchurch_nz     = 1  # (0=ON,1=OFF)
  set easter_island       = 0  # (0=ON,1=OFF)
  set san_paulo_brazil    = 1  # (0=ON,1=OFF)
  set falkland_islands    = 1  # (0=ON,1=OFF)
# ANTARCTIC (60S-90S)
  set mcmurdo_antarctica  = 0  # (0=ON,1=OFF)
endif
#***************************************************************
# PALEOCLIMATE coastlines
# Allows users to plot paleoclimate coastlines for sets 5,6,7,9.
# Two special files are created which contain the needed data 
# from each different model orography. The names for these files
# are derived from the variables $test_prefix and $cntl_prefix 
# defined above by the user.  
# If the user wants to compare results from two different times
# when the coastlines are different then the difference plots 
# can be turned off. No difference plots are made when the
# paleoclimate model is compared to OBS DATA.
 
set paleo = 1             # (0=use or create coastlines,1=OFF)

# if needed set these
set land_mask1 = 1      # define value for land in test case ORO
set land_mask2 = 1      # define value for land in cntl case ORO
set diff_plots = 1      # make difference plots for different
                        # continental outlines  (0=ON,1=OFF)

#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#                  END OF USER MODIFY SECTION
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!