Skip to content

Fix controlling_merge docs #81

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.

Sign up for GitHub

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

Merged
pp-mo merged 1 commit into from
Oct 24, 2024
Merged

Fix controlling_merge docs #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions docs/src/further_topics/controlling_merge.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@
Controlling Merge and Concatenate
=================================

Preliminaries
-------------

The following code would have been necessary with loading behaviour prior to version 3.11.0 . For the sake of
demonstration, we will revert back to this legacy loading behaviour as follows:

>>> iris.LOAD_POLICY.set("legacy")

.. note::
The default settings for :data:`iris.LOAD_POLICY` effectively implements some version of the following demonstration
automatically upon loading. It may still be worth being aware of how to handle this manually if an even finer degree
of control is required.

How to Merge Cubes When Coordinates Differ
------------------------------------------

Sometimes it is not possible to appropriately combine a CubeList using merge and concatenate on their own. In such cases
it is possible to achieve much more control over cube combination by using the :func:`~iris.util.new_axis` utility.
Expand Down Expand Up @@ -202,7 +217,6 @@ Once merged, we can now concatenate all these cubes into a single result cube, w

See Also
--------
* :func:`iris.combine_cubes` can perform similar operations automatically
* :data:`iris.LOAD_POLICY` controls the application of :func:`~iris.combine_cubes`
during the load operations, i.e. :func:`~iris.load`, :func:`~iris.load_cube` and
* :data:`iris.LOAD_POLICY` can be controlled to apply similar operations
within the load functions, i.e. :func:`~iris.load`, :func:`~iris.load_cube` and
:func:`~iris.load_cubes`.