xarrayspecs.api module

class xarrayspecs.api.AsDataArray

Bases: object

Mixin class for Xarray DataArray specifications.

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → T

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → DataArray

Convert the Xarray specifications to an Xarray DataArray.

class xarrayspecs.api.AsDataTree

Bases: object

Mixin class for Xarray DataTree specifications.

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → T

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → DataTree

Convert the Xarray specifications to an Xarray DataTree.

class xarrayspecs.api.AsDataset

Bases: object

Mixin class for Xarray Dataset specifications.

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → T

classmethod new(*args: ~typing.~P, **kwargs: ~typing.~P) → Dataset

Convert the Xarray specifications to an Xarray Dataset.

xarrayspecs.api.asdataarray(obj: HasType[P, T], /) → T

xarrayspecs.api.asdataarray(obj: Other[P], /) → DataArray

Convert given Xarray specifications to an Xarray DataArray.

xarrayspecs.api.asdataset(obj: HasType[P, T], /) → T

xarrayspecs.api.asdataset(obj: Other[P], /) → Dataset

Convert given Xarray specifications to an Xarray Dataset.

xarrayspecs.api.asdatatree(obj: HasType[P, T], /) → T

xarrayspecs.api.asdatatree(obj: Other[P], /) → DataTree

Convert given Xarray specifications to an Xarray DataTree.