Skip to content

chimere

Chimere Reader. Deprecated wrapper — use monetio.load('chimere', ...) instead.

open_mfdataset(files, var_list=None, surf_only=False, **kwargs)

Method to open Chimere model netcdf output files.

Parameters:

Name Type Description Default
files list[str]

files is a list of path(s) of the file(s).

required
var_list

list of variable names meant to be kept for the analysis.

None
surf_only

boolean flag specifying if only surface data (layer 0) should be kept for analysis.

False

Returns:

Type Description
Dataset

Chimere model dataset in standard format for use in MELODIES-MONET

Source code in monetio/models/chimere.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.models.chimere.open_mfdataset",
    'monetio.load("chimere", files=...)',
)
def open_mfdataset(files, var_list=None, surf_only=False, **kwargs):
    """Method to open Chimere model netcdf output files.

    Parameters
    ----------
    files : list[str]
        files is a list of path(s) of the file(s).
    var_list: list[str]
        list of variable names meant to be kept for the analysis.
    surf_only: bool
        boolean flag specifying if only surface data (layer 0) should be kept for analysis.

    Returns
    -------
    xarray.Dataset
        Chimere model dataset in standard format for use
        in MELODIES-MONET
    """
    return ChimereReader().open_dataset(
        files=files, var_list=var_list, surf_only=surf_only, **kwargs
    )