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

🚧 3388 update the beta limit section of the docs to be up to date and include all models #3389

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

chris-ashe
Copy link
Collaborator

@chris-ashe chris-ashe commented Nov 8, 2024

Namespace changes

Functions

  • culblm() -> calculate_beta_limit()

Variables

  • betaft -> fast_alpha_beta
  • iculbl -> i_beta_component
  • betalim ->beta_limit_upper
  • betalim_lower -> beta_limit_lower
  • betpmx -> beta_poloidal_max
  • fbetap -> fbeta_poloidal
  • betap -> beta_poloidal
  • betat -> beta_toroidal: Added now as a proper physics variable that can be seen in output
  • betath -> beta_thermal: Added now as a proper physics variable that can be seen in output

New additions

  • beta_toroidal: Was originally calculated but never set to a variable
  • beta_thermal: Was originally calculated but never set to a variable
  • beta_thermal_poloidal: Was originally calculated but never set to a variable
  • beta_thermal_toroidal: Was originally calculated but never set to a variable
  • norm_beta_thermal: Was originally calculated but never set to a variable
  • norm_beta_toroidal: Was originally calculated but never set to a variable
  • norm_beta_poloidal: Was originally calculated but never set to a variable
  • norm_beta_total: Was originally calculated but never set to a variable

🐛 Bugs

  • normalised_total_beta was set as a variable but not put to output

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 8, 2024
@chris-ashe chris-ashe added the Documentation Improvements or additions to documentation label Nov 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 8, 2024

Codecov Report

Attention: Patch coverage is 30.30303% with 23 lines in your changes missing coverage. Please review.

Project coverage is 28.26%. Comparing base (73d1488) to head (6daf8c5).

Files with missing lines Patch % Lines
process/physics.py 35.71% 18 Missing ⚠️
process/physics_functions.py 0.00% 4 Missing ⚠️
process/stellarator.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3389      +/-   ##
==========================================
- Coverage   28.27%   28.26%   -0.01%     
==========================================
  Files          77       77              
  Lines       18428    18434       +6     
==========================================
  Hits         5210     5210              
- Misses      13218    13224       +6     

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

@chris-ashe chris-ashe force-pushed the 3388-update-the-beta-limit-section-of-the-docs-to-be-up-to-date-and-include-all-models branch from 0765fbe to 480b79d Compare November 8, 2024 17:42
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.

Update the beta limit section of the docs to be up to date and include all models
2 participants