earthkit.data.mergers.xarray¶

Classes¶

`EKDEngine`	`BackendEntrypoint` is a class container and it is the main interface
`WrappedSource`

Functions¶

`infer_open_mfdataset_kwargs`([sources, paths, ...])
`merge`([sources, paths, reader_class])

Module Contents¶

class earthkit.data.mergers.xarray.EKDEngine¶

Bases: xarray.backends.common.BackendEntrypoint

BackendEntrypoint is a class container and it is the main interface for the backend plugins, see BackendEntrypoint subclassing. It shall implement:

open_dataset method: it shall implement reading from file, variables decoding and it returns an instance of Dataset. It shall take in input at least filename_or_obj argument and drop_variables keyword argument. For more details see open_dataset.
guess_can_open method: it shall return True if the backend is able to open filename_or_obj, False otherwise. The implementation of this method is not mandatory.
open_datatree method: it shall implement reading from file, variables decoding and it returns an instance of DataTree. It shall take in input at least filename_or_obj argument. The implementation of this method is not mandatory. For more details see <reference to open_datatree documentation>.

open_dataset_parameters¶

A list of open_dataset method parameters. The setting of this attribute is not mandatory.

Type:: tuple, default: None

description¶

A short string describing the engine. The setting of this attribute is not mandatory.

Type:: str, default: ""

url¶

A string with the URL to the backend’s documentation. The setting of this attribute is not mandatory.

Type:: str, default: ""

supports_groups¶

Whether the backend supports opening groups (via open_datatree and open_groups_as_dict) or not.

Type:: bool, default: False

description: ClassVar[str] = ''¶

guess_can_open(filename_or_obj)¶: Backend open_dataset method used by Xarray in open_dataset().

classmethod open_dataset(filename_or_obj, *args, **kwargs)¶: Backend open_dataset method used by Xarray in open_dataset().

open_dataset_parameters: ClassVar[tuple | None] = None¶

abstractmethod open_datatree(filename_or_obj, *, drop_variables=None)¶

Backend open_datatree method used by Xarray in open_datatree().

If implemented, set the class variable supports_groups to True.

abstractmethod open_groups_as_dict(filename_or_obj, *, drop_variables=None)¶

Opens a dictionary mapping from group names to Datasets.

Called by open_groups(). This function exists to provide a universal way to open all groups in a file, before applying any additional consistency checks or requirements necessary to create a DataTree object (typically done using from_dict()).

If implemented, set the class variable supports_groups to True.

supports_groups: ClassVar[bool] = False¶

url: ClassVar[str] = ''¶

class earthkit.data.mergers.xarray.WrappedSource(source)¶

source¶

earthkit.data.mergers.xarray.infer_open_mfdataset_kwargs(sources=None, paths=None, reader_class=None, user_kwargs={})¶

earthkit.data.mergers.xarray.merge(sources=None, paths=None, reader_class=None, **kwargs)¶