io

Utilities for reading gridded ICESat-2 files using rasterio and xarray

Source code

General Methods

IS2view.io.open_dataset(granule, group: str | None = None, format: str = 'nc', parallel: bool = True, **kwargs)

Reads and optionally merges gridded ICESat-2 files

Parameters:

granule: str or list

presigned url or path for granule(s) as a s3fs object

group: str or NoneType, default None

Data group to read

format: str, default ‘nc’

Data format to read

parallel: bool, default True

Open files in parallel using dask.delayed

kwargs: dict

Keyword arguments to pass to xarray reader

Returns:

ds: object

xarray dataset

IS2view.io.from_file(granule, group: str | None = None, format: str = 'nc', **kwargs)

Reads a gridded ICESat-2 file using rioxarray or xarray

Parameters:

granule: str

presigned url or path for granule

group: str or NoneType, default None

Data group to read

format: str, default ‘nc’

Data format to read

kwargs: dict

Keyword arguments to pass to xarray reader

Returns:

ds: object

xarray dataset

IS2view.io.from_rasterio(granule, group: str | None = None, **kwargs)

Reads a gridded ICESat-2 file using rioxarray

Parameters:

granule: str

presigned url or path for granule

group: str or NoneType, default None

Data group to read

kwargs: dict

Keyword arguments to pass to rioxarray

Returns:

ds: object

xarray dataset

IS2view.io.from_xarray(granule, group: str | None = None, engine: str = 'h5netcdf', **kwargs)

Reads a gridded ICESat-2 file using xarray

Parameters:

granule: str

presigned url or path for granule

group: str or NoneType, default None

Data group to read

engine: str, default ‘h5netcdf’

Engine to use when reading files

kwargs: dict

Keyword arguments to pass to xarray

Returns:

ds: object

xarray dataset