tams.run

Contents

tams.run#

tams.run(ds, *, parallel=True, u_projection=0, ctt_threshold=235, ctt_core_threshold=219)#

Run all TAMS steps, including precip assignment.

Important

ds must have 'ctt' (cloud-top temperature) and 'pr' (precip rate) variables. Dims should be 'time', 'lat', 'lon'. 'lon' should be in -180 – 180 format.

Usage:

>>> ce, mcs, mcs_summary = tams.run(ds)
Parameters
  • ds (xarray.DataArray) – Dataset containing 3-D cloud-top temperature and precipitation rate.

  • parallel (bool) – Whether to apply parallelization (where possible).

  • u_projection (float) – x-direction projection velocity to apply before computing overlaps.

  • ctt_threshold (float) – Used to identify the edges of cloud elements.

  • ctt_core_threshold (float) – Used to identify deep convective cloud regions within larger cloud areas. This is used to determine whether or not a system is eligible for being classified as an organized system. It helps target raining clouds.

Return type

tuple[geopandas.GeoDataFrame, geopandas.GeoDataFrame, geopandas.GeoDataFrame]