xarray.DataArray.cf.formula_terms#
- DataArray.cf.formula_terms#
Property that returns a dictionary mapping the parametric coordinate’s name to a dictionary that maps “standard term names” to actual variable names.
- Returns:
- dict
Dictionary of the form
{parametric_coord_name: {standard_term_name: variable_name}}
References
- Please refer to the CF conventions document :
Examples
>>> import cf_xarray >>> from cf_xarray.datasets import romsds
The
s_rho
DataArray is an example of a parametric vertical coordinate.>>> romsds.s_rho <xarray.DataArray 's_rho' (s_rho: 30)> array([-0.983333, -0.95 , -0.916667, -0.883333, -0.85 , -0.816667, -0.783333, -0.75 , -0.716667, -0.683333, -0.65 , -0.616667, -0.583333, -0.55 , -0.516667, -0.483333, -0.45 , -0.416667, -0.383333, -0.35 , -0.316667, -0.283333, -0.25 , -0.216667, -0.183333, -0.15 , -0.116667, -0.083333, -0.05 , -0.016667]) Coordinates: * s_rho (s_rho) float64 -0.9833 -0.95 -0.9167 ... -0.05 -0.01667 hc float64 20.0 h float64 603.9 Vtransform float64 2.0 Cs_r (s_rho) float64 -0.933 -0.8092 -0.6988 ... -0.0005206 -5.758e-05 Attributes: long_name: S-coordinate at RHO-points valid_min: -1.0 valid_max: 0.0 standard_name: ocean_s_coordinate_g2 formula_terms: s: s_rho C: Cs_r eta: zeta depth: h depth_c: hc field: s_rho, scalar
Now access the formula terms
>>> romsds.s_rho.cf.formula_terms {'s': 's_rho', 'C': 'Cs_r', 'eta': 'zeta', 'depth': 'h', 'depth_c': 'hc'}