Skip to content

Reworked Configuration Namelist Access API#175

Merged
allynt merged 37 commits intoMetOffice:mainfrom
mo-rickywong:ConfigTypeAccess
Feb 2, 2026
Merged

Reworked Configuration Namelist Access API#175
allynt merged 37 commits intoMetOffice:mainfrom
mo-rickywong:ConfigTypeAccess

Conversation

@mo-rickywong
Copy link
Contributor

@mo-rickywong mo-rickywong commented Dec 10, 2025

PR Summary

Sci/Tech Reviewer: @allynt
Code Reviewer: @MatthewHambley

This PR is to allow users more direct access to the namelist configuration values from
Fortran object (rather than global module scope) while maintaining it's read-only nature.
e.g.
modeldb%config%<MyNamelist>%MyNamelistMember()

This PR is linked to LFRic-core trac ticket #4702, which provides more details on the change itself

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 understanding 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

@mo-rickywong mo-rickywong requested a review from a team as a code owner December 10, 2025 13:38
@mo-rickywong mo-rickywong requested review from MatthewHambley and removed request for a team December 10, 2025 13:38
@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 10, 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 11, 2025
Copy link
Collaborator

@MatthewHambley MatthewHambley left a comment

Choose a reason for hiding this comment

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

I notice that across the board you assign namelist values to variables before using them. Can you confirm this is a choice you've made and that, as functions, they can be used in-line. e.g. call something(value, modeldb%config%my_namelist%other_value().

Yes this is a choice, the values can be accessed in-line. I have extracted them as the variables existed and shortens the actual code so it appears cleaner.

Copy link
Collaborator

@MatthewHambley MatthewHambley left a comment

Choose a reason for hiding this comment

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

Not too many changes, some of which may be postponed to later sets.

Copy link
Collaborator

@MatthewHambley MatthewHambley left a comment

Choose a reason for hiding this comment

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

There's still much to be done to tidy things up but this gets the basic functionality in place.

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.

From a code owner's point of view, this seems fine.

:param duplicate: Is this namelist allowed multiple instances.
"""
self._namelists.append(name)
self._duplicates.append(duplicate)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd agree w/ @MatthewHambley, having synchronised lists to track whether namelist n allows duplicates seems a bit fragile. A list of objects might be more robust. And, the @dataclass decorator makes creating an object much easier. Something like:

@dataclass
class NamelistDetails:
  name: str
  duplicate: Optional[bool] = False

class AppConfiguration:
  def __init__(self, module_name: str):
    ...
    self._namelist_details: List[NamelistDetails] = []
    ...

   def add_namelist(self, name: str, duplicate: bool) -> None:
     ...
     self._namelist_details.append(NamelistDetails(name, duplicate))
    ...

But that would require a big chunk of rewriting, so perhaps create a new issue? (I'm willing to do the work).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree it's not the best and is definitely fragile. Though in defence, most users will not be running this manually from the command line. The input is determined from the json file that is generated from rose_picker (or other application).

This PR is definitely an iteration to get the new api up and running, I've create issue #260 for this and assigned it to @allynt as requested

mo-rickywong and others added 4 commits January 30, 2026 10:57
…ml_iterator_mod.f90

Co-authored-by: allynt <allyn.treshansky@gmail.com>
…ration.rst

Co-authored-by: allynt <allyn.treshansky@gmail.com>
…ration.rst

Co-authored-by: allynt <allyn.treshansky@gmail.com>
Copy link
Contributor

@allynt allynt left a comment

Choose a reason for hiding this comment

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

LGTM

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.

5 participants