updates to 9/25/20

Author: AnsleyManke

bench/TEST_SCRIPTS

@@ -347,6 +347,8 @@ bn_dsg_naming.jnl
 bn_profile_from_timeprof.jnl
 bn_profile_from_trajprof.jnl
 bn_dsg_compound.jnl
+bn_dsg_plotalong.jnl
+bn_dsg_return_coord.jnl
 
 !
 ! bn_gif, bn_all_ef, and bn_startupfile at end

bench/TEST_SCRIPTS_NOREMOTE

@@ -347,6 +347,8 @@ bn_dsg_naming.jnl
 bn_profile_from_timeprof.jnl
 bn_profile_from_trajprof.jnl
 bn_dsg_compound.jnl
+bn_dsg_plotalong.jnl
+bn_dsg_return_coord.jnl
 
 !
 ! bn_gif, bn_all_ef, and bn_startupfile at end

bench/genjnls/bn_all.jnl

@@ -1355,6 +1355,12 @@ GO bn_dsg_reshapefcn
 GO bn_reset bn_dsg_compound
 GO bn_compound_dsg
 
+GO bn_reset bn_dsg_plotalong
+GO bn_dsg_plotalong
+
+GO bn_reset bn_dsg_return_coord
+GO bn_dsg_return_coord
+
 ! *********** PyFerret-specific scripts ***********
 
 IF ($program_name"0|PyFerret>1|*>0") THEN

bench/test_results/plot_along_native_dsg.gif

@@ -0,0 +1,72 @@
+! bn_dsg_plotalong.jnl
+! tests of PLOT/ALONG= for DSG datasets
+!   plot/along-xy will make a map plot for timeseries, profile, 
+!   timeseriesprofile or trajectoryprofile data
+!   plot/along=t makes a timeseries plot of timeseriesprofile data.
+
+use profile_dsg.nc
+set view ul
+plot/along=xy sal
+
+use simple_timeseries_dsg
+set view ur
+plot/along=xy sst
+
+use dsg_trajprofile_example.nc
+set view ll
+plot/along=xy temperature
+
+use dsg_tserprofile_example.nc
+set view lr
+plot/along=xy temperature
+
+frame/file=plot_alongxy_dsg.gif
+cancel view
+
+! Now test plot/along= giving the native plot type,
+! which should do plot as if /along= were not given.
+
+use profile_dsg.nc
+set view ul
+plot/along=z sal
+
+use simple_timeseries_dsg
+set view ur
+plot/along=t sst
+
+use dsg_trajprofile_example.nc
+set view ll
+plot/along=z temperature
+
+use dsg_tserprofile_example.nc
+set view lr
+plot/along=z temperature
+
+frame/file=plot_along_native_dsg.gif
+
+cancel view
+! Intentional errors, specifying /along= for directions
+! that are invalid for the data type
+
+set mode ignore
+
+use profile_dsg.nc
+plot/along=y sal
+plot/along=t sal
+
+use simple_timeseries_dsg
+plot/along=y sst
+plot/along=z sst
+
+use dsg_trajprofile_example.nc
+plot/along=y temperature
+plot/along=t temperature
+
+use dsg_point_data.nc
+plot/along=y sst
+use dsg_point_data.nc
+plot/along=z sst
+use dsg_point_data.nc
+plot/along=t sst
+
+set mode /last ignore

bench/test_results/plot_alongxy_dsg.gif

@@ -0,0 +1,34 @@
+! bn_dsg_return_coord.jnl
+!   `var,return=xcoord`  for DSG variables
+
+use profile_dsg.nc
+say `sal,return=xcoord`
+say `sal,return=ycoord`
+say `sal,return=zcoord`
+say `sal,return=tcoord`
+say `sal,return=xaxis`
+say `sal,return=zaxis`
+say `sal,return=eaxis`
+
+
+use dsg_trajprofile_example.nc
+say `temperature,return=xcoord`
+say `temperature,return=ycoord`
+say `temperature,return=zcoord`
+say `temperature,return=tcoord`
+say `temperature,return=xaxis`
+say `temperature,return=zaxis`
+say `temperature,return=eaxis`
+
+! Intentional errors
+set mode ignore
+
+! The variable has to be an instance variable or a obs variable
+say `trajectory,return=xcoord`
+
+! Desn't apply to gridded datasets
+
+use coads_climatology
+say `sst,return=xcoord`
+
+set mode/last ignore

bench/v7jnls/bn_dsg_plotalong.jnl

@@ -133,6 +133,7 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
 *                  correct info for `var,return=dset` and dsetnum and dsetpath.
 * V745  4/19 *acm* ticket 1916, special handling getting context for RETURN= outputs
 * V751  6/19 *acm* ticket 1929, don't chop off str_len when testing for reformatting at the end
+* V7.63 9/20 *acm* add `var,RETURN=*coord` to get coordinate variables for DSG datasets
 
         IMPLICIT NONE
 #include "netcdf.inc"
@@ -166,6 +167,7 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
 	INTEGER   CGRID_SIZE, CGRID_AXIS, TM_LENSTR1, CX_DIM_LEN,
      .		  FIND_DSET_NUMBER, GET_ABSTRACT_LINE, TM_LENSTR,
      .		  TM_GET_GRIDNUM, GRID_FROM_NAME, TM_SUBSC, TM_GET_CALENDAR_ID,
+     .		  TM_DSG_DSET_FROM_GRID,
      .		  str_len, lenbuff, iend, itmp, axis,
      .		  mr, cx, mr_temp, i, i1, i2, use_digits, true_end,
      .		  qual_end, brkt, idim, use_width, dset, varid,
@@ -177,7 +179,8 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
 	REAL	  result, val, aval
 	REAL*8 TM_WORLD, TM_WW_AXLEN, ww
 	CHARACTER TM_FMT*48, LEFINT*16, VAR_TITLE*(max_len),
-     .		  VAR_UNITS*(max_len), GET_STRING_ELEMENT*(max_len),
+     .		  VAR_UNITS*(max_len), GET_STRING_ELEMENT*(max_len), 
+     .		  VAR_CODE*1024,
      .		  repl*(max_len), bad_str*(max_len), return_errmsg*256,
      .            buff*128, varname*512, attname*128, aname*128, name*128
         CHARACTER*6 typstring(0:6)
@@ -795,7 +798,7 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
            WRITE (return_errmsg,*)  
      .       'use RETURN= shape,size,grid,title,bad,t0,f0,units,dset, '//pCR//
      .	     '  dsetnum,dsetpath,dsettitle,*size,*start,*end,'//pCR//
-     .       '  *units,*axis,nc_scale,nc_offset,user_scale,user_offset,'//pCR//
+     .       '  *units,*axis,*coord,nc_scale,nc_offset,user_scale,user_offset,'//pCR//
      .       '  calendar,dtype,xmod,tmod,status,isDepth,isReady,defined'
 !     .       '  calendar,dtype,xmod,tmod,status,isDepth,isReady,isLoaded' ! w isLoaded
 
@@ -1156,7 +1159,7 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
 !	         repl = '1'
 !	      ENDIF
 !	   
-* ... RETURN=*SIZE, *START, *END, *UNITS, *AXIS
+* ... RETURN=*SIZE, *START, *END, *UNITS, *AXIS, or *COORD for dsg datasets
 	   ELSE	
 * ... axis specific requests - must start with i,j,k,l,m,n or x,y,z,t,e,f
 	      DO 220 idim = 1, nferdims
@@ -1187,6 +1190,34 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
 		    CALL CHOOSE_LINE_NAME(axis, orig_name, repl)
 	         ENDIF
 	         need_formatting = .FALSE.
+
+	      ELSEIF ( repl(2:5) .EQ. "COOR") THEN
+	         grid = cx_grid(cx)
+		 IF (TM_ITSA_DSG(grid)) THEN
+
+		    dset = TM_DSG_DSET_FROM_GRID( grid )
+
+		    IF (idim.LE.t_dim) THEN
+		       repl = VAR_CODE( cat_file_var, dsg_coord_var(idim,dset))
+
+		    ELSE
+		       axis = CGRID_AXIS ( idim, cx )
+		       IF (axis.EQ.mnormal .OR. axis.EQ.munknown) THEN
+	                 repl = 'NORMAL'
+		       ELSE
+* Get axis name. If mode upcase is canceled, use original spelling if defined
+		          orig_name = .FALSE.
+		          CALL CHOOSE_LINE_NAME(axis, orig_name, repl)
+		       ENDIF
+		       need_formatting = .FALSE.
+		    ENDIF
+
+		 ELSE ! not dsg
+		    GOTO 5530
+		 ENDIF
+
+	         need_formatting = .FALSE.
+
 	      ELSEIF ( repl(2:5) .EQ. "UNIT" ) THEN
 	         axis = CGRID_AXIS ( idim, cx )
 	         IF (axis.EQ.mnormal .OR. axis.EQ.munknown) THEN
@@ -1415,4 +1446,9 @@ SUBROUTINE REPL_EXPRNS(  cmnd, lencmnd, cmnd_num,
  5520   risc_buff = cmnd(i:qual_end)
 	CALL ERRMSG( ferr_invalid_command, status,
      .     return_errmsg//pCR//risc_buff, *5000)
+
+ 5530   risc_buff = cmnd(i:qual_end)
+	CALL ERRMSG( ferr_invalid_command, status,
+     .       'Variable is not on a DSG grid in a DSG dataset: '
+     .					//risc_buff, *5000)
 	END

bench/v7jnls/bn_dsg_return_coord.jnl

@@ -45,7 +45,7 @@ SUBROUTINE DSG_PLTALONG_SETUP (dset, plot_orient, its_traj,
 	IF (dset .LE. pdset_irrelevant) RETURN
 
 	its_traj = dsg_feature_type(dset).EQ.pfeatureType_Trajectory .OR.  
-     .	           dsg_feature_type(dset).EQ.pfeatureType_Point
+     .	          dsg_feature_type(dset).EQ.pfeatureType_Point
 
 * dataset orientation. 
 
@@ -56,102 +56,107 @@ SUBROUTINE DSG_PLTALONG_SETUP (dset, plot_orient, its_traj,
 	along_dim = no_dim
 	loc = qual_given(slash_plot_along) 
 	IF ( loc .GT. 0. )  THEN
-	       
+	      
 	   CALL EQUAL_STRING( cmnd_buff(qual_start(loc):qual_end(loc)),
      .                     buff1, status )
 	   IF (status .NE. ferr_ok) THEN
-	      plot_orient = orientation
-	      GOTO 4000
+	     plot_orient = orientation
+	     GOTO 4000
 	   ENDIF
 
 	   DO along_dim = 1, nferdims
-	      IF ( buff1 .EQ. ww_dim_name(along_dim) ) EXIT
+	     IF ( buff1 .EQ. ww_dim_name(along_dim) ) EXIT
 	   ENDDO
 
 	ENDIF
 
 	IF (along_dim .EQ. no_dim) GOTO 4000
 
-* Check valid setings for PLOT/ALONG= for each Feature Type
+* Check valid setings for PLOT/ALONG= for each Feature Type.
+* When the setting agrees with the default plot direction, ignore
+* the /along= setting.
 
 	IF (orientation .EQ. pfeatureType_Point) THEN
 
-	    plot_orient = orientation
-	    IF (along_dim .NE. x_dim) 
-     .	    message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : Point data can only be plotted along XY'
-
+	   plot_orient = orientation
+	   IF (along_dim .EQ. x_dim) THEN
+	      GOTO 5000
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : Point data can only be plotted along XY'
+	   ENDIF
 	ELSE IF (orientation .EQ. pfeatureType_Trajectory) THEN
 
-	    IF (along_dim .EQ. x_dim) THEN
-	       plot_orient = orientation
-	    ELSE IF (along_dim.EQ.t_dim) THEN
-	       plot_orient = pfeatureType_TimeSeries
-	    ELSE
-	       message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : Trajectory data can only be plotted along XY or T'
-	    ENDIF
+	   IF (along_dim .EQ. x_dim) THEN
+	      GOTO 5000	      
+	   ELSE IF (along_dim.EQ.t_dim) THEN
+	      plot_orient = pfeatureType_TimeSeries
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : Trajectory data can only be plotted along XY or T'
+	   ENDIF
 
 
 	ELSE IF (orientation .EQ. pfeatureType_Profile) THEN
 
-	    IF (along_dim .EQ. z_dim) THEN
-	       plot_orient = orientation
-	    ELSE IF (along_dim .EQ. x_dim) THEN
-	       plot_orient = pfeatureType_Point
-	    ELSE
-	       message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : Profile data can only be plotted along XY or Z'
-	    ENDIF
+	   IF (along_dim .EQ. z_dim) THEN
+	      GOTO 5000	      
+	   ELSE IF (along_dim .EQ. x_dim) THEN
+	      plot_orient = pfeatureType_Point
+	      dsg_as_traj = .TRUE.
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : Profile data can only be plotted along XY or Z'
+	   ENDIF
 
 	ELSE IF (orientation .EQ. pfeatureType_TimeSeries) THEN
 
-	    IF (along_dim .EQ. t_dim) THEN
-	       plot_orient = orientation
-	    ELSE IF (along_dim .EQ. x_dim) THEN
-	       plot_orient = pfeatureType_Point
-	    ELSE
-	       message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : Timeseries data can only be plotted along XY or Z'
-	    ENDIF
+	   IF (along_dim .EQ. t_dim) THEN
+	      GOTO 5000	      
+	   ELSE IF (along_dim .EQ. x_dim) THEN
+	      plot_orient = pfeatureType_Point
+	      dsg_as_traj = .TRUE.
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : Timeseries data can only be plotted along XY or Z'
+	   ENDIF
 
 	ELSE IF (orientation .EQ. pfeatureType_TrajectoryProfile ) THEN
 
 	   IF (along_dim .EQ. x_dim) THEN 
 	      plot_orient = pFeatureType_Trajectory
 	      dsg_as_traj = .TRUE.
-	    ELSE IF (along_dim .EQ. z_dim) THEN
-	       plot_orient = pfeatureType_Profile
-	    ELSE
-	       message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : TrajectoryProfile data'//
-     .	       '  can only be plotted along XY or Z'
-	    ENDIF
-	    
+	   ELSE IF (along_dim .EQ. z_dim) THEN
+	      GOTO 5000
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : TrajectoryProfile data'//
+     .	      '  can only be plotted along XY or Z'
+	   ENDIF
+	   
 	ELSE IF (orientation .EQ. pfeatureType_TimeseriesProfile ) THEN
 
 	   IF (along_dim .EQ. x_dim) THEN 
 	      plot_orient = pFeatureType_Point
 	      dsg_as_traj = .TRUE.
-	    ELSE IF (along_dim .EQ. z_dim) THEN
-	       plot_orient = pfeatureType_Profile
-	      dsg_as_traj = .TRUE.
-	    ELSE IF (along_dim .EQ. t_dim) THEN
-	       plot_orient = pfeatureType_Timeseries
-	       dsg_as_time = .TRUE.
-	    ELSE
-	       message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
-     .	       ' : pfeatureType_TimeseriesProfile data'//
-     .	       ' can only be plotted along XY, Z, or T'
-	    ENDIF
+	   ELSE IF (along_dim .EQ. z_dim) THEN
+	      GOTO 5000
+	   ELSE IF (along_dim .EQ. t_dim) THEN
+	      plot_orient = pfeatureType_Timeseries
+	      dsg_as_time = .TRUE.
+	   ELSE
+	      message = 'PLOT/ALONG='//ww_dim_name(along_dim)//
+     .	      ' : pfeatureType_TimeseriesProfile data'//
+     .	      ' can only be plotted along XY, Z, or T'
+	   ENDIF
 
 	ENDIF
 
  4000	CONTINUE
 
 	its_traj = plot_orient.EQ.pfeatureType_Trajectory .OR.  
-     .	           plot_orient.EQ.pfeatureType_Point .OR.  
-     .	           dsg_as_traj
+     .	          plot_orient.EQ.pfeatureType_Point .OR.  
+     .	          dsg_as_traj
 
 	IF (message .NE. 'none') THEN
 	   CALL ERRMSG (ferr_invalid_command,  status, message, *5000)