gfdlvitals.util.netcdf module

Utilities for working with NetCDF files

gfdlvitals.util.netcdf.extract_from_tar(tar, member, ncfile=False)

Extract individual file from a tar file

Parameters:

  • tar (either tarfile object or path str) – Path to tar file

  • member (str) – Filename to extract from tar file

  • ncfile (bool, optional) – Convert to netCDF4.Dataset object, by default False

Returns:

either byte stram or netCDF4.Dataset

Return type:

in-memory object

gfdlvitals.util.netcdf.in_mem_nc(data)

Wrapper to convert bytes object to netCDF4.Dataset

Parameters:

data (byte stream object) – In-memory object

Returns:

In-memory netCDF4 dataset object

Return type:

netCDF4.Dataset

gfdlvitals.util.netcdf.in_mem_xr(data)

Wrapper to convert bytes object to xarray.Dataset

Parameters:

data (byte stream object) – In-memory object

Returns:

In-memory xarray dataset object

Return type:

xarray.Dataset

gfdlvitals.util.netcdf.tar_member_exists(tar, member)

Tests if file exsits inside a tar file

Parameters:

  • tar (tarfile object) – Opened tarfile handle

  • member (str) – Name of file inside tar file

Returns:

True if exists, otherwise False

Return type:

bool