Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added phrasebook #5564

Merged
merged 1 commit into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/src/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,14 @@ smoother interoperability:

* The :mod:`iris.pandas` module
* :doc:`iris_xarray`
* :doc:`phrasebook`
stephenworsley marked this conversation as resolved.
Show resolved Hide resolved

.. toctree::
:maxdepth: 1
:hidden:

iris_xarray
phrasebook

Plugins
-------
Expand Down
1 change: 1 addition & 0 deletions docs/src/community/iris_xarray.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------------
Expand Down
66 changes: 66 additions & 0 deletions docs/src/community/phrasebook.rst
Original file line number Diff line number Diff line change
@@ -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_>`_
3 changes: 3 additions & 0 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===========
Expand Down