Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

goes2go

Download and process GOES-16 and GOES-17 data from NOAA's archive on AWS using Python.
https://github.com/blaylockbk/goes2go

big-data-program download glm goes goes-16 goes-17 goes-satellite netcdf noaa-satellite open-data python satellite satellite-data satellite-imagery xarray

Last synced: about 5 hours ago
JSON representation

Repository metadata

Download and process GOES-16 and GOES-17 data from NOAA's archive on AWS using Python.

README

        

![](https://github.com/blaylockbk/goes2go/blob/main/docs/_static/goes2go_logo_100dpi.png?raw=true)

# Download and display GOES-East and GOES-West data

[![](https://img.shields.io/pypi/v/goes2go)](https://pypi.python.org/pypi/goes2go/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/goes2go.svg)](https://anaconday.org/conda-forge/goes2go)
[![DOI](https://zenodo.org/badge/296737878.svg)](https://zenodo.org/badge/latestdoi/296737878)

![](https://img.shields.io/github/license/blaylockbk/goes2go)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Tests (Python)](https://github.com/blaylockbk/goes2go/actions/workflows/tests-python.yml/badge.svg)](https://github.com/blaylockbk/goes2go/actions/workflows/tests-python.yml)
[![Documentation Status](https://readthedocs.org/projects/goes2go/badge/?version=latest)](https://goes2go.readthedocs.io/?badge=latest)
[![Python](https://img.shields.io/pypi/pyversions/goes2go.svg)](https://pypi.org/project/goes2go/)
[![Conda Recipe](https://img.shields.io/badge/recipe-goes2go-green.svg)](https://anaconda.org/conda-forge/goes2go)
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/goes2go.svg)](https://anaconda.org/conda-forge/goes2go)
[![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/goes2go.svg)](https://anaconda.org/conda-forge/goes2go)

GOES-East and GOES-West satellite data are made available on Amazon Web Services through [NOAA's Open Data Dissemination Program](https://www.noaa.gov/information-technology/open-data-dissemination). **GOES-2-go** is a python package that makes it easy to find and download the files you want from [AWS](https://registry.opendata.aws/noaa-goes/) to your local computer with some additional helpers to visualize and understand the data.



# 📔 [GOES-2-go Documentation](https://goes2go.readthedocs.io/)



# Installation

The easiest way to install `goes2go` and its dependencies is with [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) from conda-forge.

```
conda install -c conda-forge goes2go
```

You may also create the provided Conda environment, **[`environment.yml`](https://github.com/blaylockbk/goes2go/blob/main/environment.yml)**.

```bash
# Download environment file
wget https://github.com/blaylockbk/goes2go/raw/main/environment.yml

# Modify that file if you wish.

# Create the environment
conda env create -f environment.yml

# Activate the environment
conda activate goes2go
```

Alternatively, `goes2go` is published on PyPI and you can install it with pip, _but_ it requires some additional dependencies that you will have to install yourself:

- Python 3.8+
- [Cartopy](https://scitools.org.uk/cartopy/docs/latest/installing.html), which requires GEOS and Proj (if using `cartopy<0.22.0`).
- MetPy
- _Optional:_ [Carpenter Workshop](https://github.com/blaylockbk/Carpenter_Workshop)

When those are installed within your environment, _then_ you can install GOES-2-go with pip.

```bash
# Latest published version
pip install goes2go

# ~~ or ~~

# Most recent changes
pip install git+https://github.com/blaylockbk/goes2go.git
```

# Capabilities

- [Download GOES Data](#download-data)
- [Create RGB composites](#rgb-recipes)
- [Get the field of view](#field-of-view)

```mermaid
graph TD;
aws16[(AWS\nnoaa-goes16)] -.-> G
aws17[(AWS\nnoaa-goes17)] -.-> G
aws18[(AWS\nnoaa-goes18)] -.-> G
G((. GOES 2-go .))
G --- .latest
G --- .nearesttime
G --- .timerange
.latest --> ds[(xarray.DataSet)]
.nearesttime --> ds[(xarray.DataSet)]
.timerange --> ds[(xarray.DataSet)]
ds --- rgb[ds.rgb\naccessor to make RGB composites]
ds --- fov[ds.FOV\naccessor to get field-of-view polygons]

style G fill:#F8AF22,stroke:#259DD7,stroke-width:4px,color:#000000
```

## Download Data

Download GOES ABI or GLM NetCDF files to your local computer. Files can also be read with xarray.

First, create a GOES object to specify the satellite, data product, and domain you are interested in. The example below downloads the Multi-Channel Cloud Moisture Imagery for CONUS.

```python
from goes2go import GOES

# ABI Multi-Channel Cloud Moisture Imagry Product
G = GOES(satellite=16, product="ABI-L2-MCMIP", domain='C')

# Geostationary Lightning Mapper
G = GOES(satellite=17, product="GLM-L2-LCFA", domain='C')

# ABI Level 1b Data
G = GOES(satellite=17, product="ABI-L1b-Rad", domain='F')
```

> A complete listing of the products available are available [here](https://github.com/blaylockbk/goes2go/blob/main/goes2go/product_table.txt).

There are methods to do the following:

- List the available files for a time range
- Download data to your local drive for a specified time range
- Read the data into an xarray Dataset for a specific time

```python
# Produce a pandas DataFrame of the available files in a time range
df = G.df(start='2022-07-04 01:00', end='2022-07-04 01:30')
```

```python
# Download and read the data as an xarray Dataset nearest a specific time
ds = G.nearesttime('2022-01-01')
```

```python
# Download and read the latest data as an xarray Dataset
ds = G.latest()
```

```python
# Download data for a specified time range
G.timerange(start='2022-06-01 00:00', end='2022-06-01 01:00')

# Download recent data for a specific interval
G.timerange(recent='30min')
```

## RGB Recipes

The `rgb` xarray accessor computes various RGB products from a GOES ABI **_ABI-L2-MCMIP_** (multi-channel cloud and moisture imagry products) `xarray.Dataset`. See the [demo](https://goes2go.readthedocs.io/en/latest/user_guide/notebooks/DEMO_rgb_recipes.html#) for more examples of RGB products.

```python
import matplotlib.pyplot as plt
ds = GOES().latest()
ax = plt.subplot(projection=ds.rgb.crs)
ax.imshow(ds.rgb.TrueColor(), **ds.rgb.imshow_kwargs)
ax.coastlines()
```

![](./images/TrueColor.png)

## Field of View

The `FOV` xarray accessor creates `shapely.Polygon` objects for the ABI and GLM field of view. See notebooks for [GLM](https://goes2go.readthedocs.io/en/latest/user_guide/notebooks/field-of-view_GLM.html) and [ABI](https://goes2go.readthedocs.io/en/latest/user_guide/notebooks/field-of-view_ABI.html) field of view.

```python
from goes2go.data import goes_latest
G = goes_latest()
# Get polygons of the full disk or ABI domain field of view.
G.FOV.full_disk
G.FOV.domain
# Get Cartopy coordinate reference system
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 approximated GLM field of view:
![field of view image](./images/GLM_field-of-view.png)

# How to Cite and Acknowledge

If GOES-2-go played an important role in your work, please [tell me about it](https://github.com/blaylockbk/goes2go/discussions/categories/show-and-tell)! Also, consider including a citation or acknowledgement in your article or product.

**_Suggested Citation_**

> Blaylock, B. K. (2023). GOES-2-go: Download and display GOES-East and GOES-West data (Version 2022.07.15) [Computer software]. https://github.com/blaylockbk/goes2go

**_Suggested Acknowledgment_**

> A portion of this work used code generously provided by Brian Blaylock's GOES-2-go python package (https://github.com/blaylockbk/goes2go)

### What if I don't like the GOES-2-go or Python?

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

👨🏻‍💻 [Contributing Guidelines](https://goes2go.readthedocs.io/en/latest/user_guide/contribute.html)
💬 [GitHub Discussions](https://github.com/blaylockbk/goes2go/discussions)
🚑 [GitHub Issues](https://github.com/blaylockbk/goes2go/issues)
🌐 [Personal Webpage](http://home.chpc.utah.edu/~u0553130/Brian_Blaylock/home.html)

P.S. If you like GOES-2-go, check out my other python packages

- [🏁 Herbie](https://github.com/blaylockbk/Herbie): download numerical weather model data
- [🌡️ SynopticPy](https://github.com/blaylockbk/SynopticPy): retrieve mesonet data from the Synoptic API.
- [🌹 Pandas-rose](https://github.com/blaylockbk/pandas-rose): easly wind rose from Pandas dataframe.

# Related Content

- [🙋🏻‍♂️ 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)
- [🖥 CSPPGEO](http://cimss.ssec.wisc.edu/csppgeo/) | [Gridded GLM software package](https://download.ssec.wisc.edu/files/csppgeo/)

Citation (CITATION.cff)

cff-version: 1.2.0
abstract: GOES-East and GOES-West satellite data are made available on Amazon Web Services through the NOAA Open Data Dissemination (NODD) Program (formerly the Big Data Program). 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.
message: "If you use this software, please cite it as below."
authors:
  - family-names: Blaylock
    given-names: Brian K.
    email: [email protected]
    orcid: "https://orcid.org/0000-0003-2133-9313"
title: "GOES-2-go: Download and display GOES-East and GOES-West data"
version: 2023.04.0
date-released: "2023-04-10"
url: "https://goes2go.readthedocs.io/"
repository-code: "https://github.com/blaylockbk/goes2go"
type: software
keywords:
  - meteorology
  - weather
  - atmosphere
  - satellite
license: "MIT"
identifiers:
  - type: doi
    value: 10.5281/zenodo.4567558

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 330
Total Committers: 8
Avg Commits per committer: 41.25
Development Distribution Score (DDS): 0.13

Commits in past year: 33
Committers in past year: 3
Avg Commits per committer in past year: 11.0
Development Distribution Score (DDS) in past year: 0.091

Name Email Commits
Brian Blaylock b****k@g****m 287
Brian Blaylock b****k 33
Brian Blaylock b****r@n****l 4
Bryan Guarente 3****e 2
Brian Blaylock b****k@u****u 1
Oli McCormack o****i@t****o 1
Filipe Fernandes o****f@g****m 1
The Gitter Badger b****r@g****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 51
Total pull requests: 13
Average time to close issues: 23 days
Average time to close pull requests: about 12 hours
Total issue authors: 30
Total pull request authors: 5
Average comments per issue: 1.31
Average comments per pull request: 0.85
Merged pull request: 13
Bot issues: 0
Bot pull requests: 0

Past year issues: 18
Past year pull requests: 5
Past year average time to close issues: 4 days
Past year average time to close pull requests: about 10 hours
Past year issue authors: 11
Past year pull request authors: 2
Past year average comments per issue: 1.11
Past year average comments per pull request: 1.4
Past year merged pull request: 5
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/blaylockbk/goes2go

Top Issue Authors

  • blaylockbk (18)
  • csteele2 (3)
  • thomasdewitt (2)
  • EmanuelCastanho (2)
  • jimmycrackc0rn7 (1)
  • jjm0022 (1)
  • john-a-m (1)
  • mjstarke (1)
  • muyiaaaa (1)
  • najiya-12 (1)
  • nrchade (1)
  • ocefpaf (1)
  • olimcc (1)
  • scottthomaswx (1)
  • simeks (1)

Top Pull Request Authors

  • blaylockbk (8)
  • bryanguarente (2)
  • gitter-badger (1)
  • ocefpaf (1)
  • olimcc (1)

Top Issue Labels

  • help wanted (4)
  • bug (3)
  • install (3)
  • need more info (1)
  • enhancement (1)
  • documentation (1)

Top Pull Request Labels


Package metadata

pypi.org: goes2go

Retrieve GOES Satellite data from AWS. Also proves some RGB recipes.

  • Homepage: https://github.com/blaylockbk/goes2go
  • Documentation: https://goes2go.readthedocs.io/
  • Licenses: MIT License Copyright (c) 2019-2022 Brian Blaylock Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 2024.4.0 (published about 1 month ago)
  • Last Synced: 2024-05-10T09:05:39.129Z (1 day ago)
  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 597 Last month
  • Docker Downloads: 27
  • Rankings:
    • Stargazers count: 6.072%
    • Dependent packages count: 7.373%
    • Forks count: 7.818%
    • Average: 11.108%
    • Downloads: 12.043%
    • Dependent repos count: 22.233%
  • Maintainers (1)
conda-forge.org: goes2go

GOES-East and GOES-West satellite data are made available on Amazon Web Services through NOAA's Big Data Program. `goes2go` is a python package that makes it easy to find and download the files you need to your local computer. Some additional helpers are provided that make working with GOES data easy and fun, such as recipes for RGB composites.

  • Homepage: https://github.com/blaylockbk/goes2go
  • Licenses: MIT
  • Latest release: 2022.10.0 (published over 1 year ago)
  • Last Synced: 2024-05-10T09:05:43.303Z (1 day ago)
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent repos count: 9.315%
    • Average: 33.146%
    • Stargazers count: 33.683%
    • Forks count: 37.186%
    • Dependent packages count: 52.399%

Dependencies

.github/workflows/release_to_pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/tests-python.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • cartopy >=0.22.0
  • h5netcdf *
  • matplotlib *
  • metpy *
  • numpy *
  • pandas *
  • s3fs >=2023.6.0
  • toml *
  • xarray *
requirements-test.txt pypi
  • pytest <8 test
requirements.txt pypi
  • cartopy >=0.22.0
  • h5netcdf *
  • matplotlib *
  • metpy *
  • numpy *
  • pandas *
  • s3fs >=2023.6.0
  • toml *
  • xarray *
environment.yml conda
  • black
  • black-jupyter
  • cartopy
  • geopandas
  • git
  • goes2go
  • h5netcdf
  • isort
  • jupyter
  • jupyterlab
  • matplotlib
  • metpy
  • netcdf4
  • numpy
  • pandas
  • pip
  • pytest
  • python >=3.11
  • rclone >=1.58.0
  • ruff
  • s3fs >=2023.6.0
  • toml
  • xarray

Score: 13.718885113578583