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

#1351 - Support for user-defined kernels that operate on DoFs #2556

Merged
merged 12 commits into from
May 13, 2024

Conversation

oakleybrunt
Copy link
Collaborator

@oakleybrunt oakleybrunt commented Apr 23, 2024

Towards #1351

This PR adds the documentation for DoF Kernels, part of a 3-step process of documentation, metadata checks, and code generation.

@oakleybrunt oakleybrunt added the LFRic Issue relates to the LFRic domain label Apr 23, 2024
@oakleybrunt oakleybrunt self-assigned this Apr 23, 2024
Copy link

codecov bot commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.86%. Comparing base (91119cd) to head (abd9101).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2556   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files         357      357           
  Lines       48339    48339           
=======================================
  Hits        48273    48273           
  Misses         66       66           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@oakleybrunt oakleybrunt requested review from TeranIvy and arporter and removed request for TeranIvy May 1, 2024 12:22
Copy link
Member

@arporter arporter left a comment

Choose a reason for hiding this comment

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

Thanks for this Oakley. I think you've mostly got the top-level rules sorted but you're missing a section on the rules for the kernel subroutine itself - see inline. Note I've brought the branch up to master so you'll need to pull before you make changes.

doc/user_guide/dynamo0p3.rst Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
@oakleybrunt
Copy link
Collaborator Author

Thanks for this Oakley. I think you've mostly got the top-level rules sorted but you're missing a section on the rules for the kernel subroutine itself - see inline. Note I've brought the branch up to master so you'll need to pull before you make changes.

Hey Andy, thanks for your comments. I completely overlooked this, ha! You're right, the subroutine rules will be quite simple. I've added them now so I'll re-request a review.

doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
Copy link
Member

@arporter arporter left a comment

Choose a reason for hiding this comment

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

Thanks Oakley. Looking pretty good now. I've realised we're missing the rather crucial OPERATES_ON for this kernel type and I found another bit of the docs that need updating.
We also need to be clear that support for this new kernel type is not yet implemented (a slight disadvantage of doing things this way but the overhead shouldn't be too bad).

When this is "ready for review" again, please could you add the appropriate label to the PR - that makes it easy for me to see in the list of PRs.

doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Show resolved Hide resolved
Copy link
Member

@arporter arporter left a comment

Choose a reason for hiding this comment

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

Thanks for making those changes. I've taken the liberty of fixing a couple of typos and this is now ready to go once the CI has passed.

doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
doc/user_guide/dynamo0p3.rst Outdated Show resolved Hide resolved
@arporter arporter merged commit 7c51abc into master May 13, 2024
11 checks passed
@arporter arporter deleted the 1351-dof-kernels branch May 13, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LFRic Issue relates to the LFRic domain ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants