README.GPM_VN_DPR_geo_match_v1_1.txt
------------------------------------

Below is a list of all the files included in the file 
GPM_VN_DPR_geo_match_v1_1.tar, which contains all the IDL source code required 
to compile the DPR-GR geometry-matching procedure, POLAR2DPR.  This procedure 
processes GPM Dual-frequency Precipitation Radar (DPR) and coincident ground 
radar (GR) data into a common set of spatial data volumes using a geometry-
matching algorithm, and writes the geo-match data to a netCDF file.  Inputs 
include one of the three DPR products 2A-Ka, 2A-Ku, or 2A-DPR; an optional 
2B-DPRGMI product; and time-matched GR data for a single volume scan in either 
a Universal Format (UF) file, a TRMM 1C-51 HDF file, a WSR-88D Level-II Archive 
data file, or in any other format handled by the TRMM Radar Software Library 
(RSL).  Other required inputs are: (1) a control file specifying the DPR and GR 
product names and selected metadata; and (2) formal IDL parameters which provide
program control and data file localization (path/name) information to the 
POLAR2DPR procedure.  See the documentation in README_first_POLAR2DPR_v1_1.pdf
and/or the prologue of the polar2dpr.pro source code file for details.

The IDL source code files are organized into four directories:

geo_match/
common_utils/
vn_include/
rsl_in_idl/

and a precompiled, binary executable version (IDL SAVE file) of polar2dpr is
contained in one additional directory:

/bin

The first 3 directories contain code specific to the GPM Validation Network
software.  Those files in the directory rsl_in_idl/ are a copy of version 1.5 
of the TRMM Radar Software Library in IDL, RSL in IDL, also available from
the TRMM Ground Validation web site: http://trmm-fc.gsfc.nasa.gov/index.html.
All the files under the directory rsl_in_idl/ are complete and unmodified from 
the RSL in IDL distribution.

The file geo_match/loadcolortable.pro substitutes for the baseline RSL procedure
contained in rsl_loadcolortable.pro, and has been customized to meet the
(optional) PPI display capabilities of POLAR2DPR.

Note also the following.  The top-level IDL routine contained in polar2dpr.pro
is a combination of both polar2dpr.pro and polar2dpr_resampling.pro.  Neither of
these files alone comprise a complete, compilable IDL procedure.  The file
polar2dpr_resampling.pro is "included" inline in the polar2dpr.pro file by the 
IDL include mechanism.  See the inline documentation for details.  Nothing 
special needs to be done to compile and run POLAR2DPR on account of this.


CONSTRAINTS
-----------

1. This code makes use of the gzip utility, and so will only run on LINUX,
   UNIX, MAC OS-X, and other operating systems which support gzip and IDL.
2. All DPR products for a given orbit must be from matching data subsets, i.e.,
   the identical set of DPR scans must be present in the level 2A and (optional)
   2B-DPRGMI files.  DPR products for a given orbit also should be of the same  
   product version, but this is not enforced in the code.
3. UF files for sites not 'known' to this code must label their quality-
   controlled reflectivity data field name as 'CZ'.  This constraint is
   implemented in the function common_utils/get_site_specific_z_volume.pro.
   Otherwise, the CASE statement in get_site_specific_z_volume.pro will need to
   be modified to handle the new site ID and its associated UF reflectivity data
   field ID.
4. POLAR2DPR will only run in IDL Version 8.0 or a later version.


SORTED FILE LISTING FOR GPM_VN_DPR_geo_match_v1_1.tar
-----------------------------------------------------

bin/polar2dpr.sav

common_utils/cos_and_tan_of_pr_angle.pro
common_utils/dpr_gate_num_for_height.pro
common_utils/find_alt_filename.pro
common_utils/free_ptrs_in_struct.pro
common_utils/gate_num_for_height.pro
common_utils/get_cmb_datasets.pro
common_utils/get_cmb_input_group.pro
common_utils/get_dpr_csf_group.pro
common_utils/get_dpr_dsd_group.pro
common_utils/get_dpr_experimental_group.pro
common_utils/get_dpr_flg_group.pro
common_utils/get_dpr_layer_average.pro
common_utils/get_dpr_navigation_group.pro
common_utils/get_dpr_pre_group.pro
common_utils/get_dpr_scanstatus_group.pro
common_utils/get_dpr_slv_group.pro
common_utils/get_dpr_srt_group.pro
common_utils/get_dpr_verenv_group.pro
common_utils/get_dpr_ver_group.pro
common_utils/get_julday.pro
common_utils/get_mean_bb_height.pro
common_utils/get_parallax_dx_dy.pro
common_utils/get_range_km_at_beam_hgt_km.pro
common_utils/get_rsl_radar.pro
common_utils/get_scan_slope_and_sense.pro
common_utils/get_scantime_group.pro
common_utils/get_site_specific_z_volume.pro
common_utils/get_sweep_elevs.pro
common_utils/get_sweep_times.pro
common_utils/get_time_from_sotd.pro
common_utils/local_maxima.pro
common_utils/parse_file_header_group.pro
common_utils/parse_swath_header_group.pro
common_utils/read_2adpr_hdf5.pro
common_utils/read_2akaku_hdf5.pro
common_utils/read_2bcmb_hdf5.pro
common_utils/ticks_from_datetime.pro
common_utils/uncomp_file.pro
common_utils/unixtime.pro
common_utils/vn_colorbar.pro

geo_match/bin_corner_x_and_y.pro
geo_match/footprint_corner_x_and_y.pro
geo_match/gen_dpr_geo_match_netcdf.pro
geo_match/loadcolortable.pro
geo_match/mean_stddev_max_by_rules.pro
geo_match/plot_elevation_gv_to_pr_z.pro
geo_match/polar2dprgmi.pro
geo_match/polar2dprgmi_resampling.pro
geo_match/polar2dpr.pro
geo_match/polar2dpr_resampling.pro
geo_match/uniq_sweeps.pro

rsl_in_idl/CHANGES.txt
rsl_in_idl/COPYING.txt
rsl_in_idl/get_dimensions.pro
rsl_in_idl/getmetaobject.pro
rsl_in_idl/get_parmnames_hdf.pro
rsl_in_idl/gv_radar_site_info.data
rsl_in_idl/is_compressed.pro
rsl_in_idl/jul2cal.pro
rsl_in_idl/load_radar_from_wsr88d_m31.pro
rsl_in_idl/monthname.pro
rsl_in_idl/nsig_v1_define_structs.pro
rsl_in_idl/nsig_v2_define_structs.pro
rsl_in_idl/plot_range_rings2.pro
rsl_in_idl/README.txt
rsl_in_idl/rsl_add_volume.pro
rsl_in_idl/rsl_adjust_coord.pro
rsl_in_idl/rsl_anyformat_to_radar.pro
rsl_in_idl/rsl_changefield.pro
rsl_in_idl/rsl_colorbar.pro
rsl_in_idl/rsl_draw_azimuth_spokes.pro
rsl_in_idl/rsl_fix_time.pro
rsl_in_idl/rsl_get_azm_from_sweep.pro
rsl_in_idl/rsl_get_date_from_filename.pro
rsl_in_idl/rsl_get_fields.pro
rsl_in_idl/rsl_get_groundr_and_h.pro
rsl_in_idl/rsl_get_gr_slantr_h.pro
rsl_in_idl/rsl_get_numvos.pro
rsl_in_idl/rsl_get_radar_site_info.pro
rsl_in_idl/rsl_get_range_from_sweep.pro
rsl_in_idl/rsl_get_ray_from_sweep.pro
rsl_in_idl/rsl_get_ray.pro
rsl_in_idl/rsl_get_site_from_filename.pro
rsl_in_idl/rsl_get_slantr_and_elev.pro
rsl_in_idl/rsl_get_slantr_and_h.pro
rsl_in_idl/rsl_get_sweep.pro
rsl_in_idl/rsl_get_uf_last_sweepnum.pro
rsl_in_idl/rsl_get_volume.pro
rsl_in_idl/rsl_hdf_to_radar.pro
rsl_in_idl/rslinstall
rsl_in_idl/rsl_lassen_to_radar.pro
rsl_in_idl/rsl_loadcolortable.pro
rsl_in_idl/rsl_new_radar.pro
rsl_in_idl/rsl_new_ray.pro
rsl_in_idl/rsl_new_sweep.pro
rsl_in_idl/rsl_new_volume.pro
rsl_in_idl/rsl_nsig_to_radar.pro
rsl_in_idl/rsl_open_radar_file.pro
rsl_in_idl/rsl_plotrhi.pro
rsl_in_idl/rsl_plotrhi_sweep.pro
rsl_in_idl/rsl_plotsweep_from_radar.pro
rsl_in_idl/rsl_plotsweep.pro
rsl_in_idl/rsl_radar_to_uf_gzip.pro
rsl_in_idl/rsl_radar_to_uf.pro
rsl_in_idl/rsl_read_lassen_file.pro
rsl_in_idl/rsl_select_sweeps.pro
rsl_in_idl/rsl_uf_to_radar.pro
rsl_in_idl/rsl_uncompress.pro
rsl_in_idl/rsl_vslice.pro
rsl_in_idl/rsl_which_struct.pro
rsl_in_idl/rsl_wsr88d_to_radar.pro
rsl_in_idl/VERSION.txt
rsl_in_idl/wsr88d_get_site_info.pro
rsl_in_idl/wsr88d_locations.dat
rsl_in_idl/wsr88d_read_tape_header.pro
rsl_in_idl/ymd.pro
rsl_in_idl/doc/hdf_to_radar.html
rsl_in_idl/doc/Install.html
rsl_in_idl/doc/radar_header.html
rsl_in_idl/doc/radarstruct.html
rsl_in_idl/doc/ray_header.html
rsl_in_idl/doc/raystruct.html
rsl_in_idl/doc/rsl_add_volume.html
rsl_in_idl/doc/rsl_anyformat_to_radar.html
rsl_in_idl/doc/rsl_changefield.html
rsl_in_idl/doc/rsl_get_fields.html
rsl_in_idl/doc/rsl_get_groundr_and_h.html
rsl_in_idl/doc/rsl_get_gr_slantr_h.html
rsl_in_idl/doc/rsl_get_ray_from_sweep.html
rsl_in_idl/doc/rsl_get_ray.html
rsl_in_idl/doc/rsl_get_slantr_and_elev.html
rsl_in_idl/doc/rsl_get_slantr_and_h.html
rsl_in_idl/doc/rsl_get_sweep.html
rsl_in_idl/doc/rsl_get_volume.html
rsl_in_idl/doc/RSL_in_IDL.html
rsl_in_idl/doc/rsl_plotrhi.html
rsl_in_idl/doc/rsl_plotsweep_from_radar.html
rsl_in_idl/doc/rsl_plotsweep.html
rsl_in_idl/doc/rsl_radar_to_uf_gzip.html
rsl_in_idl/doc/rsl_radar_to_uf.html
rsl_in_idl/doc/rsl_routines.html
rsl_in_idl/doc/rsl_select_sweeps.html
rsl_in_idl/doc/rsl_structures.html
rsl_in_idl/doc/rsl_vslice.html
rsl_in_idl/doc/rsl_which_struct.html
rsl_in_idl/doc/sweep_header.html
rsl_in_idl/doc/sweepstruct.html
rsl_in_idl/doc/volume_header.html
rsl_in_idl/doc/volumestruct.html
rsl_in_idl/doc/whatsnew.html

vn_include/bogus.pro
vn_include/dpr_params.inc
vn_include/environs.inc
vn_include/grid_def.inc
vn_include/radar_dp_parameters.pro
