📦 Welcome to GPM-API

Deployment
Activity
Python Versions
Supported Systems
Project Status
Build Status
Linting
Code Coverage
Code Quality
License
Community
Citation

Slack | Docs

🚀 Quick start

GPM-API provides an easy-to-use python interface to download, read, process and visualize most of the products of the Global Precipitation Measurement Mission (GPM) data archive.

The list of available products can be retrieved using:

import gpm

gpm.available_products(product_types="RS")  # research products
gpm.available_products(product_types="NRT") # near-real-time products

Before starting using GPM-API, we highly suggest to save into a configuration file:

1. your credentials to access the NASA Precipitation Processing System (PPS) servers
2. the directory on the local disk where to save the GPM dataset of interest.

To facilitate the creation of the configuration file, you can run the following script:

import gpm

username_pps = "<your PPS username>" # likely your mail
password_pps = "<your PPS password>" # likely your mail
base_dir = "<path/to/directory/GPM"  # path to the directory where to download the data
gpm.define_configs(username_pps=username_pps,
                   password_pps=password_pps,
                   base_dir=base_dir)

# You can check that the config file has been correctly created with:
configs = gpm.read_configs()
print(configs)

📥 Download GPM data

Now you can either start to download GPM data within python:

import gpm
import datetime

product = "2A-DPR"
product_type = "RS"
version = 7

start_time = datetime.datetime(2020,7, 22, 0, 1, 11)
end_time = datetime.datetime(2020,7, 22, 0, 23, 5)

gpm.download(product=product,
             product_type=product_type,
             version=version,
             n_threads=2,
             start_time=start_time,
             end_time=end_time)

or from the terminal using i.e. download_daily_gpm_data <product> <year> <month> <day>:

download_daily_gpm_data 2A-DPR 2022 7 22

💫 Open GPM files into xarray

A GPM granule can be opened in python using:

import gpm

ds = gpm.open_granule(<path_to_granule>)

while multiple granules over a specific time period can be opened using:

import gpm
import datetime

product = "2A-DPR"
product_type = "RS"
version = 7

start_time = datetime.datetime(2020,7, 22, 0, 1, 11)
end_time = datetime.datetime(2020,7, 22, 0, 23, 5)
ds = gpm.open_dataset(product=product,
                      product_type=product_type,
                      version=version
                      start_time=start_time,
                      end_time=end_time)

📖 Explore the GPM-API documentation

To discover all GPM-API download, manipulation, analysis and plotting utilities, or how to contribute your custom retrieval to GPM-API:

• please read the software documentation available at https://gpm-api.readthedocs.io/en/latest/.
• dive into the Jupyter Notebooks Tutorials.

🛠️ Installation

conda

GPM-API can be installed via conda on Linux, Mac, and Windows. Install the package by typing the following command in the terminal:

conda install gpm-api

In case conda-forge is not set up for your system yet, see the easy to follow instructions on conda-forge.

pip

GPM-API can be installed also via pip on Linux, Mac, and Windows. On Windows you can install WinPython to get Python and pip running. Prior installation of GPM-API, try to install to cartopy>=0.21.0 package to ensure there are not GEOS library version incompatibilities. If you can't solve the problems and install cartopy with pip, you should install at least cartopy with conda using conda install cartopy>=0.21.0.

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

pip install gpm-api

To install the latest development version via pip, see the documentation.

💭 Feedback and Contributing Guidelines

If you aim to contribute your data or discuss the future development of GPM-API, we highly suggest to join the GPM-API Slack Workspace

Feel free to also open a GitHub Issue or a GitHub Discussion specific to your questions or ideas.

Citation

If you are using GPM-API in your publication please cite our Zenodo repository:

Ghiggi Gionata. ghiggi/gpm_api. Zenodo.

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

License

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

Tutorials

The documentation also includes some [tutorials][tut_link], showing the most important use cases of GPM-API. These tutorial are also available as Jupyter Notebooks and in Google Colab:

• 1. Download the GPM products [Notebook][Colab]
• 2. Introduction to the IMERG products [Notebook][Colab]
• 2. Introduction to the PMW 1B and 1C products [Notebook][Colab]
• 2. Introduction to the PMW 2A products [Notebook][Colab]
• 2. Introduction to the RADAR 2A products [Notebook][Colab]
• 2. Introduction to the CORRA 2B products [Notebook][Colab]
• 2. Introduction to the Latent Heating products [Notebook][Colab]
• 2. Introduction to the ENVironment products [Notebook][Colab]
• 3. Introduction to image labeling and patch extraction [Notebook][Colab]
• 3. Introduction to image patch extraction [Notebook][Colab]

The associated python scripts are also provided in the tutorial folder.

Requirements:

• xarray
• dask
• cartopy
• pycolorbar
• h5py
• curl

Optional

• zarr
• ximage
• pyresample
• pyvista
• wget