sdf_xarray.SDFEntrypoint#

class sdf_xarray.SDFEntrypoint[source]#

Bases: BackendEntrypoint

__init__()#

Methods

__init__()

guess_can_open(filename_or_obj)

Backend open_dataset method used by Xarray in open_dataset().

open_dataset(filename_or_obj, *[, ...])

Backend open_dataset method used by Xarray in open_dataset().

open_datatree(filename_or_obj, *[, ...])

Backend open_datatree method used by Xarray in open_datatree().

open_groups_as_dict(filename_or_obj, *[, ...])

Opens a dictionary mapping from group names to Datasets.

Attributes

description: ClassVar[str] = 'Use .sdf files in Xarray'#
guess_can_open(filename_or_obj)[source]#

Backend open_dataset method used by Xarray in open_dataset().

open_dataset(filename_or_obj, *, drop_variables=None, keep_particles=False, probe_names=None, deck_path=None)[source]#

Backend open_dataset method used by Xarray in open_dataset().

open_dataset_parameters: ClassVar[list[str]] = ['filename_or_obj', 'drop_variables', 'keep_particles', 'probe_names', 'deck_path']#
open_datatree(filename_or_obj, *, drop_variables=None, keep_particles=False, probe_names=None, deck_path=None)[source]#

Backend open_datatree method used by Xarray in open_datatree().

If implemented, set the class variable supports_groups to True.

open_datatree_parameters: ClassVar[list[str]] = ['filename_or_obj', 'drop_variables', 'keep_particles', 'probe_names', 'deck_path']#
supports_groups: ClassVar[bool] = True#
url: ClassVar[str] = 'https://epochpic.github.io/documentation/visualising_output/python_beam.html'#