Internal API

Routines

GeoCAT-comp routines

geocat.comp.climatologies._contains_datetime_like_objects

Check if a variable contains datetime like objects (either np.datetime64, or cftime.datetime)

geocat.comp.climatologies._calculate_center_of_time_bounds

Helper function to determine the time bounds based on the given dataset and frequency and then calculate the averages of them.

geocat.comp.climatologies._find_time_invariant_vars

geocat.comp.climatologies._get_time_coordinate_info

geocat.comp.climatologies._infer_calendar_name

Given an array of datetimes, infer the CF calendar name.

geocat.comp.climatologies._setup_clim_anom_input

geocat.comp.climatologies._validate_freq

geocat.comp.comp_util._is_duck_array

Returns True when value is array-like.

geocat.comp.eofunc._generate_eofs_solver

Convenience function to be used in both eofunc_eofs and eofunc_pcs functions.

geocat.comp.interpolation._func_interpolate

Define interpolation function.

geocat.comp.interpolation._pressure_from_hybrid

Calculate pressure at the hybrid levels.

geocat.comp.interpolation._sigma_from_hybrid

Calculate sigma at the hybrid levels.

geocat.comp.interpolation._vertical_remap

Execute the defined interpolation function on data.

geocat.comp.meteorology._dewtemp

This function calculates the dew point temperature given temperature and relative humidity using equations from John Dutton's "Ceaseless Wind" (pp 273-274)

geocat.comp.meteorology._heat_index

Compute the 'heat index' as calculated by the National Weather Service.

geocat.comp.meteorology._nws_eqn

Helper function to compute the heat index.

geocat.comp.meteorology._relhum

Calculates relative humidity with respect to ice, given temperature, mixing ratio, and pressure.

geocat.comp.meteorology._relhum_ice

Calculates relative humidity with respect to ice, given temperature, mixing ratio, and pressure.

geocat.comp.meteorology._relhum_water

Calculates relative humidity with respect to water, given temperature, mixing ratio, and pressure.

geocat.comp.meteorology._xheat_index

Compute the 'heat index' as calculated by the National Weather Service.

geocat.comp.meteorology._xrelhum

Calculates relative humidity with respect to ice, given temperature, mixing ratio, and pressure.

geocat.comp.polynomial._check_axis

geocat.comp.polynomial._get_missing_value

Attempts to extract missing_value or _FillValue from either data or dict.

geocat.comp.polynomial._isvector

geocat.comp.polynomial._ndpolyfit

An extension to numpy.polyfit function to support multi-dimensional arrays, Dask arrays, and missing values.

geocat.comp.polynomial._ndpolyval

geocat.comp.polynomial._rearrange_axis

rearranges the numpy.ndarray as a two-dimensional array of size (n,

geocat.comp.polynomial._reverse_rearrange_axis

geocat.comp.polynomial._to_numpy_ndarray

geocat.comp.polynomial._unchunk_ifneeded

Returns data unchunked along axis.