8000 Update portsz 1 by chris-ashe · Pull Request #3716 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update portsz 1 #3716

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

Merged
merged 1 commit into from
Jul 11, 2025
Merged

Update portsz 1 #3716

merged 1 commit into from
Jul 11, 2025

Conversation

chris-ashe
Copy link
Collaborator

This pull request primarily focuses on improving the clarity and consistency of variable naming in documentation and example data files related to neutral beam injection (NBI) models. It also introduces a detailed explanation of the beam tangency radius calculation and updates associated constraints.

Documentation updates:

  • Variable renaming for clarity:

    • Renamed frbeam to f_radius_beam_tangency_rmajor in culham_nb.md to better describe its purpose as the ratio of beam tangency radius to plasma major radius. This change is consistently applied across equations and descriptions. [1] [2] [3] [4] [5]
  • Beam tangency radius explanation:

    • Added a detailed explanation of the calculation for the maximum possible tangency radius (radius_beam_tangency_max) in nbi_overview.md. This includes geometric considerations and constraints based on TF coil dimensions.

Example data files updates:

  • Variable renaming in example files:
    • Updated variable name beamwd to dx_beam_duct in multiple example data files to align with the updated naming convention for the width of the neutral beam duct.

These changes improve the readability and consistency of the documentation and example data files, making it easier for users to understand and work with the NBI models.

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 requested a review from clmould July 11, 2025 09:13
@chris-ashe chris-ashe self-assigned this Jul 11, 2025
@chris-ashe chris-ashe added the Documentation Improvements or additions to documentation label Jul 11, 2025
@chris-ashe chris-ashe marked this pull request as ready for review July 11, 2025 09:13
g = \sqrt{e^2+f^2-2ef\cos{\phi}}
$$

If the value of $g$ is geater than $c$, then:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
If the value of $g$ is geater than $c$, then:
If the value of $g$ is greater than $c$, then:

@codecov-commenter
Copy link
codecov-commenter commented Jul 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.63%. Comparing base (275b570) to head (332a907).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3716   +/-   ##
=======================================
  Coverage   37.63%   37.63%           
=======================================
  Files          88       88           
  Lines       22830    22830           
=======================================
  Hits         8592     8592           
  Misses      14238    14238           

☔ 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 merged commit 805926d into main Jul 11, 2025
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0