User API

GeoCAT-comp Native Functions

Climatologies

calendar_average	This function divides the data into time periods (months, seasons, etc) and computes the average for the data in each one.
climate_anomaly	This function calculates climate anomalies by subtracting the long term mean of each freq period (day, month, season, or year) from each datapoint.
climatology_average	This function calculates long term hourly, daily, monthly, or seasonal averages across all years in the given dataset.
month_to_season	Computes a user-specified three-month seasonal mean.

Fourier Filters

fourier_band_block	Filter a dataset by frequency.
fourier_band_pass	Filter a dataset by frequency.
fourier_filter	Filter a dataset by frequency.
fourier_high_pass	Filter a dataset by frequency.
fourier_low_pass	Filter a dataset by frequency.

Gradient

gradient

Extract and return the gradient values of a dataset at each point in the dataset.

Iterpolation

interp_hybrid_to_pressure	Interpolate and extrapolate data from hybrid-sigma levels to isobaric levels.
interp_sigma_to_hybrid	Interpolate data from sigma to hybrid coordinates.
interp_multidim	Multidimensional interpolation of variables.

Meteorology

actual_saturation_vapor_pressure	Compute 'actual' saturation vapor pressure [kPa] as described in the Food and Agriculture Organization (FAO) Irrigation and Drainage Paper 56 entitled:
delta_pressure	Calculates the pressure layer thickness (delta pressure) of a constant pressure level coordinate system.
dewtemp	This function calculates the dew point temperature given temperature and relative humidity using equations from John Dutton's "Ceaseless Wind" (pp 273-274)
heat_index	Compute the 'heat index' as calculated by the National Weather Service.
max_daylight	Computes maximum number of daylight hours as described in the Food and Agriculture Organization (FAO) Irrigation and Drainage Paper 56 entitled:
psychrometric_constant	Compute psychrometric constant [kPa / C] as described in the Food and Agriculture Organization (FAO) Irrigation and Drainage Paper 56 entitled:
relhum	This function calculates the relative humidity given temperature, mixing ratio, and pressure.
relhum_ice	Calculates relative humidity with respect to ice, given temperature, mixing ratio, and pressure.
relhum_water	Calculates relative humidity with respect to water, given temperature, mixing ratio, and pressure.
saturation_vapor_pressure	Compute saturation vapor pressure as described in the Food and Agriculture Organization (FAO) Irrigation and Drainage Paper 56 entitled:
saturation_vapor_pressure_slope	Compute the slope [kPa/C] of saturation vapor pressure curve as described in the Food and Agriculture Organization (FAO) Irrigation and Drainage Paper 56 entitled:

Spherical Harmonics

decomposition	Calculate the spherical harmonics of a dataset.
recomposition	Calculate a dataset from spherical harmonics.
scale_voronoi	Calculate the area weighting for dataset.

Statistics

eofunc_eofs	Computes empirical orthogonal functions (EOFs, aka: Principal Component Analysis).
eofunc_pcs	Computes the principal components (time projection) in the empirical orthogonal function analysis.
pearson_r	This function wraps the function of the same name from xskillscore.

NCL Function Name Wrappers

meteorology.dpres_plev

Attention This method is a wrapper for delta_pressure

Deprecated Functions

grid_to_triple	Deprecated since version 2023.06.0.
linint1	Deprecated since version 2023.06.0.
linint2	Deprecated since version 2023.06.0.
linint2pts	Deprecated since version 2023.06.0.
moc_globe_atl	Deprecated since version 2023.06.0.
rcm2points	Deprecated since version 2023.06.0.
rcm2rgrid	Deprecated since version 2023.06.0.
rgrid2rcm	Deprecated since version 2023.06.0.
triple_to_grid	Deprecated since version 2023.06.0.