List of functions and classes (API)

Note

All functions and classes should be accessed from the easyclimate top-level namespace.

Modules inside of the easyclimate package are meant mostly for internal organization. Please avoid importing directly from submodules since functions/classes may be moved around.

Core

easyclimate.core.diagnosis	Functions for Weather and climate variable diagnosis.
easyclimate.core.diff	The calculation of geographic finite difference
easyclimate.core.eddy	The calculation of transient eddy
easyclimate.core.eof	The analysis of the EOF and MCA
easyclimate.core.extract	Obtain data within a specified time period
easyclimate.core.mk_test	Mann-Kendall Test
easyclimate.core.read	Functions for read data.
easyclimate.core.stat	Basic statistical analysis of weather and climate variables
easyclimate.core.tutorial	Tutorials in the easyclimate documentation
easyclimate.core.utility	Functions for package utility.
easyclimate.core.variability	This module calculate climate variability
easyclimate.core.yearstat	This module computes statistical values over timesteps of the same year
easyclimate.core.windspharm	Easy climate top interface for the windspharm

Filter

easyclimate.filter.butter_filter	Butterworth bandpass filter
easyclimate.filter.smooth	spatial smoothing
easyclimate.filter.wavelet	Wavelet transform

Interpolation

easyclimate.interp.point2mesh	Interpolate from points to grid
easyclimate.interp.mesh2mesh	Regridding
easyclimate.interp.interp1d_vertical_model2pressure(...)	Interpolating variables from the model levels (e.g., sigma vertical coordinate) to the standard pressure levels by 1-D function.

Plot

easyclimate.plot.axisticker	Quick processing of special axes
easyclimate.plot.projection	Graph processing related functions
easyclimate.plot.significance_plot	Mapping areas of significance
easyclimate.plot.taylor_diagram	Functions for Taylor Diagrams plotting.
easyclimate.plot.quick_draw	The quick drawing function

Climate Field

Air–Sea Interaction

easyclimate.field.air_sea_interaction
easyclimate.field.air_sea_interaction.index_enso	ENSO Index
easyclimate.field.air_sea_interaction.index_iod	Indian Ocean Dipole (IOD) Index
easyclimate.field.air_sea_interaction.index_iobm	Indian Ocean Basin mode (IOBM) Index
easyclimate.field.air_sea_interaction.index_amm	Atlantic Meridional Mode (AMM) Index
easyclimate.field.air_sea_interaction.index_atlantic_nino	Atlantic Niños Index

Teleconnections

easyclimate.field.teleconnection
easyclimate.field.teleconnection.index_pna	Pacific/North American (PNA) Index
easyclimate.field.teleconnection.index_nao	North Atlantic Oscillation (NAO) Index
easyclimate.field.teleconnection.index_ea	The eastern Atlantic (EA) pattern
easyclimate.field.teleconnection.index_wa	The western Atlantic (WA) pattern
easyclimate.field.teleconnection.index_wp	The western Pacific (WP) pattern
easyclimate.field.teleconnection.index_eu	The Eurasian pattern (EU) pattern
easyclimate.field.teleconnection.index_srp	Silk Road pattern (SRP) Index
easyclimate.field.teleconnection.index_cgt	Circumglobal teleconnection pattern (CGT) Index

Land–Atmosphere Interactions

easyclimate.field.land

Monsoon

easyclimate.field.monsoon
easyclimate.field.monsoon.index_npwi	Objective globally unified summer monsoon onset or retreat dates.

Ocean

easyclimate.field.ocean
easyclimate.field.ocean.mixlayer	The calculation of ocean mixed layer variables.
easyclimate.field.ocean.oceanic_front	Quantify the intensity and location of two basin-scale oceanic frontal zones in the wintertime North Pacific, i.e. the subtropical and subarctic frontal zones (STFZ, SAFZ).
easyclimate.field.ocean.stability	The calculation of ocean instability.
easyclimate.field.ocean.thermal	The calculation of ocean thermocline variables.

Mesoscale

easyclimate.field.mesoscale
easyclimate.field.mesoscale.potential_intensity	Potential intensity of TC