Running CLAVRXORB
After compiling CLAVR-x and setting up the ancillary data, the
following steps are needed to run CLAVRXORB, the orbital processor for
CLAVR-x. Note, this page is for the most recent version of CLAVR-x. Older
versions do not necessarily have the same steps to run. Please contact Andrew
Heidinger to obtain the most recent code.
1. Obtain AVHRR Level 1b data in standard NOAA format (10 bit packed).
This data can be obtained from the NOAA CLASS archive (www.class.noaa.gov). CLAVR-x can handle gzipped Level 1b files.
2. Create a clavrxorb_file_list to hold the names of files to process and input/output paths.
CLAVRXORB looks for files to process from the list contained in the clavrxorb_file_list file. An example is listed below.
Line 1 is the path to the level 1b data files
Line 2 is the path to the 1bx output files
Line 3 is the path to the navigation files to be read in
Line 4 is the path to the navigation files to write out
Line 5 is the path to the cloud mask results (cmr) files
Line 6 is the path to the cloud mask tests (cmt) files
Line 7 is the path to the sst files
Line 8 is the path to the cloud (cld) files
Line 9 is the path to the observation (obs) files
Line 10 is the path to the geolocation (geo) files
Line 11 is the path to the radiative transfer (rtm) files
Line 12 is the path to the volcanic ash products files
Line 13 is the path to the aerosol (aer) files
Line 14 is the path to the earth radiation budget (erb) files
Line 15 is the path to the generic level2 output (level2) files
Line 16 is the path to the mapped output (orbital cell) files
Line 17 the name of the first level1b file to process
Line 18-XX are the names of the other level 1b files to process
Here is an example
/data7/avhrr_archive/gac/n18_2006/
/data4/patmosx/1bx/
/data7/avhrr_archive/gac/nav/n18_2006/
./nav/
./cmr/
./cmt/
./sst/
./cld/
./obs/
./geo/
./rtm/
./ash/
./aer/
./erb/
./level2/
./orbital/
NSS.GHRR.NN.D06108.S2357.E0152.B0470304.WI.gz
NSS.GHRR.NN.D06107.S2231.E0013.B0468889.GC.gz
NSS.GHRR.NN.D06108.S0007.E0202.B0468990.WI.gz
NSS.GHRR.NN.D06108.S0157.E0352.B0469091.WI.gz
NSS.GHRR.NN.D06108.S0346.E0541.B0469192.WI.gz
NSS.GHRR.NN.D06108.S0535.E0723.B0469293.WI.gz
NSS.GHRR.NN.D06108.S0717.E0912.B0469394.GC.gz
NSS.GHRR.NN.D06108.S0906.E1040.B0469495.GC.gz
NSS.GHRR.NN.D06108.S1035.E1221.B0469596.GC.gz
NSS.GHRR.NN.D06108.S1216.E1411.B0469697.GC.gz
NSS.GHRR.NN.D06108.S1405.E1543.B0469798.GC.gz
NSS.GHRR.NN.D06108.S1537.E1708.B0469899.WI.gz
NSS.GHRR.NN.D06108.S1703.E1848.B0469800.WI.gz
NSS.GHRR.NN.D06108.S1842.E2037.B0469901.GC.gz
NSS.GHRR.NN.D06108.S2032.E2220.B0470102.GC.gz
NSS.GHRR.NN.D06108.S2215.E0003.B0470203.GC.gz
NSS.GHRR.NN.D06108.S2357.E0152.B0470304.WI.gz
3. Setting CLAVRXORB Options
The user can configure the options and output from CLAVRXORB by setting
the flags in the clavrxorb_default_options file. This file must
reside in $CLAVRX_HOME
Here is an example (with line numbers added for clarity)
1 0 !ref_cal_1b flag (0 = do not use reflectance cal in level 1b)
2 0 !therm_cal_1b flag (0 = do not use thermal cal in level 1b)
3 0 !1bx
flag (1 = fill in clavr-x bytes in level
1b)
4 0 !nav flag (0=level-1b,1 = clevernav)
5 1 !write nav out (1 = write to a nav file)
6 0 !cmr file flag (0=no,1=make output file)
7 0 !cmt file flag (0=no,1=make output file)
8 1 !obs file flag (0=no,1=make output file)
9 1 !geo file flag (0=no,1=make output file)
10 1 !cld file flag (0=no,1=make output file)
11 0 !sst file flag (0=no,1=make output file)
12 0 !aot file flag (0=no,1=make output file)
13 0 !erb file flag (0=no,1=make output file)
14 0 !rtm file flag (0=no,1=make output file)
15 0 !ash file flag (0=no,1=make output file)
16 0 !patmosx file flag (0=no,1=make output file)
17 0 !cell file flag (1 = make gridded output)
18 0 !cloud mask 1b (1 = read from 1b and don't recompute)
19 1 !ir cloud type (0=no, 1 = yes)
20 1 !sst flag (0= no, 1 = yes)
21 1 !cld flag (0= no, 1 = yes)
22 1 !aot flag (0= no, 1 = yes)
23 1 !erb flag (0= no, 1 = yes)
24 1 !ash flag (0= no, 1 = yes)
25 1 !use oisst
26 0 !oisst option (0 = determine file, 1 = use oisst.current)
27 0.5 !grid resolution
28 0 !grid format: eq. area (0) / eq. angle (1)
29 1 !output compression flag (0=no,1=gzip,2=szip)
30 0 !subset pixel hdf flag (0=no / 1= yes)
31 1 !nwp flag (0=no nwp,1=gfs,2=ncep reanalysis)
32 1 !rtm flag (0=crtm,1=pfast)
33 1 !clear composite flag (0=no,1=yes)
34 1 !use modis clear ref (0=no,1=yes)
35 1 !prob_clear_res_flag (0=no,1=yes)
36 1 !lrc_flag (0=no,1=yes)
37 1 !crc_flag (0=no,1=yes)
38 0 !diagnostic output flag
39 0 !node for diagnostic output (0=asc,1=des)
40 20.0 !minimum latitude for analysis
41 40.0 !maximum latitude for analysis
42 /data1/heidinger/Ancil_Data/clavrx_ancil_data/
43 /data1/heidinger/Ancil_Data/gfs/hdf/
44 /data1/heidinger/Ancil_Data/ncep-reanalysis/
45 /data1/heidinger/Ancil_Data/oisst/
46 1 !smooth nwp flag (0=no, 1 = yes)
47 1 !seebor emiss flag (0=no, 1 = yes)
48 1 !read hires sfc type flag (0=no-8km, 1 = yes-1km)
49 1 !read land mask flag (0=no, 1 = yes)
50 1 !read coast mask flag (0=no, 1 = yes)
51 2 !read surface elevation flag (0=no, 1=8km res, 2=1km res)
52 0 !read volcano mask flag (0=no, 1 = yes)
53 0.0 180.0 !solar zenith angle limits
Setting a flag to 0 means the flag is off and 1 is on.
Also, please make a directory called /diag_output under
$CLAVRX_HOME. This is the default location for diagnostic output
which is made is the diagnostic
output flag is set to 1. The diagnostic file contents are controlled by the avhrr_diag_routines.f90 module.
4. Running CLAVRXORB
To run CLAVRXORB, simple run the executable (CLAVRXORB) in the
$CLAVRX_HOME directory. CLAVRXORB will read the
clavrxorb_file_list and clavrxorb_default_options and take the
appropriate actions. Currently, there are several
command arguments that can be used. A list of them is
available by typing the name of the executable with the -help command line
option (clavrxorb -help ) on the command line.