Contents Menu Expand Light mode Dark mode Auto light/dark mode
cf_xarray documentation
Logo

In-depth Examples

  • Introduction to cf_xarray
  • EarthCube 2021 demo
  • CESM ocean model demo
  • COSIMA ocean-sea ice model demo

User Guide

  • Quickstart
  • How to use cf_xarray
  • Frequently Asked Questions
  • Axes and Coordinates
  • Selecting DataArrays
  • Flag Variables
  • Units
  • Parametric Vertical Coordinates
  • Bounds Variables
  • Grid Mappings
  • Encoding and decoding
  • Discrete Sampling Geometries
  • SGRID / UGRID
  • Geometries
  • Plotting
  • Custom Criteria
  • History & provenance tracking
  • API Reference
    • cf_xarray.bounds_to_vertices
    • cf_xarray.vertices_to_bounds
    • cf_xarray.shapely_to_cf
    • cf_xarray.cf_to_shapely
    • cf_xarray.set_options
    • cf_xarray.encode_multi_index_as_compress
    • cf_xarray.decode_compress_to_multi_index
    • xarray.DataArray.cf.axes
    • xarray.DataArray.cf.cell_measures
    • xarray.DataArray.cf.cf_roles
    • xarray.DataArray.cf.coordinates
    • xarray.DataArray.cf.formula_terms
    • xarray.DataArray.cf.grid_mapping_name
    • xarray.DataArray.cf.is_flag_variable
    • xarray.DataArray.cf.standard_names
    • xarray.DataArray.cf.plot
    • xarray.DataArray.cf.__getitem__
    • xarray.DataArray.cf.__repr__
    • xarray.DataArray.cf.add_canonical_attributes
    • xarray.DataArray.cf.differentiate
    • xarray.DataArray.cf.guess_coord_axis
    • xarray.DataArray.cf.keys
    • xarray.DataArray.cf.rename_like
    • xarray.DataArray.cf.__lt__
    • xarray.DataArray.cf.__le__
    • xarray.DataArray.cf.__eq__
    • xarray.DataArray.cf.__ne__
    • xarray.DataArray.cf.__ge__
    • xarray.DataArray.cf.__gt__
    • xarray.DataArray.cf.isin
    • xarray.Dataset.cf.axes
    • xarray.Dataset.cf.bounds
    • xarray.Dataset.cf.cell_measures
    • xarray.Dataset.cf.cf_roles
    • xarray.Dataset.cf.coordinates
    • xarray.Dataset.cf.formula_terms
    • xarray.Dataset.cf.grid_mapping_names
    • xarray.Dataset.cf.standard_names
    • xarray.Dataset.cf.__getitem__
    • xarray.Dataset.cf.__repr__
    • xarray.Dataset.cf.add_bounds
    • xarray.Dataset.cf.add_canonical_attributes
    • xarray.Dataset.cf.bounds_to_vertices
    • xarray.Dataset.cf.decode_vertical_coords
    • xarray.Dataset.cf.differentiate
    • xarray.Dataset.cf.get_bounds
    • xarray.Dataset.cf.get_bounds_dim_name
    • xarray.Dataset.cf.guess_coord_axis
    • xarray.Dataset.cf.keys
    • xarray.Dataset.cf.rename_like

For contributors

  • Contributing Guide
    • cf_xarray.accessor.coordinate_criteria
    • cf_xarray.accessor.CFAccessor
    • cf_xarray.accessor._CFWrappedClass
    • cf_xarray.accessor._CFWrappedPlotMethods
    • cf_xarray.accessor._getattr
    • cf_xarray.accessor._getitem
    • cf_xarray.accessor._get_all
    • cf_xarray.accessor._get_axis_coord
    • cf_xarray.accessor._get_bounds
    • cf_xarray.accessor._get_coords
    • cf_xarray.accessor._get_custom_criteria
    • cf_xarray.accessor._get_dims
    • cf_xarray.accessor._get_groupby_time_accessor
    • cf_xarray.accessor._get_indexes
    • cf_xarray.accessor._get_measure
    • cf_xarray.accessor._get_with_standard_name
  • Development Roadmap
  • Whats New
  • GitHub repository
  v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Back to top
Edit this page

xarray.Dataset.cf.cf_roles#

Dataset.cf.cf_roles#

Returns a dictionary mapping cf_role names to variable names.

Returns
dict

Dictionary mapping cf_role names to variable names.

References

Please refer to the CF conventions document : http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#coordinates-metadata

Examples

>>> import cf_xarray
>>> from cf_xarray.datasets import dsg
>>> dsg.cf.cf_roles
{'profile_id': ['profile'], 'trajectory_id': ['trajectory']}
Next
xarray.Dataset.cf.coordinates
Previous
xarray.Dataset.cf.cell_measures
Copyright © 2020-2023, cf_xarray Developers
Made with Sphinx and @pradyunsg's Furo
On this page
  • xarray.Dataset.cf.cf_roles
    • Dataset.cf.cf_roles