Skip to content

📏 Tf plasma offset plot proc#3941

Merged
clmould merged 7 commits intomainfrom
tf_plasma_offset_plot_proc
Oct 24, 2025
Merged

📏 Tf plasma offset plot proc#3941
clmould merged 7 commits intomainfrom
tf_plasma_offset_plot_proc

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

@chris-ashe chris-ashe commented Oct 20, 2025

This pull request standardizes and clarifies variable naming related to the vertical and radial build of the toroidal field (TF) coil, updates documentation and input handling, and improves visualization in the plotting routines. The most significant changes are the renaming of key variables for consistency and clarity, updates to documentation and input files, and enhancements to the coil structure plot.

🔄 Variable renaming

  • tfoffset to dz_tf_plasma_centre_offset
  • Renamed tfootfi to f_dr_tf_outboard_inboard for the outboard/inboard TF coil thickness ratio,

Documentation and input/output updates:

  • Updated documentation in tf-coil.md to reflect new variable names and descriptions for user input parameters.
  • Updated input variable registration and obsolete variable mapping to use the new names.
  • Updated all example output data files to use the new variable names for TF coil vertical offset.

Plotting improvements:

  • Enhanced plot_tf_coil_structure in plot_proc.py by adding markers for the top and vertical center of the coil, a horizontal line at the coil center, and a label showing the offset between the coil center and plasma center for better visualization and clarity.
image

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 Oct 20, 2025
@chris-ashe chris-ashe added Input/Output Files Issues related to the input and output data files Variable rename labels Oct 20, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 20, 2025

Codecov Report

❌ Patch coverage is 45.45455% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.06%. Comparing base (4818b3b) to head (30f200a).

Files with missing lines Patch % Lines
process/io/plot_proc.py 0.00% 3 Missing ⚠️
process/build.py 0.00% 2 Missing ⚠️
process/stellarator.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3941      +/-   ##
==========================================
- Coverage   46.06%   46.06%   -0.01%     
==========================================
  Files         123      123              
  Lines       28467    28470       +3     
==========================================
  Hits        13114    13114              
- Misses      15353    15356       +3     

☔ 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 force-pushed the tf_plasma_offset_plot_proc branch from fceaabe to 9becc4e Compare October 20, 2025 21:31
@chris-ashe chris-ashe requested a review from j-a-foster October 21, 2025 09:53
@chris-ashe chris-ashe force-pushed the tf_plasma_offset_plot_proc branch 2 times, most recently from c419ecd to 1473604 Compare October 23, 2025 09:29
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.

@chris-ashe chris-ashe requested a review from clmould October 23, 2025 12:00
Comment thread process/io/plot_proc.py Outdated
marker="o",
color="blue",
markersize=5,
label="Vertical centre of coil",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

These labels are not being included in the legend?

image

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Just realised the legend is using the defined labels array to show the arc points. When I add the coil masses and areas section beside the plot in a (121) config I will put it into a real text box

@chris-ashe chris-ashe force-pushed the tf_plasma_offset_plot_proc branch from 8b3a084 to 6df243e Compare October 24, 2025 09:42
@chris-ashe chris-ashe force-pushed the tf_plasma_offset_plot_proc branch from 6df243e to 30f200a Compare October 24, 2025 09:43
@clmould clmould merged commit 57e4499 into main Oct 24, 2025
14 of 18 checks passed
@clmould clmould deleted the tf_plasma_offset_plot_proc branch October 24, 2025 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Input/Output Files Issues related to the input and output data files Variable rename

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants