Skip to content

omps_nadir

OMPS Nadir Reader. Deprecated wrapper — use monetio.load('omps_nadir', ...) instead.

extract_OMPS_nm(fname, **kwargs)

Read locally stored OMPS Nadir Mapper L2 file.

Parameters:

Name Type Description Default
fname str

Local path to h5 file.

 required
**kwargs dict

Additional arguments forwarded to OMPSNadirReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/sat/omps_nadir.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@deprecated_wrapper(
    "monetio.sat.omps_nadir.extract_OMPS_nm",
    'monetio.load("omps_nadir", files=...)',
)
def extract_OMPS_nm(fname, **kwargs):
    """Read locally stored OMPS Nadir Mapper L2 file.

    Parameters
    ----------
    fname : str
        Local path to h5 file.
    **kwargs : dict
        Additional arguments forwarded to ``OMPSNadirReader.open_dataset``.

    Returns
    -------
    xarray.Dataset
    """
    return OMPSNadirReader().open_dataset(files=fname, **kwargs)

extract_OMPS_nm_opendap(fname, **kwargs)

Read OMPS Nadir Mapper L2 data from OPeNDAP.

Parameters:

Name Type Description Default
fname str

URL location of h5 file.

 required
**kwargs dict

Additional arguments forwarded to OMPSNadirReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/sat/omps_nadir.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@deprecated_wrapper(
    "monetio.sat.omps_nadir.extract_OMPS_nm_opendap",
    'monetio.load("omps_nadir", files=...)',
)
def extract_OMPS_nm_opendap(fname, **kwargs):
    """Read OMPS Nadir Mapper L2 data from OPeNDAP.

    Parameters
    ----------
    fname : str
        URL location of h5 file.
    **kwargs : dict
        Additional arguments forwarded to ``OMPSNadirReader.open_dataset``.

    Returns
    -------
    xarray.Dataset
    """
    return OMPSNadirReader().open_dataset(files=fname, **kwargs)

read_OMPS_nm(files, **kwargs)

Loop to open OMPS nadir mapper L2 files.

Parameters:

Name Type Description Default
files str or list of str

Input file paths or URLs.

 required
**kwargs dict

Additional arguments forwarded to OMPSNadirReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/sat/omps_nadir.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@deprecated_wrapper(
    "monetio.sat.omps_nadir.read_OMPS_nm",
    'monetio.load("omps_nadir", files=...)',
)
def read_OMPS_nm(files, **kwargs):
    """Loop to open OMPS nadir mapper L2 files.

    Parameters
    ----------
    files : str or list of str
        Input file paths or URLs.
    **kwargs : dict
        Additional arguments forwarded to ``OMPSNadirReader.open_dataset``.

    Returns
    -------
    xarray.Dataset
    """
    return OMPSNadirReader().open_dataset(files=files, **kwargs)