GOESArchive

class metpy.remote.GOESArchive(satellite)

Access data from the NOAA GOES archive in AWS.

This consists of individual GOES image files stored in netCDF format, across a variety of sectors, bands, and modes.

Initialize the archive client.

Parameters:

satellite (str or int) – The specific GOES satellite to access (e.g. 16, 17, 18).

Methods Summary

__init__(satellite)	Initialize the archive client.
common_prefixes(prefix[, delim])	Return the common prefixes under a given prefix.
dt_from_key(key)	Parse date from key.
get_product(product[, dt, mode, band])	Get a product from the archive.
get_range(product, start, end[, mode, band])	Yield products within a particular date/time range.
objects(prefix)	Return objects matching the given prefix.
product_ids()	Return product ids available.

Methods Documentation

__init__(satellite)

Initialize the archive client.

Parameters:

satellite (str or int) – The specific GOES satellite to access (e.g. 16, 17, 18).

common_prefixes(prefix, delim=None)

Return the common prefixes under a given prefix.

Parameters:

• prefix (str) – The starting prefix to look under for common prefixes.

• delim (str, optional) – The delimiter used to split the key into distinct portions. If not specified, defaults to the one initially set on the client.

dt_from_key(key)

Parse date from key.

Parameters:

key (str) – The key to parse

Returns:

datetime – The parsed date

get_product(product, dt=None, mode=None, band=None)

Get a product from the archive.

Parameters:

• product (str) – The site to search for data

• dt (datetime.datetime, optional) – The desired date/time for the model run; the one closest matching in time will be returned. This should have the proper timezone included; if not specified, UTC will be assumed. If None, defaults to the current UTC date/time.

• mode (str or int, optional) – The particular mode to select. If not given, the query will try to select an appropriate mode based on data available.

• band (str or int, optional) – The particular band (or channel) to select. Not all products have multiple bands. If not given, the query will try to select an appropriate band, but may error giving the channels available if multiple bands are available.

See also

product_ids, get_range

get_range(product, start, end, mode=None, band=None)

Yield products within a particular date/time range.

Parameters:

• product (str) – The site to search for data

• start (datetime.datetime) – The start of the date/time range. This should have the proper timezone included; if not specified, UTC will be assumed.

• end (datetime.datetime) – The end of the date/time range. This should have the proper timezone included; if not specified, UTC will be assumed.

• mode (str or int, optional) – The particular mode to select. If not given, the query will try to select an appropriate mode based on data available.

• band (str or int, optional) – The particular band (or channel) to select. Not all products have multiple bands. If not given, the query will try to select an appropriate band, but may error giving the channels available if multiple bands are available.

See also

product_ids, get_product

objects(prefix)

Return objects matching the given prefix.

Parameters:

prefix (str) – The prefix to match against.

Returns:

Iterator of botocore.client.Object – Objects matching the given prefix.

product_ids()

Return product ids available.

Returns:

List[str] – Product ids

Examples using metpy.remote.GOESArchive

Remote Data Access

Remote Data Access