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

UW-653 controller key path #604

Merged

Conversation

maddenp-noaa
Copy link
Contributor

Synopsis

To support coupled driver applications where subcomponents defer to a "controller" component's config block for their execution and/or rundir values, we initially implemented a single key identifying to identify the controller component's block at the top of the config. In UW YAML in general, however, config blocks can be nested arbitrarily deeply, and a key path provided to navigate to them. This PR adds the ability to locate the controller component's block via an arbitrary key path. This is a breaking change because the controller argument now requires list[str] value; but we only have a single coupled component at the moment, so it should be an easy update when this change is released in a future v2.5.0.

Type

  • Enhancement (adds new functionality)

Impact

  • This is a breaking change (changes existing functionality)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.

@maddenp-noaa maddenp-noaa self-assigned this Sep 6, 2024
@maddenp-noaa maddenp-noaa marked this pull request as ready for review September 9, 2024 13:59
@maddenp-noaa maddenp-noaa changed the title UW 653 controller key path UW-653 controller key path Sep 9, 2024
Copy link
Contributor

@WeirAE WeirAE left a comment

Choose a reason for hiding this comment

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

Thats a good catch, it should be fine to set now and update for the release!

@maddenp-noaa maddenp-noaa merged commit 4e67e51 into ufs-community:main Sep 10, 2024
2 checks passed
@maddenp-noaa maddenp-noaa deleted the uw-653-controller-key-path branch September 10, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants