Skip to content

MOCIlib documentation#54

Merged
Erica Neininger (ericaneininger) merged 4 commits into
MetOffice:mainfrom
Pierre-siddall:add-mocilib-docs
May 8, 2026
Merged

MOCIlib documentation#54
Erica Neininger (ericaneininger) merged 4 commits into
MetOffice:mainfrom
Pierre-siddall:add-mocilib-docs

Conversation

@Pierre-siddall
Copy link
Copy Markdown
Contributor

@Pierre-siddall Pierre Siddall (Pierre-siddall) commented May 7, 2026

PR Summary

Code Reviewer: Erica Neininger (@ericaneininger)

This PR intends to begin the process of documenting the newly added MOCIlib so that developers have better information on how to use the functions which MOCIlib implements.

closes #52

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 Moci rose-stem suite
  • 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.)

Test Suite Results - moci - test_new_docs_addition/run1

Suite Information

Item Value
Suite Name test_new_docs_addition/run1
Suite User pierre.siddall
Workflow Start 2026-05-07T09:50:47
Groups Run all
Dependency Reference Main Like
moci Pierre-siddall/moci@add-mocilib-docs False
SimSys_Scripts MetOffice/SimSys_Scripts@main True

Task Information

✅ succeeded tasks - 115

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

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

@Pierre-siddall Pierre Siddall (Pierre-siddall) added the documentation Improvements or additions to documentation label May 7, 2026
@Pierre-siddall Pierre Siddall (Pierre-siddall) marked this pull request as ready for review May 7, 2026 10:23
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.

Can we please use "MOCI" (capitalised) since it is an acromym (Met Office Coupling Infrastructure)

Otherwise this is a sensible start.

@Pierre-siddall Pierre Siddall (Pierre-siddall) changed the title mocilib documentation MOCIlib documentation May 8, 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.

Thanks for the update.

@ericaneininger Erica Neininger (ericaneininger) merged commit 17516f6 into MetOffice:main May 8, 2026
8 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.

Begin documenting mocilib

3 participants