goes-api

Welcome to GOES API - An API to download and search for GOES satellite data.

The GOES-API is still in development. Feel free to try it out and to report issues or to suggest changes.

Quickstart

The code in this repository provides an API to download, query and filter GOES16 and GOES17 satellite data.

Data download and query/filtering is available:

• for local file systems, Google Cloud Storage and AWS S3.
• for sensors ABI, EXIS, GLM, MAG, SEIS and SUVI.

The folder tutorials provide the following jupyter notebooks, describing various features of GOES_API:

• Downloading GOES data: download.ipynb
• Find and filter GOES data: find_and_filter.ipynb
• Read data directly from AWS S3 and GCS buckets: read_bucket_data.ipynb
• Read ABI L1B and L2B products from cloud buckets and plot it with satpy: read_bucket_data_with_satpy.ipynb
• Extract zarr reference files using kerchunk: kerchunk_data.ipynb

The folder docs contains documents with various information related to GOES data products.

Documentation is available at XXXXX

Installation

pip

GOES-API can be installed via pip on Linux, Mac, and Windows. On Windows you can install WinPython to get Python and pip running.

Then, install the GOES-API package by typing the following command in the command terminal:

pip install goes_api

Citation

If you are using GOES-API, please cite:

Ghiggi Gionata. ghiggi/goes_api. Zenodo. https://doi.org/10.5281/zenodo.7787851

If you want to cite a specific version, have a look at the Zenodo site.

Contributors

• Gionata Ghiggi

License

The content of this repository is released under the terms of the MIT license.