8000 Refactor TF `supercon()` by chris-ashe · Pull Request #3698 · ukaea/PROCESS · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Refactor TF supercon() #3698

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Refactor TF supercon() #3698

wants to merge 5 commits into from

Conversation

chris-ashe
Copy link
Collaborator
@chris-ashe chris-ashe commented Jun 25, 2025 •
edited
Loading

This pull request refactors the SuperconParam class and updates its usage in test cases within the tests/unit/test_sctfcoil.py file. The changes focus on renaming variables to improve clarity and consistency, ensuring the codebase aligns with domain-specific terminology.

Refactoring for clarity and consistency:

  • tests/unit/test_sctfcoil.py: Renamed multiple attributes in the SuperconParam class to use more descriptive and domain-specific names, such as changing isumat to i_tf_superconductor and acs to a_tf_turn_cable_space. This improves readability and aligns the code with the terminology used in superconducting coil design.

Updates to test cases:

  • tests/unit/test_sctfcoil.py: Updated initialization of SuperconParam instances in test cases to reflect the new attribute names. For example, isumat=5 was changed to i_tf_superconductor=5. [1] [2] [3]
  • tests/unit/test_sctfcoil.py: Modified the test_supercon function to pass renamed attributes from SuperconParam to the sctfcoil.supercon method, ensuring compatibility with the updated class definition.

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 Jun 25, 2025
@chris-ashe chris-ashe added TF Coil Toroidal field coil Refactor labels Jun 25, 2025
@codecov-commenter
Copy link
codecov-commenter commented Jun 25, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 32.83582% with 45 lines in your changes missing coverage. Please review.

Project coverage is 37.73%. Comparing base (515f8c3) to head (ea4b0d1).

Files with missing lines Patch % Lines
process/superconducting_tf_coil.py 32.83% 45 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3698   +/-   ##
=======================================
  Coverage   37.73%   37.73%           
=======================================
  Files          88       88           
  Lines       22761    22761           
=======================================
  Hits         8588     8588           
  Misses      14173    14173

☔ 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 changed the title Refactor supercon tf Refactor TF supercon() Jun 25, 2025
@chris-ashe chris-ashe force-pushed the refactor_supercon_tf branch from 4ab1ad5 to ca6dcac Compare June 26, 2025 15:24
@chris-ashe chris-ashe marked this pull request as ready for review July 2, 2025 08:14
@chris-ashe chris-ashe requested a review from clmould July 2, 2025 08:14
@chris-ashe chris-ashe force-pushed the refactor_supercon_tf branch from ca6dcac to ea4b0d1 Compare July 3, 2025 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clmould clmould Awaiting requested review from clmould

At least 1 approving review is required to merge this pull request.

Assignees

@chris-ashe chris-ashe

Labels
Refactor TF Coil Toroidal field coil
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@chris-ashe @codecov-commenter
0