diff --git a/gridded_glm/PACKAGE_README.md b/gridded_glm/PACKAGE_README.md index c04e3534941e05fc15aa6e571f9ccc3dfe096a21..98db29de7c9c4b2e606e2437f945df413773fb4d 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