easyclimate.field.air_sea_interaction.index_iod¶
Indian Ocean Dipole (IOD) Index
Functions¶
|
The calculation of monthly mean Indian Ocean Dipole (IOD) index (i.e., Dipole Mode Index; DMI) is constructed by following method: |
Module Contents¶
- easyclimate.field.air_sea_interaction.index_iod.calc_index_IOD_Saji_1999(sst_monthly_data: xarray.DataArray, time_range: slice = slice(None, None), lon_dim: str = 'lon', lat_dim: str = 'lat', time_dim: str = 'time', normalized: bool = False) xarray.DataArray¶
The calculation of monthly mean Indian Ocean Dipole (IOD) index (i.e., Dipole Mode Index; DMI) is constructed by following method:
The difference in SST anomaly between the tropical western Indian Ocean (50°E-70°E, 10°S-10°N) and the tropical south-eastern Indian Ocean (90°E-110°E, 10°S-Equator).
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.
- lon_dim:
str, default: lon. Longitude coordinate dimension name. By default extracting is applied over the lon dimension.
- lat_dim:
str, default: lat. Latitude coordinate dimension name. By default extracting is applied over the lat dimension.
- time_dim:
str, default: time. The time coordinate dimension name.
- normalized:
bool, default True, optional. Whether to standardize the index based on standard deviation over time_range.
Returns¶
The monthly mean IOD index (
xarray.DataArray).Reference¶
- sst_monthly_data: