Skip to content

Additional ANTS tutorials - #179

Merged
Andrew Clark (arjclark) merged 10 commits into
MetOffice:mainfrom
arjclark:additional_tutorials
Sep 23, 2026
Merged

Andrew Clark (arjclark) merged 10 commits into
MetOffice:mainfrom
arjclark:additional_tutorials

Conversation

@arjclark

Copy link
Copy Markdown
Collaborator

Closes N/A

To be completed prior to review request and updated as required during the review process.

If the answer to an item on the list is not applicable, feel free to replace the checkbox with 'N/A' to give extra clarity.

All developers are reminded to follow the ancil working practices


Branch

Related branches (e.g. ancillary-file-science):

[please link any related branches here]

ANTS rose stem logs

[please enter the workflow name here as it has been run e.g. ants-trunk/run5]

ancillary-file-science rose stem logs

[please enter the workflow name here as it has been run e.g. ancillary-file-science/run1]


Testing

For core ANTS only tests, the bare minimum that will be accepted is the group=unittests but many, if not most, changes will need to test other groups to ensure they meet reviewer expectations. In general, it should be possible and is advised to run the group=all group prior to review submission as this will catch any consequential issues. Additionally you must run the ancillary-file-science tests, pointing at your branch, with group=all to capture any behaviour changes affecting Science codes.

If your change will alter existing science results, you will need to seek appropriate Scientific validation and confirm that the model has been initialised with your new development. Inspecting a change in xconv/pyplot/visualiser of choice is not sufficient to demonstrate the model can be initialised from your file.


Impact of change

  • This will maintain results for ANTS cylc vip ./rose-stem -z group=all tests
  • This will this maintain results for ancillary-file-science cylc vip ./rose-stem -z group=all tests
  • If this change adds a new capability, evidence has been supplied to show testing of ancillary generation across different resolutions e.g. For global ancillary generation capabilities for use in NWP n1280e is expected to have been tested
  • This change has significantly impacted required resources (runtime and memory) in existing ancillary generation (if yes, give details)
  • This change alters existing ancils
Addition of new tutorial materials, as primarily authored by Met Office Github Copilot.

Approvals for this change

  • I have approval from the ANTS core development team for these changes

New functionality further testing

  • If adding new functionality to existing codes, I confirm that the new code doesn't change results when it is switched off and ''works'' when switched on
  • Unittests have been added
  • Rose stem tests have been added for any new functionality
  • If adding new functionality please confirm that the new code compares across different standard decompositions.
  • I have not encountered any failures in my rose-stem output(s)
    These tasks must succeed for your ticket to pass review.
  • I have remembered to run the code style check tasks/tools
Proof reading and testing worked python examples.

Other

  • I have read the Contributor Licence Agreement
  • I have added my name and affiliation to the Contributors list if I am not already on there in this PR.
  • The issue labels, milestones, etc. are correct
  • Links to all related issues have been provided in the pull request description
  • I have requested a code reviewer
  • Source data has been added or changed - please include a link to the license
I confirm that all code is my own and that my contributions are not subject to copyright or license restrictions (see Contributor Licence Agreement). Andrew Clark
I confirm I have not knowingly violated intellectual property rights (IPR) and have taken sensible measures to prevent doing so, including appropriate attribution for usage of Generative AI. I confirm that this work is my own, and I understand that it is my responsibility to ensure I am not violating others’ IPR. This includes taking reasonable steps to ensure that all tools used while creating this contribution did not infringe IPR. Andrew Clark
MetOffice Enterprise Github Copilot used to create new tutorial materials with onward editing by myself.

Rose stem logs

Please copy in the contents of your trac_status.log file(s) below (found in the cylc-run directory for your rose stem run) to your rose-stem testing here. Note: if your changes lead to a change in answers, you must run cylc vip ./rose-stem -z group=all to help ensure all affected configurations has been flagged up.

Add workflow_status.log contents for ANTS rose-stem here.

Add workflow_status.log contents for ancillary-file-science rose-stem here.

@arjclark Andrew Clark (arjclark) added this to the 4.0 milestone Sep 17, 2026
@arjclark Andrew Clark (arjclark) added the 📚 documentation Improvements or additions to documentation label Sep 17, 2026
@arjclark Andrew Clark (arjclark) changed the title Additional tutorials Additional ANTS tutorials Sep 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This all looks reasonable and helpful to me. The CLI walkthrough page is now out of date since the vertical one went on and I have one suggestion on wording.

Comment thread docs/source/tutorial_regridding.rst Outdated
@arjclark

Copy link
Copy Markdown
Collaborator Author

Jenny Hickson (@jennyhickson) - entries added for the standalone vertical regrid in: 2a597c3

I think they look right - as expert, do they look correct to you?

@arjclark

Copy link
Copy Markdown
Collaborator Author

(still need to go back and do the results/regrid lines)

Comment thread docs/source/tutorial_cli_walkthroughs.rst Outdated
Comment thread docs/source/tutorial_cli_walkthroughs.rst Outdated
Comment thread docs/source/tutorial_cli_walkthroughs.rst Outdated
Comment thread docs/source/tutorial_cli_walkthroughs.rst Outdated
Comment thread docs/source/tutorial_regridding.rst Outdated
@arjclark

Copy link
Copy Markdown
Collaborator Author

Ok, I think I've got things in line and sorted now with some further additions and tweaking. Passing back to Jenny Hickson (@jennyhickson) - apologies that not all the change commits are discrete items I can point at - went through a few versions to get here...

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

All looking good to me :)

@arjclark
Andrew Clark (arjclark) merged commit d023fe0 into MetOffice:main Sep 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants