xbout.xarraybackend.BoutAdiosBackendEntrypoint

class xbout.xarraybackend.BoutAdiosBackendEntrypoint

Bases: BackendEntrypoint

xarray backend entrypoint for ADIOS2 .bp datasets.

For more information about the underlying library, visit: https://adios2.readthedocs.io/en/stable

See also

backends.AdiosStore

__init__()

Methods

__init__()
close()	Close the underlying ADIOS2 file handle, if one is open.
guess_can_open(filename_or_obj)	Return True if this backend can open the provided filename.
open_dataset(filename_or_obj, *[, ...])	Open an ADIOS2 .bp file/folder as an xarray 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
open_dataset_parameters
supports_groups
url

close()

Close the underlying ADIOS2 file handle, if one is open.

Return type:

None

description: ClassVar[str] = 'Open ADIOS2 files/folders (.bp) using adios2 in Xarray'

guess_can_open(filename_or_obj)

Return True if this backend can open the provided filename.

Return type:

bool

Parameters:

filename_or_obj (str | os.PathLike[Any] | BufferedIOBase | AbstractDataStore)

open_dataset(filename_or_obj, *, drop_variables=None)

Open an ADIOS2 .bp file/folder as an xarray Dataset.

Parameters:

• filename_or_obj (str | os.PathLike[Any] | BufferedIOBase | AbstractDataStore) – Path to a .bp dataset (directory or file, depending on ADIOS2 engine).

• drop_variables (str | Iterable[str] | None) – Optional variable name or iterable of variable names to exclude.

Return type:

Dataset

url: ClassVar[str] = 'https://docs.xarray.dev/en/stable/generated/xarray.backends.ZarrBackendEntrypoint.html'