@@ -199,6 +199,8 @@ Coordinates can also be set or removed by using the dictionary like syntax:
199
199
del foo[' ranking' ]
200
200
foo.coords
201
201
202
+ For more details, see :ref: `coordinates ` below.
203
+
202
204
Dataset
203
205
-------
204
206
@@ -472,19 +474,35 @@ objects in the ``coords`` attribute:
472
474
ds.coords
473
475
474
476
Unlike attributes, xarray *does * interpret and persist coordinates in
475
- operations that transform xarray objects.
476
-
477
- One dimensional coordinates with a name equal to their sole dimension (marked
478
- by ``* `` when printing a dataset or data array) take on a special meaning in
479
- xarray. They are used for label based indexing and alignment,
480
- like the ``index `` found on a pandas :py:class: `~pandas.DataFrame ` or
481
- :py:class: `~pandas.Series `. Indeed, these "dimension" coordinates use a
482
- :py:class: `pandas.Index ` internally to store their values.
483
-
484
- Other than for indexing, xarray does not make any direct use of the values
485
- associated with coordinates. Coordinates with names not matching a dimension
486
- are not used for alignment or indexing, nor are they required to match when
487
- doing arithmetic (see :ref: `coordinates math `).
477
+ operations that transform xarray objects. There are two types of coordinates
478
+ in xarray:
479
+
480
+ - **dimension coordinates ** are one dimensional coordinates with a name equal
481
+ to their sole dimension (marked by ``* `` when printing a dataset or data
482
+ array). They are used for label based indexing and alignment,
483
+ like the ``index `` found on a pandas :py:class: `~pandas.DataFrame ` or
484
+ :py:class: `~pandas.Series `. Indeed, these "dimension" coordinates use a
485
+ :py:class: `pandas.Index ` internally to store their values.
486
+
487
+ - **non-dimension coordinates ** are variables that contain coordinate
488
+ data, but are not a dimension coordinate. They can be multidimensional
489
+ (see :ref: `examples.multidim `), and there is no relationship between the
490
+ name of a non-dimension coordinate and the name(s) of its dimension(s).
491
+ Non-dimension coordinates can be useful for indexing or plotting; otherwise,
492
+ xarray does not make any direct use of the values associated with them.
493
+ They are not used for alignment or automatic indexing, nor are they required
494
+ to match when doing arithmetic
495
+ (see :ref: `coordinates math `).
496
+
497
+ .. note ::
498
+
499
+ xarray's terminology differs from the `CF terminology `_, where the
500
+ "dimension coordinates" are called "coordinate variables", and the
501
+ "non-dimension coordinates" are called "auxiliary coordinate variables"
502
+ (see :issue: `1295 ` for more details).
503
+
504
+ .. _CF terminology : http://cfconventions.org/cf-conventions/v1.6.0/cf-conventions.html#terminology
505
+
488
506
489
507
Modifying coordinates
490
508
~~~~~~~~~~~~~~~~~~~~~
0 commit comments