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

Enable factory references to create new dimensions on load. #6168

Merged
merged 35 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
dc39651
Enable factory references to create new dimensions on load.
pp-mo Oct 9, 2024
d712682
Skip hanging tests.
pp-mo Oct 9, 2024
5e53a08
Skip more hanging tests.
pp-mo Oct 9, 2024
92369ec
Adjust misleading comment.
pp-mo Oct 10, 2024
8563455
Add policy control and auto-detect. NOTE: for now only load, not load…
pp-mo Oct 11, 2024
a692862
Add temporary testcode. NB no actual test, just printout.
pp-mo Oct 11, 2024
653561f
Replaced _CubeFilterCollection.merged() with combined(); replace uses…
pp-mo Oct 14, 2024
393be73
Fix licence header
pp-mo Oct 14, 2024
ca3955f
Fix to handle empty reference correctly.
pp-mo Oct 14, 2024
5fa2b46
Fix tests.
pp-mo Oct 14, 2024
801f9e2
Simplify policy options and tidy api.
pp-mo Oct 15, 2024
edfea05
More documentation of loading options.
pp-mo Oct 15, 2024
984a59c
Fix doctest.
pp-mo Oct 18, 2024
027b7a0
Fix repeated combination.
pp-mo Oct 20, 2024
381e7da
Minor docs improvements.
pp-mo Oct 21, 2024
022f94a
Initial load functions testing (WIP).
pp-mo Oct 18, 2024
8aadc27
Integration tests for time-varying reference fields.
pp-mo Oct 22, 2024
98b8da6
Fix test result.
pp-mo Oct 22, 2024
a62b452
Make grib test optional.
pp-mo Oct 22, 2024
6d04d49
Merge branch 'main' into load_factory_dims
pp-mo Oct 23, 2024
4e265f2
Review changes
pp-mo Oct 23, 2024
3bf6cc6
Reinstate skipped tests.
pp-mo Oct 24, 2024
cfa1974
Make combine_cubes work with plain lists; Make 'combine_cubes' privat…
pp-mo Oct 24, 2024
da85529
Add tests for combine_cubes.
pp-mo Oct 24, 2024
80efa2d
Add tests for LoadPolicy API.
pp-mo Oct 24, 2024
cb1ddff
Add special split-netcdf roundtrip testing.
pp-mo Oct 24, 2024
cb7fc06
Removed unwanted 'policy' keyword from iris.load .
pp-mo Oct 24, 2024
54fe96d
Make LoadPolicy examples more consistent.
pp-mo Oct 24, 2024
03f0d2a
Review changes : documentation improvements.
pp-mo Oct 24, 2024
c30ab2f
Doctest fix
pp-mo Oct 24, 2024
e1de23c
fix controlling_merge docs
stephenworsley Oct 24, 2024
e2ab4b1
Merge pull request #81 from stephenworsley/load_factory_dims_docs
pp-mo Oct 24, 2024
8a36d88
LOAD_POLICY uses 'default' settings by default.
pp-mo Oct 24, 2024
3eba834
Various quick fixes to legacy tests.
pp-mo Oct 24, 2024
e5b4ce6
Added whatsnew.
pp-mo Oct 24, 2024
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
22 changes: 20 additions & 2 deletions docs/src/further_topics/controlling_merge.rst
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 @@ -200,5 +215,8 @@ Once merged, we can now concatenate all these cubes into a single result cube, w
source 'Data from Met Office Unified Model'
um_version '12.1'

.. todo::
Mention the work done in #6168
See Also
--------
* :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`.
4 changes: 4 additions & 0 deletions docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ This document explains the changes made to Iris for this release

Requested in :issue:`5970`, actioned in :pull:`6169`.

#. `@pp-mo`_ and `@stephenworsley`_ added support for hybrid coordinates whose
references are split across multiple input fields, and :meth:`~iris.LOAD_POLICY` to
control it, as requested in :issue:`5369`, actioned in :pull:`6168`.


🐛 Bugs Fixed
=============
Expand Down
Loading
Loading