A CODAS Control Files
A.12 llgrid.cnt Control File Structure
A.12.1 Part 1 of 2
/******************************************************************************
FILE: llgrid.cnt
This control file is used with the llgrid program
to generate a text file of time ranges that roughly correspond to longitude/latitude grid crossings. The grid is specified as a starting position and an increment for each dimension.
INPUT: CODAS database
OUTPUT: text file of time ranges which can be appended to an adcpsect control file to extract profile data for the desired sections
---CONTROL FILE STRUCTURE:
dbname: < CODAS database name >
output: < output filename >
step_size: < profile sampling rate > { 1 = every profile } latitude
origin: < decimal degrees >
increment: < decimal degrees >
longitude
origin: < decimal degrees >
increment: < decimal degrees >
time_ranges: { list of YMDHMS time pairs }
< yy/mm/dd hh:mm:ss > to < yy/mm/dd hh:mm:ss >
. . .
---*/
162
A.12.2 Part 2 of 2
/* Primary parameters for llgrid.cnt */
dbname: ../adcpdb/ademo output: ademoall.llg year_base: 1993
step_size: 1
/* Several examples of settings are shown for the lat/long options */
/* Options as used in preparation for vector plots. In this case, a large geographical area will be covered so the increment is large; typically the increment is set to 0.10 for spatial domains of roughly 30 by 30 degrees. */
lat_origin: -0.25 /* center bins */
lat_increment: 0.50 /* grid by 5/10 degree latitude */
lon_origin: -0.25
lon_increment: 0.50 /* and 5/10 degree longitude */
/* Options as used in preparation for a meridional contour plot. */
lat_origin: -0.05 /* center bins */
lat_increment: 0.10 /* grid by 1/10 degree latitude */
lon_origin: 100000
lon_increment: 0.10 /* and 1/10 degree longitude */
/* Options as used in preparation for a zonal contour plot. */
lat_origin: 1000000 /* center bins */
lat_increment: 0.10 /* grid by 1/10 degree latitude */
lon_origin: -0.05
lon_increment: 0.10 /* and 1/10 degree longitude */
/* Note in the two examples above, the axis which is held constant is deactivated by setting the origin to a large number */
time_ranges:
93/04/09 00:02:00 to 93/04/10 23:58:00
163
A.13 loadping.cnt
/******************************************************************************
FILE: loadping.cnt
This control file is used with the loadping program to load ADCP data from ping files into a CODAS database.
INPUT: 1. ping file(s)
2. producer definition file OUTPUT: 1. CODAS ADCP database (.blk files)
2. log file, if requested
NOTE: 1. It is alright to load the ping files incrementally into the same CODAS database, running loadping to load a few of them at a time.
2. Make sure that the case does not arise where a CODAS block file has a time range that overlaps another block file (this occurs when the ping files are not listed/loaded in chronological order and both NEW_BLOCK_AT_FILE? and NEW_BLOCK_AT_HEADER? are set to
’no’). In such cases, searching by time for profiles that fall within the overlap will check the earlier of the overlapping blocks ONLY.
MAX_BLOCK_PROFILES: < maximum no. of profiles per block <= 400 >
NEW_BLOCK_AT_FILE? < yes | no > { start new block for each ping file } NEW_BLOCK_AT_HEADER? < yes | no > { start new block for each header } NEW_BLOCK_TIME_GAP(min): < n > { start new block when gap > n minutes }
{ n must be <= 32767 }
PINGDATA_FILES: { list pingdata files from next line }
< input ping filename > { followed by 0 or more instances of the ff.: } [ time_correction:
start_header_number: < header # to start time correction >
correct_time: < correct GMT time > NEW_BLOCK_AT_HEADER? no NEW_BLOCK_TIME_GAP(min): 30
164
A.14 lst btrk.cnt
/******************************************************************************
FILE: lst_btrk.cnt
This control file is used with the lst_btrk program to extract the bottom track velocity data within the
specified time range(s) from a CODAS database into a text file.
INPUT: CODAS database
OUTPUT: text file with the following columns:
1. profile time (in decimal days)
2. zonal ship velocity over the ground (in m/s) 3. meridional ship velocity over the ground (in m/s) 4. bottom depth (in meters)
An entry with just a ’%’ in the first column signifies a gap of one or more profiles for which no bottom track data were available.
---CONTROL FILE STRUCTURE:
dbname: < CODAS database name >
output: < output filename >
step_size= < number of profiles to advance >
year_base= < base year for decimal days >
time_ranges: { list of time ranges to process }
< yy/mm/dd hh:mm:ss > to < yy/mm/dd hh:mm:ss >
. . .
---*/
dbname: ../../adcpdb/ademo output: ademo.btm
step_size= 1 year_base= 1993 time_ranges:
93/04/09 00:02:00 to 93/04/10 23:58:00
/*****************************************************************************/
165
A.15 lst hdg.cnt
/******************************************************************************
FILE: lst_hdg.cnt
This control file is used with the lst_hdg program to extract the ship’s mean heading and last heading from a CODAS database into a text file.
INPUT: CODAS database
OUTPUT: text file with the following columns:
1. profile time (in decimal days)
2. ship’s mean heading over the ensemble (in decimal degrees) 3. ship’s last heading for the ensemble (in decimal degrees)
---CONTROL FILE STRUCTURE:
dbname: < CODAS database name >
output: < output filename >
step_size= < number of profiles to advance >
year_base= < base year for decimal day conversions >
time_ranges: { list of YMDHMS time pairs }
< yy/mm/dd hh:mm:ss > to < yy/mm/dd hh:mm:ss >
. . .
---*/
dbname: ../../adcpdb/ademo output: ademo.hdg
step_size= 1 year_base= 1993 time_ranges:
93/04/09 00:02:00 to 93/04/10 23:58:00
/*****************************************************************************/
166
A.16 lst prof.cnt
/******************************************************************************
FILE: lst_prof.cnt
This control file is used with the lst_prof program to produce a list of times and positions of selected
profiles within the given time range(s) from a CODAS database.
INPUT: CODAS database
OUTPUT: text file of profile times and positions
---CONTROL FILE STRUCTURE:
dbname: < CODAS database name >
output: < output filename >
step_size: < number of profiles to advance >
time_ranges: { list of time ranges to select from }
< yy/mm/dd hh:mm:ss > to < yy/mm/dd hh:mm:ss >
. . .
---*/
dbname: ademo
output: ademoprf.lst step_size: 1
time_ranges:
93/04/09 00:02:00 to 93/04/10 23:58:00
/*****************************************************************************/
167
A.17 mkblkdir.cnt
/******************************************************************************
FILE: mkblkdir.cnt
This control file is used with the mkblkdir program to generate a new CODAS database from a set of CODAS block files. The new database will consist of a new block directory file and a copy of each input block file, converted if necessary to the host machine format. Note that the list of input block files should NOT include the directory block file.
INPUT: 1. CODAS block files (*.blk) 2. producer definition file
3. structure definition file, if needed (that is, if the data structures in the block files are not defined therein) OUTPUT: CODAS database
---CONTROL FILE STRUCTURE:
DB_NAME < output CODAS database name >
PRD_NAME < input producer definition filename >
[ DESTINATION < PC_COMPATIBLE_HOST | VAXD_COMPATIBLE_HOST | SUN3_COMPABTIBLE_
HOST > ] end
[ SD_NAME < input structure definition filename > ] [ BLOCK_FILE < input CODAS block filename > ]
. . .
---*/
DB_NAME new/a9103
PRD_NAME codas3/demo/adcpdb/codas3.def end
BLOCK_FILE codas3/demo/adcpdb/a9103001.blk BLOCK_FILE codas3/demo/adcpdb/a9103002.blk BLOCK_FILE codas3/demo/adcpdb/a9103003.blk
/*****************************************************************************/
168
A.18 nmea gps.cnt
/******************************************************************************
FILE: nmea_gps.cnt
This control file is used with the nmea_gps program to convert NMEA-formatted GPS fix files to a columnar text format suitable for use with the codas3/adcp/nav programs, and/or to Mat-file format for Matlab. In the latter case, the data are edited according to the given criteria prior to output.
INPUT: NMEA-formatted GPS fix files
OUTPUT: 1. if requested, text file (.gps) with the following columns:
a. fix time, in decimal days b. longitude, in decimal degrees c. latitude, in decimal degrees d. no. of satellites used e. quality index
f. horizontal dilution of precision (HDOP) g. 0, since no dopN
h. 0, since no dopE i. 0, since no dopV j. altitude
2. if requested, one or more Mat-files (.mat or .m?? if more than one) with the following arrays:
a. fix time, in decimal days b. longitude, in decimal degrees c. latitude, in decimal degrees
d. no. of satellites used, if requested
e. horizontal dilution of precision, if requested
---CONTROL FILE STRUCTURE:
[ YMD_BASE: < yy/mm/dd for decimal day conversions > ] { 00/01/01 } [ TIME_RANGE: < ALL | yy/mm/dd hh:mm:ss to yy/mm/dd hh:mm:ss > ] [ OUTPUT_ASCII_FILE: < none | root for output ASCII filename > ]
[ OUTPUT_MAT_FILE: < none | root for output Mat-filename >
[ max_HDOP= < max. allowed HDOP for Mat-file output > ] [ subsamples= < fix sampling rate for Mat-file output > ] [ max_mat_array_size= < maximum no. of fixes per Mat-file > ]
{ only needed for PC-Matlab (no virtual memory) } [ SAVE_NUM_OF_SAT { output no. of satellites info. to Mat-file } ] [ SAVE_HDOP { output HDOP info. to Mat-file } ]
[ GAP_INCLUDED { output bad fixes to Mat-file as NaNs } ]]
end { must always precede INPUT_GPS_FILES: } INPUT_GPS_FILES: { list in chronological order }
< NMEA-formatted GPS fix filename >
.
OUTPUT_MAT_FILE: nmeagps1 subsamples= 50
169