Skip to content

tolnet

TOLNet Profile Reader. Deprecated wrapper — use monetio.load('tolnet', ...) instead.

Visualization helpers tolnet_colormap and tolnet_plot are not deprecated and remain available here.

open_dataset(fname, **kwargs)

Open a single TOLNet HDF5 file.

Parameters:

Name Type Description Default
fname str

Path to the TOLNet HDF5 file.

 required
**kwargs dict

Additional arguments forwarded to TOLNetReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/profile/tolnet.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@deprecated_wrapper(
    "monetio.profile.tolnet.open_dataset",
    'monetio.load("tolnet", files=...)',
)
def open_dataset(fname, **kwargs):
    """Open a single TOLNet HDF5 file.

    Parameters
    ----------
    fname : str
        Path to the TOLNet HDF5 file.
    **kwargs : dict
        Additional arguments forwarded to ``TOLNetReader.open_dataset``.

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

open_mfdataset(fname, **kwargs)

Open multiple TOLNet HDF5 files (glob pattern supported).

Parameters:

Name Type Description Default
fname str

Glob pattern or path to TOLNet HDF5 files.

 required
**kwargs dict

Additional arguments forwarded to TOLNetReader.open_dataset.

 {}

Returns:

Type Description
Dataset
Source code in monetio/profile/tolnet.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@deprecated_wrapper(
    "monetio.profile.tolnet.open_mfdataset",
    'monetio.load("tolnet", files=...)',
)
def open_mfdataset(fname, **kwargs):
    """Open multiple TOLNet HDF5 files (glob pattern supported).

    Parameters
    ----------
    fname : str
        Glob pattern or path to TOLNet HDF5 files.
    **kwargs : dict
        Additional arguments forwarded to ``TOLNetReader.open_dataset``.

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