Skip to content

🎨 Add effective charge and ionisation profiles to plot_proc#3977

Merged
timothy-nunn merged 12 commits intomainfrom
zeff_and_charge_profiles
Nov 17, 2025
Merged

🎨 Add effective charge and ionisation profiles to plot_proc#3977
timothy-nunn merged 12 commits intomainfrom
zeff_and_charge_profiles

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

@chris-ashe chris-ashe commented Nov 7, 2025

This pull request standardizes the naming conventions for electric charge-related variables and updates example data files to reflect these changes. The main focus is on replacing the old zeff and zeffai identifiers with new, more descriptive variable names that follow the updated standards. Additionally, documentation is improved to clarify the new conventions.

✨ New variables

  • n_charge_plasma_effective_profile
  • n_charge_impurity_profile

🔄 Renames

  • zeff -> n_charge_plasma_effective_vol_avg
  • zeffai -> n_charge_plasma_effective_mass_weighted_vol_avg

📓 Documentation

  • Added explicit naming conventions for electric charge variables in documentation/development/standards.md, introducing the charge_ and n_charge_ prefixes for electric charges and charge numbers, respectively.

🎨 Output

image

These changes ensure consistency and clarity in variable naming, making the codebase easier to maintain and understand.## Description

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@chris-ashe chris-ashe self-assigned this Nov 7, 2025
@chris-ashe chris-ashe added Physics Relating to the physics models Input/Output Files Issues related to the input and output data files Impurities Plasma impurities labels Nov 7, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 7, 2025

Codecov Report

❌ Patch coverage is 20.00000% with 96 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.01%. Comparing base (b143420) to head (46226ea).

Files with missing lines Patch % Lines
process/io/plot_proc.py 4.00% 72 Missing ⚠️
process/physics.py 23.07% 20 Missing ⚠️
process/current_drive.py 50.00% 2 Missing ⚠️
process/output.py 0.00% 1 Missing ⚠️
process/stellarator.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3977      +/-   ##
==========================================
- Coverage   46.09%   46.01%   -0.08%     
==========================================
  Files         123      123              
  Lines       28888    28957      +69     
==========================================
+ Hits        13316    13325       +9     
- Misses      15572    15632      +60     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@chris-ashe chris-ashe marked this pull request as ready for review November 7, 2025 13:47
Copy link
Copy Markdown
Collaborator

@j-a-foster j-a-foster left a comment

Choose a reason for hiding this comment

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

Happy with changes. Some of the variable replaces need checking though.

@chris-ashe chris-ashe force-pushed the zeff_and_charge_profiles branch from d35bb8e to b81bc25 Compare November 13, 2025 08:37
Copy link
Copy Markdown
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

Whoops, missed the error on two of the regression tests

@chris-ashe chris-ashe force-pushed the zeff_and_charge_profiles branch from b81bc25 to 951a65c Compare November 14, 2025 13:05
@timothy-nunn timothy-nunn merged commit 6fe7ee6 into main Nov 17, 2025
14 of 18 checks passed
@timothy-nunn timothy-nunn deleted the zeff_and_charge_profiles branch November 17, 2025 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Impurities Plasma impurities Input/Output Files Issues related to the input and output data files New Variables Physics Relating to the physics models Variable rename

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants