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.datanode	Hierarchical data structure that dynamically manages attributes and nested nodes
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.normalized	Normalized Data
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.spharm	Easy climate top interface for the Pyspharm
easyclimate.core.windspharm	Easy climate top interface for the windspharm

Physics🗺️

Geophysical Parameters Related

easyclimate.physics.geo.coriolis	Coriolis Force
easyclimate.physics.geo.linrood_latwgt	Latitudes and weights in the Lin-Rood model

Dry Related

easyclimate.physics.dry

Moisture Related

easyclimate.physics.moisture.dewpoint	Dewpoint
easyclimate.physics.moisture.lapse_rate	Moist Adiabatic Lapse Rate
easyclimate.physics.moisture.mix	Mixing Ratio of a Gas
easyclimate.physics.moisture.vapor_pressure	Vapor Pressure
easyclimate.physics.moisture.wet_bulb	Wet-bulb Temperature

Temperature Related

easyclimate.physics.temperature.equivalent_potential_temperature	Equivalent Potential Temperature
easyclimate.physics.temperature.potential_temperature	Potential Temperature
easyclimate.physics.temperature.virtual_temperature	Virtual Temperature

Condensation Related

easyclimate.physics.condensation.lcl

Lifting Condensation Level (LCL)

Convection Related

easyclimate.physics.convection.stability

Atmospheric Stability

Energy Related

easyclimate.physics.energy.angmom_atm	Atmospheric Relative Angular Momentum
easyclimate.physics.energy.enthalpy	Atmospheric Enthalpy
easyclimate.physics.energy.latent_heat_water	Latent Heat Flux for Water

Others

easyclimate.physics.transfer

Unit conversion for Meteorological variables

Filter🎹

easyclimate.filter.butter_filter	Butterworth bandpass filter
easyclimate.filter.lanczos_filter	Lanczos filter
easyclimate.filter.kf_filter	Extract equatorial waves by filtering in the Wheeler-Kiladis wavenumber-frequency domain
easyclimate.filter.barnes_filter	Barnes filter
easyclimate.filter.gaussian_filter	Gaussian filter
easyclimate.filter.smooth	Spatial smoothing
easyclimate.filter.wavelet	Wavelet transform
easyclimate.filter.redfit	Red-noise spectra estimating
easyclimate.filter.spatial_pcf	2D spatial parabolic cylinder function
easyclimate.filter.emd	Empirical Mode Decomposition and Ensemble Empirical Mode Decomposition (EEMD)
easyclimate.filter.spectrum	Spatio-temporal Spectrum Analysis

Interpolation🔗

easyclimate.interp.barnes	Fast Barnes interpolation
easyclimate.interp.mesh2mesh	Regridding
easyclimate.interp.mesh2point	Interpolating mesh/grid data to point locations
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.
easyclimate.interp.interp1d_vertical_pressure2altitude(...)	Interpolating variables from the pressure levels (e.g., sigma vertical coordinate) to the altitude levels by 1-D function.
easyclimate.interp.vinth2p	Interpolates Community Atmosphere Model (CAM) or Community Earth System Model (CESM) hybrid coordinates to pressure coordinates

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
easyclimate.plot.curved_quiver_plot	Functions for curved quiver plots.
easyclimate.plot.bar	Bar plot for xarray dataset
easyclimate.plot.line	Bar plot for xarray dataset

WRF-python🌌

easyclimate.wrf.interface

WRF-python interface

Meteorology 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
easyclimate.field.air_sea_interaction.index_pdo	Pacific Decadal Oscillation (PDO) Index

Teleconnections

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
easyclimate.field.teleconnection.index_ao_nam	The Arctic Oscillation (AO)/ Monthly Northern Hemisphere Annular Mode (NAM) Index
easyclimate.field.teleconnection.index_da	Arctic Dipole Anomaly (DA/AD)
easyclimate.field.teleconnection.index_bbo	Barents-Beaufort Oscillation (BBO)

Land

easyclimate.field.land

Monsoon

easyclimate.field.monsoon.index_npwi	Objective globally unified summer monsoon onset or retreat dates
easyclimate.field.monsoon.bsiso	Boreal Summer Intraseasonal Oscillation (BSISO)

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.

Typhoon

easyclimate.field.typhoon.potential_intensity

Potential intensity of TC

Equatorial Wave

easyclimate.field.equatorial_wave.mjo	Madden Julian Oscillation (MJO)
easyclimate.field.equatorial_wave.wk_spectra	Wheeler-Kiladis Space-Time Spectra

Satellite

easyclimate.field.satellite.image

Satellite Map

Heat Stress

easyclimate.field.heat_stress.humanindexmod_2020

Human index

Boundary Layer

easyclimate.field.boundary_layer.aerobulk

Estimate turbulent air-sea fluxes