Skip to content

icap_mme

ICAP-MME Reader. Deprecated wrapper — use monetio.load('icap_mme', ...) instead.

open_dataset(date, product='MMC', data_var='dustaod550', *, download=False, verbose=True, verify=True)

Open a single ICAP-MME dataset.

Parameters:

Name Type Description Default
date str or datetime - like

The date for which to open the dataset.

 required
product (MMC, C4, MME)
'MMC'
data_var {'modeaod550', 'dustaod550', 'pm', 'seasaltaod550',

'smokeaod550', 'totaldustaod550'}, optional

 'dustaod550'
download bool
False
verbose bool
True
verify bool
True

Returns:

Type Description
Dataset
Source code in monetio/models/icap_mme.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
32
33
34
35
36
37
38
39
40
41
42
@deprecated_wrapper(
    "monetio.models.icap_mme.open_dataset",
    'monetio.load("icap_mme", dates=...)',
)
def open_dataset(
    date,
    product="MMC",
    data_var="dustaod550",
    *,
    download=False,
    verbose=True,
    verify=True,
):
    """Open a single ICAP-MME dataset.

    Parameters
    ----------
    date : str or datetime-like
        The date for which to open the dataset.
    product : {'MMC', 'C4', 'MME'}, optional
    data_var : {'modeaod550', 'dustaod550', 'pm', 'seasaltaod550',
        'smokeaod550', 'totaldustaod550'}, optional
    download : bool, optional
    verbose : bool, optional
    verify : bool, optional

    Returns
    -------
    xarray.Dataset
    """
    return ICAPMMEReader().open_dataset(
        dates=date,
        product=product,
        data_var=data_var,
        download=download,
    )

open_mfdataset(dates, product='MMC', data_var='dustaod550', *, download=False, verbose=True, verify=True)

Open multiple ICAP-MME datasets.

Parameters:

Name Type Description Default
dates iterable of datetime-like

The dates for which to open the dataset.

 required
product (MMC, C4, MME)
'MMC'
data_var {'modeaod550', 'dustaod550', 'pm', 'seasaltaod550',

'smokeaod550', 'totaldustaod550'}, optional

 'dustaod550'
download bool
False
verbose bool
True
verify bool
True

Returns:

Type Description
Dataset
Source code in monetio/models/icap_mme.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@deprecated_wrapper(
    "monetio.models.icap_mme.open_mfdataset",
    'monetio.load("icap_mme", dates=...)',
)
def open_mfdataset(
    dates,
    product="MMC",
    data_var="dustaod550",
    *,
    download=False,
    verbose=True,
    verify=True,
):
    """Open multiple ICAP-MME datasets.

    Parameters
    ----------
    dates : iterable of datetime-like
        The dates for which to open the dataset.
    product : {'MMC', 'C4', 'MME'}, optional
    data_var : {'modeaod550', 'dustaod550', 'pm', 'seasaltaod550',
        'smokeaod550', 'totaldustaod550'}, optional
    download : bool, optional
    verbose : bool, optional
    verify : bool, optional

    Returns
    -------
    xarray.Dataset
    """
    return ICAPMMEReader().open_dataset(
        dates=dates,
        product=product,
        data_var=data_var,
        download=download,
    )