@@ -22,22 +22,17 @@ Eric Bruning, developer of the open source glmtools package which this software
Scott Rudlosky, GOES-R GLM Science Team lead and developer of the Gridded GLM products,
Lee Byerle and Joe Zajic, NWS TOWR-S team, for their assistance with tile development and AWIPS compatibility.
## COPYRIGHT / LICENSE
## COPYRIGHT / LICENSE / DISCLAIMER
Portions of the source code in this software package are:
Copyright (C) 2020-2021 Space Science and Engineering Center (SSEC), University of Wisconsin-Madison.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Original source code, scripts and automation included as part of this package are distributed under the GNU General Public License agreement version 3.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
Binary executable files and third-party source code included as part of this software package are copyrighted and licensed by their respective organizations, and distributed consistent with their licensing terms.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
The University of Wisconsin-Madison Space Science and Engineering Center (SSEC) makes no warranty of any kind with regard to the CSPP software or any accompanying documentation, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. SSEC does not indemnify any infringement of copyright, patent, or trademark through the use or modification of this software. All risk of use is assumed by the user. Users agree not to hold SSEC, the University of Wisconsin-Madison, or any of its employees or assigns liable for any consequences resulting from the use of the CSPP software.
## INSTALLATION
...
...
@@ -47,7 +42,8 @@ To install, extract the tarball and optionally add the bin directory to your PAT
A test data tarball can be downloaded from the same location as the software. Reference output is included. Refer to the EXAMPLES section below to run the test case.
The main processing script creates one minute grids from GLM L2+ LCFA input files, which can be obtained from the CSPP Geo GRB software or from NOAA CLASS. It is recommended that all 3 20-second input files from the same minute be specified, to ensure that the gridded product captures all lightning activity from that minute. Alternatively the script can be run in "realtime" mode where, provided a single input file, it will determine if an entire minute is available and if so begin gridding.
For a list of options, run "cspp-geo-gglm.sh -h".
For a list of options, run `cspp-geo-gglm.sh -h`.
**cspp-geo-gglm-make-grids.sh**
...
...
@@ -69,9 +65,9 @@ The Gridded GLM product is written by the main processing script in the form of
Example Gridded GLM product filename: `CG_GLM-L2-GLMF-M3_G16_s20192991759000_e20192991800000_c20210492345130.nc`
A set of tiles can optionally be created for each Gridded GLM file. The tiles are also NetCDF4 files and designed to be compatible with AWIPS. Tiles covering geographic areas without lightning activity are omitted.
A set of tiles can optionally be created for each Gridded GLM file. The tiles are also NetCDF4 files and designed to be compatible with AWIPS. Tiles covering geographic areas without lightning activity are omitted. The time in the filename is the observation end time.
Example tile filename: `CG_GLM-L2-GLMF-M3_G16_T15_20191026180000.nc`
Example tile filename: `CSPP_OR_GLM-L2-GLMF-M3_G16_T15_20191026180000.nc`
## EXAMPLES
...
...
@@ -95,6 +91,7 @@ The following issues are known to affect this release
- The DQF (data quality flags) are always set to 0 in this version. Proper data quality information will be added in a future version
- In the default processing mode (not "realtime" mode), if the first 20-second file of the minute is not specified, the output file time will be offset from the nominal minute boundaries. This will be addressed in a future release, but note that it is recommended to provide all 3 20-second input files.
- Tile generation with CONUS and mesoscale gridding has not been fully tested
