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

Document use of new_axis to control merge #6180

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

stephenworsley
Copy link
Contributor

🚀 Pull Request

Description

Closes #6162.
Requires SciTools/iris-sample-data#33.
May need to be adapted to account for #6168.

@stephenworsley stephenworsley marked this pull request as draft October 17, 2024 14:47
Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.82%. Comparing base (cc60a60) to head (569a0a3).
Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #6180    +/-   ##
========================================
  Coverage   89.81%   89.82%            
========================================
  Files          88       88            
  Lines       23174    23185    +11     
  Branches     5045     4314   -731     
========================================
+ Hits        20814    20825    +11     
- Misses       1623     1628     +5     
+ Partials      737      732     -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The process seems very solid, but I have suggested a few possible improvements for clarity.

Obviously we aren't quite ready to merge this anyway, owing to the link with #6168 as you already noted.

docs/src/further_topics/controlling_merge.rst Show resolved Hide resolved
docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
13: x_wind / (m s-1) (model_level_number: 5; time: 1; latitude: 144; longitude: 192)
14: x_wind / (m s-1) (model_level_number: 5; time: 1; latitude: 144; longitude: 192)

Once merged, we can now concatenate these cubes together:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once merged, we can now concatenate these cubes together:
Once merged, we can now concatenate all these cubes into a single result cube, which is what we wanted:

docs/src/further_topics/controlling_merge.rst Outdated Show resolved Hide resolved
Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, nearly there but there are a few problems remaining.

  • a couple of further suggestions on the diff
  • you need to include the new page in the 'further topics' TOC, since that doesn't happen automatically, and I couldn't view the built page in the docs even by substituting the page name
    I think you just need to add it here
  • the docs build is now working, but the doctests are still failing. I think it's a cartopy compatibility problem, which I hope may be fixed by just updating the branch, but I'll leave you to do that in case something goes wrong

74: x_wind / (m s-1) (time: 1; latitude: 144; longitude: 192)

Then we merge, promoting the different ``model_level_number`` scalar coordinates to a dimension coordinate.
Note, however, that merging these cubes does _not_ affect the ``time`` dimension, since merging only
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note, however, that merging these cubes does _not_ affect the ``time`` dimension, since merging only
Note, however, that merging these cubes does *not* affect the ``time`` dimension, since merging only

Sorry, my mistake, underscores are for markdown not RST !

.. _controlling_merge:

=================
Controlling Merge
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it anyway better to call this "Controlling Merge and Concatenate" ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Document new_axis utility
2 participants