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

Update cryostat docs #3501

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

Update cryostat docs #3501

wants to merge 14 commits into from

Conversation

chris-ashe
Copy link
Collaborator

@chris-ashe chris-ashe commented Jan 25, 2025

Description

This pull request includes several changes to the naming conventions for cryostat-related variables across multiple files, ensuring consistency and clarity in the codebase. The most important changes involve renaming variables and updating documentation to reflect these changes.

🔄 Namespace changes

Variables

  • rdewex -> r_cryostat_inboard
  • rpf2dewar -> dr_pf_cryostat
  • hcryopf -> dz_pf_cryostat
  • zdewex -> dz_cryostat_half_inside
  • vdewex -> vol_cryostat
  • ddwex -> dr_cryostat
  • clhsf -> f_z_cryostat
  • clh1 -> dz_tf_cryostat

🐛 Bugs

  • The previous calculation for the bolume of the cryostat structure was:
fwbs_variables.vdewex = (
            (2.0 * np.pi * fwbs_variables.rdewex) * 2.0 * fwbs_variables.zdewex
            + (2.0 * np.pi * fwbs_variables.rdewex**2)
        ) * build_variables.ddwex

Which wasnt easy to interpret so a new model for the cryostat structure volume has been introduced which is simply
dividing the cryostat into 2 nested cylinders and taking the internal volume from the bigger one. This caused a 1% change in the calculated volume compared to the tests (810 -> 818 $m^3$)

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

codecov-commenter commented Jan 25, 2025

Codecov Report

Attention: Patch coverage is 46.42857% with 15 lines in your changes missing coverage. Please review.

Project coverage is 30.32%. Comparing base (f208c63) to head (327bb37).
Report is 24 commits behind head on main.

Files with missing lines Patch % Lines
process/io/plot_proc.py 0.00% 5 Missing ⚠️
process/build.py 0.00% 4 Missing ⚠️
process/stellarator.py 0.00% 4 Missing ⚠️
process/geometry/cryostat_geometry.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3501   +/-   ##
=======================================
  Coverage   30.31%   30.32%           
=======================================
  Files          80       80           
  Lines       19534    19537    +3     
=======================================
+ Hits         5922     5924    +2     
- Misses      13612    13613    +1     

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cryostat Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants