Added xarray phrasebook doc page (SciTools#5564)

tkknight · Nov 9, 2023 · ce813ff · ce813ff
1 parent 0dc2dd9
commit ce813ff
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 0 deletions.
diff --git a/docs/src/community/index.rst b/docs/src/community/index.rst
@@ -40,12 +40,14 @@ smoother interoperability:
 
 * The :mod:`iris.pandas` module
 * :doc:`iris_xarray`
+* :doc:`phrasebook`
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
    iris_xarray
+   phrasebook
 
 Plugins
 -------

diff --git a/docs/src/community/iris_xarray.rst b/docs/src/community/iris_xarray.rst
@@ -7,6 +7,7 @@ Iris ❤️ :term:`Xarray`
 There is a lot of overlap between Iris and :term:`Xarray`, but some important
 differences too. Below is a summary of the most important differences, so that
 you can be prepared, and to help you choose the best package for your use case.
+See :doc:`phrasebook` for a broad comparison of terminology.
 
 Overall Experience
 ------------------

diff --git a/docs/src/community/phrasebook.rst b/docs/src/community/phrasebook.rst
@@ -0,0 +1,66 @@
+.. include:: ../common_links.inc
+
+.. _phrasebook:
+
+Package Phrasebook
+===================
+
+There are a number of similar packages to Iris, and a lot of these have their own
+terminology for similar things. Whether you're coming or going, we hope this might
+be a helpful guide to these differences!
+Definitions for each can be found in :ref:`glossary`. See also
+`Xarray terminology <https://docs.xarray.dev/en/stable/user-guide/terminology.html>`_.
+
+.. list-table:: Phrasebook
+   :widths: 25 25 25 50
+   :header-rows: 1
+
+   * - Iris
+     - Xarray
+     - Example
+     - Notes
+   * - Non-Lazy
+     - Eager
+     -
+     - Used to relate to functions, rather than the data.
+   * - Cube
+     - DataArray
+     -
+     -
+   * - CubeList
+     - Dataset
+     -
+     - Though similar, a CubeList is a simpler object, and is
+       not a perfect comparison to a Dataset
+   * - Merge/ Concatenate
+     - Concatenate
+     - `Xarray concatenate <https://docs.xarray.dev/en/stable/user-guide/combining.html#concatenate>`_
+     - Xarray's concatenate has the capability to largely do what both
+       Iris merge and Iris concatenate do. However, this is not a perfect comparison,
+       please see the link for more information.
+   * -
+     - Merge
+     - `Xarray merge <https://docs.xarray.dev/en/stable/user-guide/combining.html#merge>`_
+     - Xarray's Merge function doesn't map neatly map to any Iris feature.
+       Please see the link for more information.
+   * - Scalar Coordinate
+     -
+     -
+     - Iris makes a distinction between scalar coordinates and non-scalar coordinates,
+       whereas xarray documentation makes a distinction between scalar and non-scalar *data*.
+       It is possible to make coordinates with scalar data in both Iris and xarray
+       but only Iris will label such coordinates.
+   * - AuxCoord
+     - Non-Dimensional Coordinate
+     -
+     - Coordinates in Iris and xarray are categorised using different rules,
+       and so are not a one-to-one match.
+   * - DimCoord
+     - Dimension Coordinate
+     -
+     - Coordinates in Iris and xarray are categorised using different rules,
+       and so are not a one-to-one match.
+
+----
+
+`To top <phrasebook_>`_
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
@@ -93,6 +93,9 @@ This document explains the changes made to Iris for this release
 
 #. `@tkknight`_  removed broken git links. (:pull:`5569`)
 
+#. `@ESadek-MO`_ added a phrasebook for synonymous terms used in similar
+   packages. (:pull:`5564`)
+
 
 💼 Internal
 ===========