New check_for_file() NCL routine

NCL 6.2.1 changed the output from the isfilepresent() routine - instead of
returning true if the file exists, the file must also be of a format that is
readable by addfile(). 6.2.1 also introduced the function fileexists() with the
same behavior as the old isfilepresent(), so I created version_consistency.ncl
which only contains check_for_file() -- if fileexists() exists, it is used to
check for the file, otherwise isfilepresent() is used.

It's a little clunky, but it's better than requiring NCL 6.2.1 or later to
generate plots.

Author: mnlevy1981

reg_tests/Bryan-Lewis/plot_diff_coeffs.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 begin
 
@@ -18,14 +19,14 @@ begin
   count = 0
   do while ((.not.filefound).and.(count.lt.2))
 
-    if (isfilepresent(file_names(count)+".nc")) then
+    if (check_for_file(file_names(count)+".nc")) then
       print((/"Reading netCDF data from "+file_names(count)/))
       f = addfile(file_names(count)+".nc", "r")
       filefound = True
       x = transpose(f->Tdiff)
       y = f->zw
     else
-      if (fileexists(file_names(count)+".out")) then
+      if (check_for_file(file_names(count)+".out")) then
         print((/"Reading ascii data from "+file_names(count)/))
         nml  = asciiread("input.nl", -1, "integer")
         nlev = nml(0)

reg_tests/common/version_consistency.ncl

@@ -0,0 +1,18 @@
+; The isfilepresent() routine is different in version 6.2.1 than it was in
+; previous versions - it now only returns true if the file exists AND the file
+; is of a valid type for addfile() [netCDF, HDF5, etc]. The new routine
+; fileexists() replaces the old functionality... but fileexists() doesn't exist
+; in older versions of NCL. So this library contains a wrapper to use
+; fileexists() if it is part of NCL and isfilepresent() if it is not.
+
+undef("check_for_file")
+function check_for_file(filename)
+begin
+  if (isfunc("fileexists")) then
+    return(fileexists(filename))
+  end if
+  return(isfilepresent(filename))
+
+end
+
+

reg_tests/double_diff/plot_diff_coeffs.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 ; This script reads in output from the CVMix stand-alone driver using double
 ; diffusion mixing from Large, et al., 1992. This script takes the output from
@@ -20,7 +21,7 @@ begin
   nml  = asciiread("input.nl", -1, "integer")
   nlev = 2*nml(0)
   yt   = new((/2, nlev/), "double")
-  if (isfilepresent("data.nc")) then
+  if (check_for_file("data.nc")) then
     print((/"Reading netCDF data"/))
     f = addfile("data.nc", "r")
 
@@ -29,7 +30,7 @@ begin
     yt(0,:) = f->Tdiff(0:nlev-1,0)
     yt(1,:) = f->Tdiff(0:nlev-1,1)
   else
-    if (fileexists("data.out")) then
+    if (check_for_file("data.out")) then
       print((/"Reading ascii data"/))
       x1 = new((/nlev  /), "double")
       ys = new((/nlev  /), "double")

reg_tests/kpp/plot_bulk_Rich.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 begin
 
@@ -12,7 +13,7 @@ begin
 ; Create Color Table
   my_color_map = (/"White", "Black"/)
 
-  if (isfilepresent("test5.nc")) then
+  if (check_for_file("test5.nc")) then
     print((/"Reading netCDF data"/))
     f = addfile("test5.nc", "r")
     zt      = f->zt
@@ -21,7 +22,7 @@ begin
     Ri_bulk = f->BulkRichardson
     hd      = -f@OBL_depth
   else
-    if (fileexists("test5.out")) then
+    if (check_for_file("test5.out")) then
       print((/"Reading ascii data"/))
       nlev = 10
       zt      = new((/nlev/), "double")

reg_tests/kpp/plot_flux_profiles.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 begin
 
@@ -12,14 +13,14 @@ begin
 ; Create Color Table
   my_color_map = (/"White", "Black"/)
 
-  if (isfilepresent("test3.nc")) then
+  if (check_for_file("test3.nc")) then
     print((/"Reading netCDF data"/))
     f = addfile("test3.nc", "r")
     sigma = f->data(0,:)
     phi_m   = f->data(1,:)
     phi_s   = f->data(2,:)
   else
-    if (fileexists("test3.out")) then
+    if (check_for_file("test3.out")) then
       print((/"Reading ascii data"/))
       nlev = 220
       sigma = new((/nlev+1/), "double")

reg_tests/shear/plot_LMD_diff_coeffs.ncl

@@ -1,6 +1,7 @@
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 ; This script reads in output from the CVMix stand-alone driver using the shear
 ; mixing technique from Large, et al., 1992. This script takes the output from
@@ -16,13 +17,13 @@ begin
   my_color_map = (/"White", "Black"/)
 
   ; Read data for LMD94 plot
-  if (isfilepresent("data_LMD.nc")) then
+  if (check_for_file("data_LMD.nc")) then
     print((/"Reading netCDF data"/))
     f = addfile("data_LMD.nc", "r")
     x = f->ShearRichardson
     y = f->Tdiff
   else
-    if (fileexists("data_LMD.out")) then
+    if (check_for_file("data_LMD.out")) then
       print((/"Reading ascii data"/))
       nml  = asciiread("input.nl", -1, "integer")
       nlev = nml(0)

reg_tests/shear/plot_PP_diff_coeffs.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 ; This script reads in output from the CVMix stand-alone driver using the shear
 ; mixing technique from Large, et al., 1992. This script takes the output from
@@ -17,13 +18,13 @@ begin
   my_color_map = (/"White", "Black"/)
 
   ; Read data for PP81 plot
-  if (isfilepresent("data_PP2d.nc")) then
+  if (check_for_file("data_PP2d.nc")) then
     print((/"Reading netCDF data"/))
     f = addfile("data_PP2d.nc", "r")
     x = f->ShearRichardson
     y = transpose(f->Mdiff)
   else
-    if (fileexists("data_PP2d.out")) then
+    if (check_for_file("data_PP2d.out")) then
       print((/"Reading ascii data"/))
       nml  = asciiread("input.nl", -1, "integer")
       nlev = nml(0)

reg_tests/tidal-Simmons/plot_diff_coeffs.ncl

@@ -2,6 +2,7 @@ load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"
 load "../common/plot_settings.ncl"
+load "../common/version_consistency.ncl"
 
 begin
 
@@ -13,7 +14,7 @@ begin
   my_color_map = (/"White", "Black"/)
 
   in_file = "single_col.nc"
-  if (isfilepresent(in_file)) then
+  if (check_for_file(in_file)) then
     print((/"Reading netCDF data"/))
     f = addfile(in_file, "r")
     x = f->Tdiff

reg_tests/tidal-Simmons/plot_tidal_energy_map.ncl

@@ -1,5 +1,6 @@
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_code.ncl"
 load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/gsn_csm.ncl"
+load "../common/version_consistency.ncl"
 
 begin
 
@@ -8,7 +9,7 @@ begin
   ; out_type = "X11"
 
   in_file = "../../inputdata/tidal_energy_gx1v6_20130512.nc"
-  if (isfilepresent(in_file)) then
+  if (check_for_file(in_file)) then
     print((/"Reading netCDF data"/))
     f = addfile(in_file, "r")
     tmplat = f->lat