earth2studio.data.IMERG#
- class earth2studio.data.IMERG(auth=None, cache=True, verbose=True)[source]#
The Integrated Multi-satellitE Retrievals (IMERG) for GPM. IMERG is a NASA product that estimates the global surface precipitation rates at a high resolution of 0.1 degree every half-hour beginning in 2000. Provides total (m/hr), probability and index precipitation fields for the past half hour.
Note
This data source requires users to register for NASA’s Earthdata portal: https://urs.earthdata.nasa.gov/. Users must supply their username and password for AuthN when using this data source. Users should be sure “NASA GESDISC DATA ARCHIVE” is an approved application on their profile: https://urs.earthdata.nasa.gov/profile
- Parameters:
auth (aiohttp.BasicAuth | None) – BasicAuth object with user’s EarthData username and password for basic HTTP authentication. If none is provided, one will be constructed using the EARTHDATA_USERNAME and EARTHDATA_PASSWORD environment variables, by default None
cache (bool, optional) – Cache data source on local memory, by default True
verbose (bool, optional) – Print download progress, by default True
Warning
This is a remote data source and can potentially download a large amount of data to your local machine for large requests.
Note
Additional information on the data repository can be referenced here:
- __call__(time, variable)[source]#
Retrieve IMERG data
- Parameters:
time (datetime | list[datetime] | TimeArray) – Timestamps to return data for (UTC).
variable (str | list[str] | VariableArray) – String, list of strings or array of strings that refer to variables to return. Must be in the IMERG lexicon.
- Returns:
IMERG data array
- Return type:
xr.DataArray