Add generic vol avg profile function - #4568
Open
chris-ashe wants to merge 3 commits into
Open
Conversation
Collaborator
|
Am I mistaken here or is all of the changes hiding the main change which is just this?: |
Collaborator
Author
Yes, still WIP and needs cherry-picked |
chris-ashe
force-pushed
the
add_generic_vol_avg_profile_func
branch
from
September 2, 2026 09:49
73dbd76 to
a68739d
Compare
…ng parameter descriptions and raising conditions
chris-ashe
marked this pull request as ready for review
September 2, 2026 09:54
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4568 +/- ##
==========================================
- Coverage 49.85% 49.84% -0.02%
==========================================
Files 151 151
Lines 29875 29885 +10
==========================================
+ Hits 14894 14895 +1
- Misses 14981 14990 +9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new utility function for calculating the volume-averaged value of a radially normalized profile and adds detailed documentation explaining the mathematical derivation behind this calculation. These changes improve both code reusability and the clarity of the underlying physics for future developers and users.
New functionality
calculate_vol_avg_of_profile()toprocess/models/physics/profiles.py, which computes the volume-averaged value of a normalized radial profile, including comprehensive input validation.Documentation improvements
plasma_profiles.mdthat explains the derivation and usage of the volume-averaging calculation, including all relevant equations and context.Checklist
I confirm that I have completed the following checks: