Internal API#

Utility Functions#

geocat.comp.gc_util._generate_wrapper_docstring

Generate the docstring for a wrapper function in the form of: 'This method is a wrapper for base_fcn', with a generated link to the base function.

Internal Functionality Helpers#

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._get_time_coordinate_info

geocat.comp.climatologies._infer_calendar_name

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

geocat.comp.climatologies._validate_freq

geocat.comp.gradient._arc_lat_wgs84

The arc length calculation for the wgs84 ellipsoid at a latitude uses a taylor series to obtain the value of the elliptic integral.

geocat.comp.gradient._arc_lon_wgs84

The arc length calculation for the wgs84 ellipsoid at a longitude uses a taylor series from.

geocat.comp.gradient._rad_lat_wgs84

The radius calculation for the wgs84 ellipsoid at a latitude uses a taylor series from.

geocat.comp.interpolation._func_interpolate

Define interpolation function.

geocat.comp.interpolation._geo_height_extrapolate

This helper function extrapolates geopotential height below ground using the ECMWF formulation described in Vertical Interpolation and Truncation of Model-Coordinate Data by Trenberth, Berry, & Buja [NCAR/TN-396, 1993].

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._temp_extrapolate

This helper function extrapolates temperature below ground using the ECMWF formulation described in Vertical Interpolation and Truncation of Model-Coordinate Data by Trenberth, Berry, & Buja [NCAR/TN-396, 1993].

geocat.comp.interpolation._vertical_remap

Execute the defined interpolation function on data.

geocat.comp.interpolation._vertical_remap_extrap

A helper function to call the appropriate extrapolation function based on the user's inputs.

geocat.comp.interpolation._pre_interp_multidim

Helper Function: Handling missing data functionality and adding cyclic point if required.

geocat.comp.interpolation._post_interp_multidim

Helper Function: Handling missing data functionality.

geocat.comp.meteorology._delta_pressure1D

Helper function for delta_pressure.

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.