From 9e25607f05420da1c39d8f486bf10fb369463592 Mon Sep 17 00:00:00 2001 From: nickb <nickb@ssec.wisc.edu> Date: Fri, 29 Jan 2021 22:33:19 +0000 Subject: [PATCH] add the most basic of READMEs --- gridded_glm/PACKAGE_README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/gridded_glm/PACKAGE_README.md b/gridded_glm/PACKAGE_README.md index c04e353..98db29d 100644 --- a/gridded_glm/PACKAGE_README.md +++ b/gridded_glm/PACKAGE_README.md @@ -1,3 +1,21 @@ # CSPP Geo Gridded GLM -TODO \ No newline at end of file +USAGE + +The following scripts are located in the `bin/` directory. + +cspp-geo-gglm-trio-picker.sh + +A simple wrapper around cspp-geo-gglm-minute-gridder.sh that takes a single input file and: +1) determines if it is the last file in a minute +2) if so, finds all files from that minute and passes them to cspp-geo-gglm-minute-gridder.sh +3) creates both grids and tiles for that minute + +cspp-geo-gglm-minute-gridder.sh + +This script creates one minute grids from any number of input files. + + +cspp-geo-gglm-make-grids.sh + +A wrapper for the `make_GLM_grids.py` "kitchen sink" example script provided by glmtools. \ No newline at end of file -- GitLab