uxarray.UxDataset.from_healpix

uxarray.UxDataset.from_healpix#

classmethod UxDataset.from_healpix(ds, pixels_only=True, face_dim='cell', **kwargs)#

Loads a dataset represented in the HEALPix format into a ux.UxDataSet, paired with a Grid containing information about the HEALPix definition.

Parameters:
  • ds (str, os.PathLike, xr.Dataset) – Reference to a HEALPix Dataset

  • pixels_only (bool, optional) – Whether to only compute pixels (face_lon, face_lat) or to also construct boundaries (face_node_connectivity, node_lon, node_lat)

  • face_dim (str, optional) – Data dimension corresponding to the HEALPix face mapping. Typically, is set to “cell”, but may differ.

Returns:

A ux.UxDataset instance

Return type:

cls