From bb35ae8a2fede24b8f35dc94aa720ff4bbd6c50a Mon Sep 17 00:00:00 2001 From: Brian Blaylock Date: Mon, 23 Aug 2021 16:54:57 -0600 Subject: [PATCH] updated README --- README.md | 72 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 644bc62..c3c9e52 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![](https://github.com/blaylockbk/goes2go/blob/master/docs/_static/goes2go_logo_100dpi.png?raw=true) -# Download and plot GOES-East and GOES-West data +# Download and display GOES-East and GOES-West data [![](https://img.shields.io/pypi/v/goes2go)](https://pypi.python.org/pypi/goes2go/) @@ -15,11 +15,7 @@ -**Brian Blaylock** -[🌐 Personal Webpage](http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/home.html) -[🌐 University of Utah HRRR archive page](http://hrrr.chpc.utah.edu/) - - +GOES-East and GOES-West satellite data are made available on Amazon Web Services through [NOAA's Big Data Program](https://www.noaa.gov/information-technology/big-data). **GOES-2-go** is a python package that makes it easy to find and download the files you want to your local computer with some additional helpers to look at and understand the data. --- @@ -31,39 +27,23 @@ --- -Download and read files from the NOAA GOES archive on AWS.http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/hrrr_FAQ.html - -Read doc strings for functions in `goes2go/` folder for full usage description. - ->### Some Useful Links ->- [📔 GOES-R Series Data Book](https://www.goes-r.gov/downloads/resources/documents/GOES-RSeriesDataBook.pdf) ->- [🎠 Beginner's Guide](https://www.goes-r.gov/downloads/resources/documents/Beginners_Guide_to_GOES-R_Series_Data.pdf) ->- [🖥 Rammb Slider GOES Viewer](https://rammb-slider.cira.colostate.edu) ->- [💾 GOES on AWS](https://registry.opendata.aws/noaa-goes/) ->- [🐍 Unidata Plot GOES Data](https://unidata.github.io/python-training/gallery/mapping_goes16_truecolor/) ->- [🗺 Plotting tips form geonetcast blog](https://geonetcast.wordpress.com/2019/08/02/plot-0-5-km-goes-r-full-disk-regions/) ->- [🐍 `glmtools`](https://github.com/deeplycloudy/glmtools/) - ---- - -> ### What if I don't like the goes2go package? -> As an alternative you can use [rclone](https://rclone.org/) to download GOES files from AWS. I quite like rclone. Here is a [short rclone tutorial](https://github.com/blaylockbk/pyBKB_v3/blob/master/rclone_howto.md). +# Capabilities -# Download Data -Download GOES 16 ABI (this example downloads the multichannel fixed grid product for CONUS) and read it with xarray. +## Download Data +Download GOES ABI or GLM NetCDF files to your local computer. Files can also be read with xarray. ```python from goes2go.data import goes_latest, goes_nearesttime # Get latest data -G1 = goes_latest(satellite='G16', product='ABI') +G_ABI = goes_latest(satellite='G16', product='ABI') # Get data for a specific time -G2 = goes_nearesttime(datetime(2020,10,1), satellite='G16', product='GLM') +G_GLM = goes_nearesttime('2021-01-01 12:00', satellite='G16', product='GLM') ``` -# RGB Recipes -For a GOES ABI multichannel xarray.Dataset, return an RGB array for an RGB product. See [DEMO](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_rgb_recipes.html#) for more examples of RGB products. +## RGB Recipes +The `rgb` xarray accessor creates an RGB product for a GOES ABI multichannel xarray.Dataset. See the [demo](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_rgb_recipes.html#) for more examples of RGB products. ```python from goes2go.data import goes_latest @@ -77,9 +57,9 @@ ax.coastlines() ![](./images/TrueColor.png) -# Field of View +## Field of View -Create shapely.Polygons for ABI and GLM field of view. See notebooks for [GLM](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM.html) and [ABI](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_ABI.html) field of view. +The `FOV` xarray accessor creates shapely.Polygon objects for the ABI and GLM field of view. See notebooks for [GLM](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM.html) and [ABI](https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_ABI.html) field of view. ```python from goes2go.data import goes_latest @@ -96,5 +76,33 @@ G.FOV.crs GOES-West is centered over -137 W and GOES-East is centered over -75 W. When GOES was being tested, it was in a "central" position, outlined in the dashed black line. Below is the ABI field of view for the full disk: ![field of view image](./images/ABI_field-of-view.png) -The GLM field of view is slightly smaller and limited by a bounding box. Below is the GLM field of view: +The GLM field of view is slightly smaller and limited by a bounding box. Below is the approximated GLM field of view: ![field of view image](./images/GLM_field-of-view.png) + + + +>### Useful Links +>- [🙋🏻‍♂️ Brian's AWS GOES Web Downloader](https://home.chpc.utah.edu/~u0553130/Brian_Blaylock/cgi-bin/goes16_download.cgi) +>- [📔 GOES-R Series Data Book](https://www.goes-r.gov/downloads/resources/documents/GOES-RSeriesDataBook.pdf) +>- [🎠 Beginner's Guide](https://www.goes-r.gov/downloads/resources/documents/Beginners_Guide_to_GOES-R_Series_Data.pdf) +>- [🖥 Rammb Slider GOES Viewer](https://rammb-slider.cira.colostate.edu) +>- [💾 GOES on AWS](https://registry.opendata.aws/noaa-goes/) +>- [🐍 Unidata Plot GOES Data](https://unidata.github.io/python-training/gallery/mapping_goes16_truecolor/) +>- [🗺 Plotting tips form geonetcast blog](https://geonetcast.wordpress.com/2019/08/02/plot-0-5-km-goes-r-full-disk-regions/) +>- [🐍 `glmtools`](https://github.com/deeplycloudy/glmtools/) +>- [🐍 `satpy`](https://github.com/pytroll/satpy) + + +> ### What if I don't like the GOES-2-go package? +> As an alternative you can use [rclone](https://rclone.org/) to download GOES files from AWS. I quite like rclone. Here is a [short rclone tutorial](https://github.com/blaylockbk/pyBKB_v3/blob/master/rclone_howto.md). + +--- +--- + +I hope you find this makes GOES data easier to retrieve and display. Enjoy! + +**Brian Blaylock** +[🌐 Personal Webpage](http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/home.html) + + +P.S. If you like GOES-2-go, check out my [Herbie](https://github.com/blaylockbk/Herbie) package to download weather model data and [SynopticPy](https://github.com/blaylockbk/Herbie) to download mesonet data from the Synoptic API. \ No newline at end of file