Skip to content
Snippets Groups Projects
Commit 32615ae9 authored by Graeme Martin's avatar Graeme Martin
Browse files

Updated README for v1.1 release

parent bbf25001
No related branches found
No related tags found
1 merge request!37Merge work from 1.1 into master
# CSPP Geo Gridded GLM v1.0
# CSPP Geo Gridded GLM v1.1
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.
January 2025
**Copyright (C) 2020-2025 Space Science and Engineering Center (SSEC), University
of Wisconsin-Madison.**
University of Wisconsin-Madison
Space Science and Engineering Center
1225 West Dayton Street
Madison, WI 53706
CSPP Geo Software Lead: Levi Pfantz
CSPP Geo Product Manager: Scott Lindstrom
Contact: csppgeo.issues@ssec.wisc.edu
Gridded GLM Documentation: https://cimss.ssec.wisc.edu/csppgeo/gridded-glm.html
CSPP Geo Home Page: http://cimss.ssec.wisc.edu/csppgeo/
## OVERVIEW
CSPP Geo Gridded GLM software processes GOES-16, -17, -18 and -19 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:
......@@ -17,7 +37,7 @@ Questions and comments can be directed to <csppgeo.issues@ssec.wisc.edu>.
## 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).
The software package is built on the open source glmtools software developed by Dr. Eric Bruning (Texas Tech University). 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.
......@@ -26,17 +46,32 @@ Bruning, E. C., Tillier, C. E., Edgington, S. F., Rudlosky, S. D., Zajic, J. K.,
The developers wish to thank Lee Byerle and Joe Zajic, NWS TOWR-S team, for their assistance with tile development and AWIPS compatibility.
## COPYRIGHT / LICENSE / DISCLAIMER
Portions of the source code in this software package are:
## COPYRIGHT / LICENSE
Copyright (C) 2020-2022 Space Science and Engineering Center (SSEC), University of Wisconsin-Madison.
Portions of the source code in this software package are copyrighted by the
University of Wisconsin Regents. This package includes original software
developed by the University of Wisconsin (UW), as well as third-party software
libraries. UW software is licensed under the GNU General Public License Version 3.
Other binary executable files and third-party source code are copyrighted and
licensed by their respective organizations, and are distributed consistent with
their licensing terms. For more information, refer to LICENSE and LICENSE.md files
distributed with the software package.
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.
## DISCLAIMER
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.
The University of Wisconsin-Madison Space Science and Engineering Center
(SSEC) makes no warranty of any kind with regard to the CSPP Geo 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.
There is no expressed or implied warranty made to anyone as to the suitability
of this software for any purpose. 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 Geo software.
## INSTALLATION
......@@ -44,8 +79,8 @@ The University of Wisconsin-Madison Space Science and Engineering Center (SSEC)
To install, extract the tarball and optionally add the bin directory to your PATH.
```
tar xf cspp-geo-gridded-glm-1.0.tar.xz
export PATH=$PATH:$PWD/cspp-geo-gridded-glm-1.0/bin
tar xf cspp-geo-gridded-glm-1.1.0.tar.xz
export PATH=$PATH:$PWD/cspp-geo-gridded-glm-1.1/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.​
......@@ -79,11 +114,11 @@ Create a single one-minute gridded product file by specifying three input 20-sec
Create a single one-minute gridded product file by specifying only one of the three input 20-second GLM L2+ files ("realtime" mode)
`cspp-geo-gglm.sh -1 /data/GLM-L2/2019299/17/OR_GLM-L2-LCFA_G16_s20192991759400_e20192991800000_c20192991800031.nc`
`cspp-geo-gglm.sh -r /data/GLM-L2/2019299/17/OR_GLM-L2-LCFA_G16_s20192991759400_e20192991800000_c20192991800031.nc`
Create a gridded product file and tiles
`cspp-geo-gglm.sh -1 -t /data/GLM-L2/2019299/17/OR_GLM-L2-LCFA_G16_s20192991759400_e20192991800000_c20192991800031.nc`
`cspp-geo-gglm.sh -r -t /data/GLM-L2/2019299/17/OR_GLM-L2-LCFA_G16_s20192991759400_e20192991800000_c20192991800031.nc`
## CAVEATS
......
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