Skip to content
Snippets Groups Projects
Commit 803c0769 authored by Nick Bearson's avatar Nick Bearson
Browse files

Merge branch '1.0b1rc3-readme-3' into 'master'

More updates to README for v1b1

See merge request !17
parents 1c4b0755 bd8f8d25
No related branches found
No related tags found
1 merge request!17More updates to README for v1b1
# CSPP Geo Gridded GLM v1.0 Beta1
CSPP Geo Gridded GLM software takes GOES GLM Level 2+ LCFA files and grids them to the ABI fixed grid, creating a new set of GLM gridded products which were developed by the GOES-R GLM Science Team. Tiles can optionally be created in an AWIPS-compatible format.
CSPP Geo Gridded GLM software processes GOES-16 and GOES-17 Geostationary Lightning Mapper (GLM) Level 2+ LCFA products in mission standard format, generating a new set of products which have been gridded to the Advanced Baseline Imager (ABI) 2-km resolution, and are aggregated at one-minute intervals. Spatial extent information that is not readily available in the GLM L2+ data is recovered and used to create the gridded products.
The new gridded products are:
......@@ -8,19 +8,23 @@ The new gridded products are:
- Flash Extent Density
- Total Optical Energy
This software was developed at the University of Wisconsin - Madison, SSEC / CIMSS, under funding provided by the NOAA STAR / GOES-R Program.
This software package was developed at the University of Wisconsin - Madison, SSEC / CIMSS, under funding provided by the GOES-R Program and NOAA STAR.
The latest version of this software can be obtained from: https://cimss.ssec.wisc.edu/csppgeo/
The latest version of this software can be obtained from: <https://cimss.ssec.wisc.edu/csppgeo/>
Questions and comments can be directed to csppgeo.issues@ssec.wisc.edu.
Questions and comments can be directed to <csppgeo.issues@ssec.wisc.edu>.
## ACKNOWLEDGEMENTS
The developers wish to thank:
## ATTRIBUTION
The software package is built on the open source glmtools software developed by Dr. Eric Bruning (Texas Tech University). Ongoing development of operational Gridded GLM products and related research is led by Dr. Scott Rudlosky (NOAA/NESDIS/STAR).
This release builds on two years of effort to refine the glmtools package in pre-operational demonstrations, and many of the contributors to that effort are coauthors on the paper that describes the GLM imagery creation approach in detail.
Bruning, E. C., Tillier, C. E., Edgington, S. F., Rudlosky, S. D., Zajic, J. K., Gravelle, C. M., Foster, M., Calhoun, K. M., Campbell, P. A., Stano, G. T., Schultz, C. J., and Meyer, T. C. (2019). Meteorological imagery for the Geostationary Lightning Mapper. 2019: Meteorological imagery for the Geostationary Lightning Mapper. J. Geophys. Res., 124 (24), 14 285–14 309, https://doi.org/10.1029/2019JD030874
The developers wish to thank Lee Byerle and Joe Zajic, NWS TOWR-S team, for their assistance with tile development and AWIPS compatibility.
- Eric Bruning, developer of the open source glmtools package which this software is based on,
- Scott Rudlosky, GOES-R GLM Science Team lead and PI of the NOAA GLM Gridded Products effort,
- Lee Byerle and Joe Zajic, NWS TOWR-S team, for their assistance with tile development and AWIPS compatibility.
## COPYRIGHT / LICENSE / DISCLAIMER
......@@ -28,12 +32,13 @@ Portions of the source code in this software package are:
Copyright (C) 2020-2021 Space Science and Engineering Center (SSEC), University of Wisconsin-Madison.
Original source code, scripts and automation included as part of this package are distributed under the GNU General Public License agreement version 3.
Original UW/SSEC source code, scripts and automation included as part of this package are distributed under the GNU General Public License agreement version 3.
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.
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
To install, extract the tarball and optionally add the bin directory to your PATH.
......@@ -45,6 +50,7 @@ export PATH=$PATH:$PWD/cspp-geo-gridded-glm-1.0b1/bin
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.​
## USAGE
**cspp-geo-gglm.sh**
......@@ -59,6 +65,7 @@ For a list of options, run `cspp-geo-gglm.sh -h`.
This is a wrapper for the `make_GLM_grids.py` example utility provided by glmtools. Users may
find this script useful for creating grids with custom resolutions or frame durations.
## OUTPUT
The Gridded GLM product is written by the main processing script in the form of NetCDF4 files spanning a clock-aligned minute of input data. The file naming convention and file format are modeled after the GOES-R operational format, as documented in the GOES-R Product Definition and Users' Guide (PUG).
......@@ -99,18 +106,10 @@ The following issues are known to affect this release
Documentation:
- [GLM Quick Guides](https://www.star.nesdis.noaa.gov/GOES/documents/GLM_Quick_Guides_May_2019.pdf)
- [GLM Full Disk Quick Guide](http://rammb.cira.colostate.edu/training/visit/quick_guides/GLM_Full_Disk_Quick_Guide_V1.pdf)
- [GLM Minimum Flash Area Quick Guide](http://rammb.cira.colostate.edu/training/visit/quick_guides/GLM_MFA_Quick_Guide_V1.pdf)
- [GOES-R Lightning Detection Fact Sheet](https://www.goes-r.gov/education/docs/fs_lightning.pdf)
- [GOES-R Product Definition and Users' Guide](https://www.goes-r.gov/resources/docs.html)
- [GOES-R Gridded GLM Quick Guides](https://vlab.ncep.noaa.gov/web/geostationary-lightning-mapper/training)
- [NOAA Virtual Lab GLM Community](https://vlab.ncep.noaa.gov/web/geostationary-lightning-mapper)
- [University of Maryland GLM Imagery](https://lightning.umd.edu/glm/)
Software:
- [GLMTools software repository](https://github.com/deeplycloudy/glmtools)
Papers:
Bruning, E., Tillier, C. E., Edgington, S. F., Rudlosky, S. D., Zajic, J.,Gravelle, C., et al.
(2019). Meteorological imagery for the Geostationary Lightning Mapper. Journal of Geophysical
Research: Atmospheres, 2019; 124: 14285 14309. https://doi.org/10.1029/2019JD030874
- [glmtools software repository](https://github.com/deeplycloudy/glmtools)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment