Skip to content

raqms

RAQMS Reader. Deprecated wrapper — use monetio.load('raqms', ...) instead.

open_dataset(fname, **kwargs)

Open a single dataset from RAQMS output. Currently expects netCDF file format.

Parameters:

Name Type Description Default
fname str

File to be opened.

 required
**kwargs dict

Additional arguments passed to RAQMSReader.open_dataset

 {}

Returns:

Type Description
Dataset
Source code in monetio/models/raqms.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@deprecated_wrapper(
    "monetio.models.raqms.open_dataset",
    'monetio.load("raqms", files=...)',
)
def open_dataset(fname, **kwargs):
    """Open a single dataset from RAQMS output. Currently expects netCDF file format.

    Parameters
    ----------
    fname : str
        File to be opened.
    **kwargs : dict
        Additional arguments passed to RAQMSReader.open_dataset

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

open_mfdataset(fname, **kwargs)

Open a multiple file dataset from RAQMS output.

Parameters:

Name Type Description Default
fname str or list of str

Files to be opened, expressed as a glob string or list of string paths.

 required
**kwargs dict

Additional arguments passed to RAQMSReader.open_dataset

 {}

Returns:

Type Description
Dataset
Source code in monetio/models/raqms.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
@deprecated_wrapper(
    "monetio.models.raqms.open_mfdataset",
    'monetio.load("raqms", files=...)',
)
def open_mfdataset(fname, **kwargs):
    """Open a multiple file dataset from RAQMS output.

    Parameters
    ----------
    fname : str or list of str
        Files to be opened, expressed as a glob string or list of string paths.
    **kwargs : dict
        Additional arguments passed to RAQMSReader.open_dataset

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