Skip to content

Update root Readme file.#188

Merged
mike-hobson merged 15 commits intoMetOffice:mainfrom
andrewcoughtrie:update_docs
Dec 17, 2025
Merged

Update root Readme file.#188
mike-hobson merged 15 commits intoMetOffice:mainfrom
andrewcoughtrie:update_docs

Conversation

@andrewcoughtrie
Copy link
Collaborator

@andrewcoughtrie andrewcoughtrie commented Dec 16, 2025

PR Summary

Sci/Tech Reviewer: @stevemullerworth
Code Reviewer: @mike-hobson

Updated the readme file at the root of the repository to include a short introduction with some useful links and badges which describe the contents of the repository. The badges are generated by shields.io a common mechanism for doing so, the content produced by this page is under the CC0 license.

Code Quality Checklist

(Some checks are automatically carried out via the CI pipeline)

  • I have performed a self-review of my own code
  • My code follows the project's
    style guidelines
  • Comments have been included that aid undertanding and enhance the
    readability of the code
  • My changes generate no new warnings

Testing

  • I have tested this change locally, using the LFRic Core rose-stem suite
  • If required (eg. API changes) I have also run the LFRic Apps test suite
    using this branch
  • If any tests fail (rose-stem or CI) the reason is understood and
    acceptable (eg. kgo changes)
  • I have added tests to cover new functionality as appropriate (eg. system
    tests, unit tests, etc.)
  • Any new tests have been assigned an appropriate amount of compute resource
    and have been allocated to an appropriate testing group (i.e. the
    developer tests are for jobs which use a small amount of compute resource
    and complete in a matter of minutes)

trac.log

Security Considerations

  • I have reviewed my changes for potential security issues
  • Sensitive data is properly handled (if applicable)
  • Authentication and authorisation are properly implemented (if applicable)

Performance Impact

  • Performance of the code has been considered and, if applicable, suitable
    performance measurements have been conducted

AI Assistance and Attribution

  • Some of the content of this change has been produced with the assistance
    of Generative AI tool name (e.g., Met Office Github Copilot Enterprise,
    Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the
    Simulation Systems AI policy
    (including attribution labels)

Documentation

  • Where appropriate I have updated documentation related to this change and
    confirmed that it builds correctly

PSyclone Approval

  • If you have edited any PSyclone-related code (eg. PSyKAl-lite, Kernel
    interface, optimisation scripts, LFRic data structure code) then please
    contact the
    tooscollabdevteam@metoffice.gov.uk

Sci/Tech Review

  • I understand this area of code and the changes being added
  • The proposed changes correspond to the pull request description
  • Documentation is sufficient (do documentation papers need updating)
  • Sufficient testing has been completed

Please alert the code reviewer via a tag when you have approved the SR

Code Review

  • All dependencies have been resolved
  • Related Issues have been properly linked and addressed
  • CLA compliance has been confirmed
  • Code quality standards have been met
  • Tests are adequate and have passed
  • Documentation is complete and accurate
  • Security considerations have been addressed
  • Performance impact is acceptable

@github-actions github-actions bot added the cla-required The CLA has not yet been signed by the author of this PR - added by GA label Dec 16, 2025
@github-actions github-actions bot added cla-signed The CLA has been signed as part of this PR - added by GA and removed cla-required The CLA has not yet been signed by the author of this PR - added by GA labels Dec 17, 2025
@stevemullerworth
Copy link
Collaborator

Sci/tech review all fine

@andrewcoughtrie andrewcoughtrie added this to the Spring 2026 milestone Dec 17, 2025
Copy link
Contributor

@mike-hobson mike-hobson left a comment

Choose a reason for hiding this comment

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

Looks great.

@mike-hobson mike-hobson merged commit c2264f2 into MetOffice:main Dec 17, 2025
4 checks passed
Welcome to LFRic Core!

Location for LFRic infrastructure source code and documentation
LFRic Core provides the underlying infrastructure for the Momentum™ Atmosphere model and associated applications.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we use (registered)®, not (trademark)™ with Momentum®

@andrewcoughtrie andrewcoughtrie deleted the update_docs branch December 18, 2025 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The CLA has been signed as part of this PR - added by GA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants