2020 02 10 beta1 high priority

gridded_glm/libexec/_minute_gridder.py

 #!/usr/bin/env python3
 # Based on https://github.com/deeplycloudy/glmtools/blob/master/examples/grid/make_GLM_grids.py
 
-parse_desc = """Grid the past X minutes of GLM flash data, given a single input file.
+parse_desc = """Create one minute NetCDF4 grids (and, optionally, AWIPS-compatible tiles) from GLM flash data.
+
+Example usage:\n
+    cspp-geo-gglm.sh \\
+        --goes-sector conus \\
+        --create-tiles \\
+        -vv \\
+        OR_GLM-L2-LCFA_G17_s20182750032000_e20182750032200_c20182750032225.nc \\
+        OR_GLM-L2-LCFA_G17_s20182750032200_e20182750032400_c20182750032426.nc \\
+        OR_GLM-L2-LCFA_G17_s20182750032400_e20182750033000_c20182750033025.nc
 """
 
 import numpy as np
@@ -26,20 +35,21 @@ log = logging.getLogger(__name__)
 
 def create_parser():
     import argparse
-    parser = argparse.ArgumentParser(description=parse_desc)
+    parser = argparse.ArgumentParser(description=parse_desc, formatter_class=argparse.RawTextHelpFormatter) # RawTextHelpFormatter preserves our newlines in the example usage message
     parser.add_argument('-v', '--verbose', dest='verbosity', action="count", default=0,
-                        help='each occurrence increases verbosity 1 level through ERROR-WARNING-INFO-DEBUG (default INFO)')
+                        help="each occurrence increases verbosity 1 level through ERROR-WARNING-INFO-DEBUG\n"
+                             "(default: ERROR)")
     parser.add_argument('-l', '--log', dest="log_fn", default=None,
-                        help="specify the log filename")
-    # from Requirements: "Output is Gridded GLM in the native glmtools NetCDF4 format, with a user option to produce AWIPS-compatible NetCDF tiles as described below"
-    parser.add_argument('-o', '--output-dir', metavar='output directory',
-                        default=os.getcwd())
-    parser.add_argument('--goes-sector', default="full",
-                        help="One of [full|conus|meso]. "
-                             "If sector is meso, ctr_lon and ctr_lat "
-                             "are interpreted as the ctr_x and ctr_y of the fixed grid.")
+                        help="specify a log filename.\n"
+                             "(default: print to screen).")
+    parser.add_argument('-o', '--output-dir', metavar='OUTPUT_DIR',
+                        default=os.getcwd(), help="output directory (default: use current directory)")
+    parser.add_argument('--goes-sector', default="full", choices=['full', 'conus', 'meso'],
+                        help="If sector is meso, ctr_lon and ctr_lat \n"
+                             "are interpreted as the ctr_x and ctr_y of the fixed grid.\n"
+                             "(default: full)")
     parser.add_argument("-t", "--create-tiles", default=False, action='store_true',
-                        help="create AWIPS-compatible tiles") # FIXME: improve this help text
+                        help="create AWIPS-compatible tiles (default: off)")
     parser.add_argument('--ctr-lat', metavar='latitude',
                         type=float, help='center latitude (required for meso)')
     parser.add_argument('--ctr-lon', metavar='longitude',
@@ -183,7 +193,8 @@ if __name__ == '__main__':
 
     # Configure logging
     levels = [logging.ERROR, logging.WARN, logging.INFO, logging.DEBUG]
-    logging.basicConfig(level=levels[min(3, args.verbosity)], filename=args.log_fn)
+    clamp = lambda n, minn, maxn: max(min(maxn, n), minn) # used below to keep us from going off the end of the logging levels
+    logging.basicConfig(level=levels[clamp(args.verbosity, 0, len(levels)-1)], filename=args.log_fn)
     if levels[min(3, args.verbosity)] > logging.DEBUG:
         import warnings
         warnings.filterwarnings("ignore")