gfdlvitals.util.xrtools module

Tools for working with xarray datasets

gfdlvitals.util.xrtools.xr_mask_by_latitude(arr, geolat, region=None)

Masks an xarray object based on a latitude range

Parameters:

  • arr (xarray.DataArray or xarray.DataSet) – Input unmasked object

  • geolat (xarray.DataArray) – Data Array of latitude coordinates

  • region (str, optional) – Predefined region of “global”,”nh”,”sh”,”tropics”, by default None

Return type:

Masked xarray data object

gfdlvitals.util.xrtools.xr_to_db(dset, fyear, sqlfile)

Writes Xarray dataset to SQLite format

Parameters:

  • dset (xarray.DataSet) – Input dataset

  • fyear (str) – Year label (YYYY)

  • sqlfile (str) – Filename of output db file

gfdlvitals.util.xrtools.xr_weighted_avg(dset, weights)

Generates weighted space and time average of an xarray DataSet

Parameters:

  • dset (xarray.DataSet) – Input dataset

  • weights (xarray.DataArray or list) – Array to use for weights

Return type:

xarray DataSet containing weighted averages