easyclimate.field.air_sea_interaction.index_atlantic_nino

Atlantic Niños Index

Functions

calc_index_ATL3(, lat_dim, lon_dim, time_dim, normalized)

Calculate ATL3 index.

Module Contents

easyclimate.field.air_sea_interaction.index_atlantic_nino.calc_index_ATL3(sst_monthly_data: xarray.DataArray | xarray.Dataset, time_range: slice = slice(None, None), lat_dim: str = 'lat', lon_dim: str = 'lon', time_dim: str = 'time', normalized: bool = False) → xarray.DataArray | xarray.Dataset

Calculate ATL3 index.

In some years, the cold tongue formation in summer is weak, leading to warm SST anomalies in the cold tongue region. This is what is called an Atlantic Niño. One way to gauge the strength of these events is to calculate the area average of SST in the cold tongue region, defined as 20°W to 0° and 3°S to 3°N. This is called the ATL3 index.

Parameters

sst_monthly_data: xarray.DataArray.

The monthly sea surface temperature (SST) dataset.

time_range: slice, default: slice(None, None).

The time range of seasonal cycle means to be calculated. The default value is the entire time range.

lat_dim: str, default: lat.

Latitude coordinate dimension name. By default extracting is applied over the lat dimension.

lon_dim: str, default: lon.

Longitude coordinate dimension name. By default extracting is applied over the lon dimension.

time_dim: str, default: time.

The time coordinate dimension name.

normalized: bool, default False, optional.

Whether to standardize the index based on standard deviation over time_range.

Returns

ATL3 index.

Reference