wrf.pw¶

wrf.pw(pres, tkel, qv, height, meta=True)¶

Return the precipitable water.

This is the raw computational algorithm and does not extract any variables from WRF output files. Use wrf.getvar() to both extract and compute diagnostic variables.

Parameters:

pres (xarray.DataArray or numpy.ndarray) –
Full pressure (perturbation + base state pressure) in [Pa], with the rightmost dimensions as bottom_top x south_north x west_east

Note

This variable must be supplied as a xarray.DataArray in order to copy the dimension names to the output. Otherwise, default names will be used.
tkel (xarray.DataArray or numpy.ndarray) – Temperature in [K] with the same dimensionality as pres.
qv (xarray.DataArray or numpy.ndarray) – Water vapor mixing ratio in [kg/kg] with the same dimensionality as pres
height (xarray.DataArray or numpy.ndarray) – Geopotential height in [m] with the same dimensionality as pres.
meta (bool) – Set to False to disable metadata and return numpy.ndarray instead of xarray.DataArray. Default is True.

Warning

The input arrays must not contain any missing/fill values or numpy.nan values.

Returns:	The precipitable water [kg m-2]. If xarray is enabled and the meta parameter is True, then the result will be an `xarray.DataArray` object. Otherwise, the result will be a `numpy.ndarray` object with no metadata.
Return type:	`xarray.DataArray` or `numpy.ndarray`