wrf.g_cape.get_3dcape

wrf.g_cape.get_3dcape(wrfin, timeidx=0, method='cat', squeeze=True, cache=None, meta=True, _key=None, missing=9.969209968386869e+36)

Return the three-dimensional CAPE and CIN.

The leftmost dimension of the returned array represents two different quantities:

  • return_val[0,…] will contain CAPE [J kg-1]
  • return_val[1,…] will contain CIN [J kg-1]

This functions extracts the necessary variables from the NetCDF file object in order to perform the calculation.

Parameters:
  • wrfin (netCDF4.Dataset, Nio.NioFile, or an iterable) – WRF-ARW NetCDF data as a netCDF4.Dataset, Nio.NioFile or an iterable sequence of the aforementioned types.
  • timeidx (int or wrf.ALL_TIMES, optional) – The desired time index. This value can be a positive integer, negative integer, or wrf.ALL_TIMES (an alias for None) to return all times in the file or sequence. The default is 0.
  • method (str, optional) – The aggregation method to use for sequences. Must be either ‘cat’ or ‘join’. ‘cat’ combines the data along the Time dimension. ‘join’ creates a new dimension for the file index. The default is ‘cat’.
  • squeeze (bool, optional) – Set to False to prevent dimensions with a size of 1 from being automatically removed from the shape of the output. Default is True.
  • cache (dict, optional) – A dictionary of (varname, ndarray) that can be used to supply pre-extracted NetCDF variables to the computational routines. It is primarily used for internal purposes, but can also be used to improve performance by eliminating the need to repeatedly extract the same variables used in multiple diagnostics calculations, particularly when using large sequences of files. Default is None.
  • meta (bool, optional) – Set to False to disable metadata and return numpy.ndarray instead of xarray.DataArray. Default is True.
  • _key (int, optional) – A caching key. This is used for internal purposes only. Default is None.
  • missing (float) – The fill value to use for the output. Default is wrf.default_fill(np.float64).
Returns:

The CAPE and CIN as an array whose leftmost dimension is 2 (0=CAPE, 1=CIN). If xarray is enabled and the meta parameter is True, then the result will be a xarray.DataArray object. Otherwise, the result will be a numpy.ndarray object with no metadata.

Return type:

xarray.DataArray or numpy.ndarray