Skip to content

data.JPSS

Global

Import path: earth2studio.data.JPSS

View source on GitHub

Documentation

JPSS VIIRS data source for NOAA-20, NOAA-21, and Suomi-NPP supporting both SDR (L1) and EDR (L2) products.

Parameters:

  • satellite (str, default: 'noaa-20' ) –

    One of {"noaa-20", "noaa-21", "snpp"}. Default "noaa-20".

  • product_type (str, default: 'I' ) –

    Product type: "I" for imagery bands (375m), "M" for moderate bands (750m), or "L2" for Level 2 EDR products (750m). Default "I".

  • max_workers (int, default: 24 ) –

    Maximum concurrent fetch tasks. Default 24.

  • cache (bool, default: True ) –

    Cache downloaded files under a deterministic hash. Default True.

  • verbose (bool, default: True ) –

    Show progress bars. Default True.

  • async_timeout (int, default: 600 ) –

    Timeout for async operations in seconds. Default 600.

Note

The returned data automatically includes '_lat' and '_lon' variables containing latitude and longitude coordinates for each pixel. These are appended to the last two dimensions of the data arrays variables as '_lat' and '_lon' variables.

For EDR (L2) products, not all products are available but generally include: - Land Surface Temperature, Surface Albedo, Snow Cover - Surface Reflectance, Active Fire Detection - Cloud properties (mask, phase, height, optical thickness) - Aerosol detection and Volcanic ash products

__call__ 

__call__(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Function to get 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 JPSS lexicon.

Returns:

  • DataArray –

    Data array containing the requested JPSS data

fetch async 

fetch(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
) -> DataArray

Async function to get 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 JPSS lexicon.

Returns:

  • DataArray –

    Data array containing the requested JPSS data

available classmethod 

available(
    time: datetime | datetime64,
    variable: str,
    satellite: str = "noaa-20",
    product_type: str = "I",
) -> bool

Checks if given date time is avaliable in JPSS

Parameters:

  • time (datetime | datetime64) –

    Date time to access

  • variable (str) –

    Variable to check

  • satellite (str, default: 'noaa-20' ) –

    Satellite to check

  • product_type (str, default: 'I' ) –

    Product type to check

Returns:

  • bool –

    If date time is avaiable