Feature #2168 tc_diag

.github/workflows/testing.yml

@@ -167,7 +167,7 @@ jobs:
     strategy:
       matrix:
         tests:
-          - 'ascii2nc_indy pb2nc_indy tc_dland tc_pairs tc_stat plot_tc tc_rmw rmw_analysis tc_gen'
+          - 'ascii2nc_indy pb2nc_indy tc_dland tc_pairs tc_stat plot_tc tc_rmw rmw_analysis tc_diag tc_gen'
           - 'met_test_scripts mode_multivar mode_graphics mtd regrid airnow gsi_tools netcdf modis series_analysis gen_ens_prod wwmca_regrid gen_vx_mask grid_weight interp_shape grid_diag grib_tables lidar2nc shift_data_plane trmm2nc aeronet wwmca_plot ioda2nc gaussian'
       fail-fast: false
     steps:

INSTALL

@@ -219,6 +219,7 @@ sub-directory, or the MET Online Tutorial:
    - series_analysis
    - shift_data_plane
    - stat_analysis
+   - tc_diag
    - tc_dland
    - tc_gen
    - tc_pairs

configure

@@ -8877,7 +8877,7 @@ done
 
 # Create configured files
 
-ac_config_files="$ac_config_files Makefile scripts/Rscripts/Makefile scripts/Rscripts/include/Makefile scripts/python/Makefile scripts/python/examples/Makefile scripts/python/met/Makefile scripts/python/pyembed/Makefile scripts/python/utility/Makefile data/Makefile data/climo/Makefile data/climo/seeps/Makefile data/colortables/Makefile data/colortables/NCL_colortables/Makefile data/config/Makefile data/map/Makefile data/map/admin_by_country/Makefile data/poly/Makefile data/poly/HMT_masks/Makefile data/poly/NCEP_masks/Makefile data/ps/Makefile data/table_files/Makefile data/tc_data/Makefile src/Makefile src/basic/Makefile src/basic/enum_to_string/Makefile src/basic/vx_cal/Makefile src/basic/vx_config/Makefile src/basic/vx_log/Makefile src/basic/vx_math/Makefile src/basic/vx_util/Makefile src/basic/vx_util_math/Makefile src/libcode/Makefile src/libcode/vx_afm/Makefile src/libcode/vx_analysis_util/Makefile src/libcode/vx_color/Makefile src/libcode/vx_data2d/Makefile src/libcode/vx_data2d_factory/Makefile src/libcode/vx_data2d_grib/Makefile src/libcode/vx_data2d_grib2/Makefile src/libcode/vx_data2d_nc_met/Makefile src/libcode/vx_data2d_nc_pinterp/Makefile src/libcode/vx_data2d_nccf/Makefile src/libcode/vx_geodesy/Makefile src/libcode/vx_gis/Makefile src/libcode/vx_gnomon/Makefile src/libcode/vx_grid/Makefile src/libcode/vx_gsl_prob/Makefile src/libcode/vx_nav/Makefile src/libcode/vx_solar/Makefile src/libcode/vx_nc_obs/Makefile src/libcode/vx_nc_util/Makefile src/libcode/vx_pb_util/Makefile src/libcode/vx_plot_util/Makefile src/libcode/vx_ps/Makefile src/libcode/vx_pxm/Makefile src/libcode/vx_render/Makefile src/libcode/vx_shapedata/Makefile src/libcode/vx_stat_out/Makefile src/libcode/vx_statistics/Makefile src/libcode/vx_time_series/Makefile src/libcode/vx_physics/Makefile src/libcode/vx_series_data/Makefile src/libcode/vx_regrid/Makefile src/libcode/vx_tc_util/Makefile src/libcode/vx_summary/Makefile src/libcode/vx_python3_utils/Makefile src/libcode/vx_data2d_python/Makefile src/libcode/vx_bool_calc/Makefile src/libcode/vx_pointdata_python/Makefile src/libcode/vx_seeps/Makefile src/tools/Makefile src/tools/core/Makefile src/tools/core/ensemble_stat/Makefile src/tools/core/grid_stat/Makefile src/tools/core/mode/Makefile src/tools/core/mode_analysis/Makefile src/tools/core/pcp_combine/Makefile src/tools/core/point_stat/Makefile src/tools/core/series_analysis/Makefile src/tools/core/stat_analysis/Makefile src/tools/core/wavelet_stat/Makefile src/tools/other/Makefile src/tools/other/ascii2nc/Makefile src/tools/other/lidar2nc/Makefile src/tools/other/gen_ens_prod/Makefile src/tools/other/gen_vx_mask/Makefile src/tools/other/gis_utils/Makefile src/tools/other/ioda2nc/Makefile src/tools/other/madis2nc/Makefile src/tools/other/mode_graphics/Makefile src/tools/other/modis_regrid/Makefile src/tools/other/pb2nc/Makefile src/tools/other/plot_data_plane/Makefile src/tools/other/plot_point_obs/Makefile src/tools/other/wwmca_tool/Makefile src/tools/other/gsi_tools/Makefile src/tools/other/regrid_data_plane/Makefile src/tools/other/point2grid/Makefile src/tools/other/shift_data_plane/Makefile src/tools/other/mode_time_domain/Makefile src/tools/other/grid_diag/Makefile src/tools/tc_utils/Makefile src/tools/tc_utils/tc_dland/Makefile src/tools/tc_utils/tc_pairs/Makefile src/tools/tc_utils/tc_stat/Makefile src/tools/tc_utils/tc_gen/Makefile src/tools/tc_utils/rmw_analysis/Makefile src/tools/tc_utils/tc_rmw/Makefile"
+ac_config_files="$ac_config_files Makefile scripts/Rscripts/Makefile scripts/Rscripts/include/Makefile scripts/python/Makefile scripts/python/examples/Makefile scripts/python/met/Makefile scripts/python/pyembed/Makefile scripts/python/utility/Makefile scripts/python/tc_diag/Makefile data/Makefile data/climo/Makefile data/climo/seeps/Makefile data/colortables/Makefile data/colortables/NCL_colortables/Makefile data/config/Makefile data/map/Makefile data/map/admin_by_country/Makefile data/poly/Makefile data/poly/HMT_masks/Makefile data/poly/NCEP_masks/Makefile data/ps/Makefile data/table_files/Makefile data/tc_data/Makefile src/Makefile src/basic/Makefile src/basic/enum_to_string/Makefile src/basic/vx_cal/Makefile src/basic/vx_config/Makefile src/basic/vx_log/Makefile src/basic/vx_math/Makefile src/basic/vx_util/Makefile src/basic/vx_util_math/Makefile src/libcode/Makefile src/libcode/vx_afm/Makefile src/libcode/vx_analysis_util/Makefile src/libcode/vx_color/Makefile src/libcode/vx_data2d/Makefile src/libcode/vx_data2d_factory/Makefile src/libcode/vx_data2d_grib/Makefile src/libcode/vx_data2d_grib2/Makefile src/libcode/vx_data2d_nc_met/Makefile src/libcode/vx_data2d_nc_pinterp/Makefile src/libcode/vx_data2d_nccf/Makefile src/libcode/vx_geodesy/Makefile src/libcode/vx_gis/Makefile src/libcode/vx_gnomon/Makefile src/libcode/vx_grid/Makefile src/libcode/vx_gsl_prob/Makefile src/libcode/vx_nav/Makefile src/libcode/vx_solar/Makefile src/libcode/vx_nc_obs/Makefile src/libcode/vx_nc_util/Makefile src/libcode/vx_pb_util/Makefile src/libcode/vx_plot_util/Makefile src/libcode/vx_ps/Makefile src/libcode/vx_pxm/Makefile src/libcode/vx_render/Makefile src/libcode/vx_shapedata/Makefile src/libcode/vx_stat_out/Makefile src/libcode/vx_statistics/Makefile src/libcode/vx_time_series/Makefile src/libcode/vx_physics/Makefile src/libcode/vx_series_data/Makefile src/libcode/vx_regrid/Makefile src/libcode/vx_tc_util/Makefile src/libcode/vx_summary/Makefile src/libcode/vx_python3_utils/Makefile src/libcode/vx_data2d_python/Makefile src/libcode/vx_bool_calc/Makefile src/libcode/vx_pointdata_python/Makefile src/libcode/vx_seeps/Makefile src/tools/Makefile src/tools/core/Makefile src/tools/core/ensemble_stat/Makefile src/tools/core/grid_stat/Makefile src/tools/core/mode/Makefile src/tools/core/mode_analysis/Makefile src/tools/core/pcp_combine/Makefile src/tools/core/point_stat/Makefile src/tools/core/series_analysis/Makefile src/tools/core/stat_analysis/Makefile src/tools/core/wavelet_stat/Makefile src/tools/other/Makefile src/tools/other/ascii2nc/Makefile src/tools/other/lidar2nc/Makefile src/tools/other/gen_ens_prod/Makefile src/tools/other/gen_vx_mask/Makefile src/tools/other/gis_utils/Makefile src/tools/other/ioda2nc/Makefile src/tools/other/madis2nc/Makefile src/tools/other/mode_graphics/Makefile src/tools/other/modis_regrid/Makefile src/tools/other/pb2nc/Makefile src/tools/other/plot_data_plane/Makefile src/tools/other/plot_point_obs/Makefile src/tools/other/wwmca_tool/Makefile src/tools/other/gsi_tools/Makefile src/tools/other/regrid_data_plane/Makefile src/tools/other/point2grid/Makefile src/tools/other/shift_data_plane/Makefile src/tools/other/mode_time_domain/Makefile src/tools/other/grid_diag/Makefile src/tools/tc_utils/Makefile src/tools/tc_utils/tc_dland/Makefile src/tools/tc_utils/tc_pairs/Makefile src/tools/tc_utils/tc_stat/Makefile src/tools/tc_utils/tc_gen/Makefile src/tools/tc_utils/rmw_analysis/Makefile src/tools/tc_utils/tc_rmw/Makefile src/tools/tc_utils/tc_diag/Makefile"
 
 
 if test -n "$MET_DEVELOPMENT"; then
@@ -9769,6 +9769,7 @@ do
     "scripts/python/met/Makefile") CONFIG_FILES="$CONFIG_FILES scripts/python/met/Makefile" ;;
     "scripts/python/pyembed/Makefile") CONFIG_FILES="$CONFIG_FILES scripts/python/pyembed/Makefile" ;;
     "scripts/python/utility/Makefile") CONFIG_FILES="$CONFIG_FILES scripts/python/utility/Makefile" ;;
+    "scripts/python/tc_diag/Makefile") CONFIG_FILES="$CONFIG_FILES scripts/python/tc_diag/Makefile" ;;
     "data/Makefile") CONFIG_FILES="$CONFIG_FILES data/Makefile" ;;
     "data/climo/Makefile") CONFIG_FILES="$CONFIG_FILES data/climo/Makefile" ;;
     "data/climo/seeps/Makefile") CONFIG_FILES="$CONFIG_FILES data/climo/seeps/Makefile" ;;
@@ -9869,6 +9870,7 @@ do
     "src/tools/tc_utils/tc_gen/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/tc_utils/tc_gen/Makefile" ;;
     "src/tools/tc_utils/rmw_analysis/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/tc_utils/rmw_analysis/Makefile" ;;
     "src/tools/tc_utils/tc_rmw/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/tc_utils/tc_rmw/Makefile" ;;
+    "src/tools/tc_utils/tc_diag/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/tc_utils/tc_diag/Makefile" ;;
     "src/tools/dev_utils/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/dev_utils/Makefile" ;;
     "src/tools/dev_utils/shapefiles/Makefile") CONFIG_FILES="$CONFIG_FILES src/tools/dev_utils/shapefiles/Makefile" ;;
     "internal/test_util/Makefile") CONFIG_FILES="$CONFIG_FILES internal/test_util/Makefile" ;;

configure.ac

@@ -1211,6 +1211,7 @@ AC_CONFIG_FILES([Makefile
                  scripts/python/met/Makefile
                  scripts/python/pyembed/Makefile
                  scripts/python/utility/Makefile
+                 scripts/python/tc_diag/Makefile
                  data/Makefile
                  data/climo/Makefile
                  data/climo/seeps/Makefile
@@ -1310,7 +1311,8 @@ AC_CONFIG_FILES([Makefile
                  src/tools/tc_utils/tc_stat/Makefile
                  src/tools/tc_utils/tc_gen/Makefile
                  src/tools/tc_utils/rmw_analysis/Makefile
-                 src/tools/tc_utils/tc_rmw/Makefile])
+                 src/tools/tc_utils/tc_rmw/Makefile
+                 src/tools/tc_utils/tc_diag/Makefile])
 
 if test -n "$MET_DEVELOPMENT"; then
    AC_CONFIG_FILES([src/tools/dev_utils/Makefile

data/config/Makefile.am

@@ -38,6 +38,7 @@ config_DATA = \
 	STATAnalysisConfig_default \
 	STATAnalysisConfig_GO_Index \
 	STATAnalysisConfig_CBS_Index \
+	TCDiagConfig_default \
 	TCPairsConfig_default \
 	TCRMWConfig_default \
 	RMWAnalysisConfig_default \

data/config/Makefile.in

@@ -315,6 +315,7 @@ config_DATA = \
 	STATAnalysisConfig_default \
 	STATAnalysisConfig_GO_Index \
 	STATAnalysisConfig_CBS_Index \
+	TCDiagConfig_default \
 	TCPairsConfig_default \
 	TCRMWConfig_default \
 	RMWAnalysisConfig_default \

data/config/TCDiagConfig_default

@@ -0,0 +1,150 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// TC-Diag configuration file.
+//
+// For additional information, please see the MET User's Guide.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Filter input track data lines.
+//
+
+//
+// Model
+//
+model = [];
+
+//
+// Storm identifier
+//
+storm_id = "";
+
+//
+// Basin
+//
+basin = "";
+
+//
+// Cyclone number
+//
+cyclone = "";
+
+//
+// Model initialization time
+//
+init_inc = "";
+
+//
+// Subset by the valid time
+//
+valid_beg = "";
+valid_end = "";
+valid_inc = [];
+valid_exc = [];
+
+//
+// Subset by the valid hour and lead time.
+//
+valid_hour = [];
+lead       = [];
+
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Python diagnostic scripts to be run
+// May be set separately in each "domain_info" entry 
+//
+diag_script = [ "MET_BASE/python/tc_diag/compute_tc_diagnostics.py" ];
+
+//
+// Domain-specific cylindrical coordinate transformation
+//
+domain_info = [
+   {
+      domain         = "parent";
+      n_range        = 150;
+      n_azimuth      = 8;
+      delta_range_km = 10.0;
+   },
+   {
+      domain         = "nest";
+      n_range        = 150;
+      n_azimuth      = 8;
+      delta_range_km = 2.0;
+   }
+];
+
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Data censoring and conversion
+// May be set separately in each diag_data "field" entry
+//
+// censor_thresh = [];
+// censor_val    = [];
+// convert(x)    = x;
+//
+
+//
+// Data fields
+//
+data = {
+
+   // If empty, the field is processed for all domains
+   domain = [];
+
+   // Pressure levels to be used, unless overridden below
+   level = [ "P1000", "P925", "P850", "P700", "P500",
+             "P400", "P300", "P250", "P200", "P150",
+             "P100" ];
+
+   field = [
+      { name = "TMP";                  },
+      { name = "UGRD";                 },
+      { name = "VGRD";                 },
+      { name = "RH";                   },
+      { name = "HGT";                  },
+      { name = "PRMSL"; level = "Z0";  },
+      { name = "PWAT";  level = "L0";  },
+      { name = "TMP";   level = "Z0";  },
+      { name = "TMP";   level = "Z2";  },
+      { name = "RH";    level = "Z2";  },
+      { name = "UGRD";  level = "Z10"; },
+      { name = "VGRD";  level = "Z10"; }
+   ];
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Regridding options
+//
+regrid = {
+   method     = NEAREST;
+   width      = 1;
+   vld_thresh = 0.5;
+   shape      = SQUARE;
+}
+
+//
+// Vortex removal flag
+//
+vortex_removal = FALSE;
+
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Flags to control output files
+//
+nc_rng_azi_flag = TRUE;
+nc_diag_flag    = FALSE;
+cira_diag_flag  = FALSE;
+
+////////////////////////////////////////////////////////////////////////////////
+
+tmp_dir       = "/tmp";
+output_prefix = "";
+version       = "V11.1.0";
+
+////////////////////////////////////////////////////////////////////////////////

docs/Users_Guide/index.rst

@@ -67,6 +67,7 @@ The National Center for Atmospheric Research (NCAR) is sponsored by NSF. The DTC
    met-tc_overview
    tc-dland
    tc-pairs
+   tc-diag
    tc-stat
    tc-gen
    tc-rmw