Skip to content

nesdis_edr_viirs

NESDIS EDR VIIRS Reader. Deprecated wrapper — use monetio.load('nesdis_edr_viirs', ...) instead.

open_dataset(date, resolution='high', datapath='.', **kwargs)

Open NESDIS EDR VIIRS gridded AOD data.

Parameters:

Name Type Description Default
date str or datetime - like

Date to retrieve.

 required
resolution str

Resolution ('high' for 0.1 degree, other for 0.25 degree).

 'high'
datapath str

Path to download/read data.

 '.'
**kwargs dict

Additional arguments forwarded to NESDISEDRVIIRSReader.open_dataset.

 {}

Returns:

Type Description
DataArray
Source code in monetio/sat/nesdis_edr_viirs.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
@deprecated_wrapper(
    "monetio.sat.nesdis_edr_viirs.open_dataset",
    'monetio.load("nesdis_edr_viirs", files=...)',
)
def open_dataset(date, resolution="high", datapath=".", **kwargs):
    """Open NESDIS EDR VIIRS gridded AOD data.

    Parameters
    ----------
    date : str or datetime-like
        Date to retrieve.
    resolution : str
        Resolution ('high' for 0.1 degree, other for 0.25 degree).
    datapath : str
        Path to download/read data.
    **kwargs : dict
        Additional arguments forwarded to ``NESDISEDRVIIRSReader.open_dataset``.

    Returns
    -------
    xarray.DataArray
    """
    return NESDISEDRVIIRSReader().open_dataset(
        dates=date, resolution=resolution, datapath=datapath, **kwargs
    )

open_mfdataset(dates, resolution='high', datapath='.', **kwargs)

Open multiple NESDIS EDR VIIRS gridded AOD files.

Parameters:

Name Type Description Default
dates sequence of datetime-like

Dates to retrieve.

 required
resolution str

Resolution ('high' for 0.1 degree, other for 0.25 degree).

 'high'
datapath str

Path to download/read data.

 '.'
**kwargs dict

Additional arguments forwarded to NESDISEDRVIIRSReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/sat/nesdis_edr_viirs.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@deprecated_wrapper(
    "monetio.sat.nesdis_edr_viirs.open_mfdataset",
    'monetio.load("nesdis_edr_viirs", files=...)',
)
def open_mfdataset(dates, resolution="high", datapath=".", **kwargs):
    """Open multiple NESDIS EDR VIIRS gridded AOD files.

    Parameters
    ----------
    dates : sequence of datetime-like
        Dates to retrieve.
    resolution : str
        Resolution ('high' for 0.1 degree, other for 0.25 degree).
    datapath : str
        Path to download/read data.
    **kwargs : dict
        Additional arguments forwarded to ``NESDISEDRVIIRSReader.open_dataset``.

    Returns
    -------
    xarray.Dataset
    """
    return NESDISEDRVIIRSReader().open_dataset(
        dates=dates, resolution=resolution, datapath=datapath, **kwargs
    )