♻️ Refactor CroCo routines and variables#3891
Merged
timothy-nunn merged 24 commits intomainfrom Oct 15, 2025
Merged
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3891 +/- ##
==========================================
- Coverage 46.40% 44.84% -1.56%
==========================================
Files 123 123
Lines 28173 30511 +2338
==========================================
+ Hits 13073 13684 +611
- Misses 15100 16827 +1727 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
22fb878 to
8ab24e4
Compare
…rity and consistency across the codebase
…rity and consistency across the codebase
…y and consistency across the codebase
…and consistency across the codebase
…d clarity and consistency across the codebase
…ed clarity and consistency across the codebase
… and consistency across the codebase
…stency across the codebase
…nd consistency across the codebase
…ity and consistency across the codebase
…clarity and consistency across the codebase
…es for improved clarity and consistency across the codebase
…arity and consistency across the codebase
…ferences for improved clarity and consistency across the codebase
…and areas for CroCo cable strand
…and update references in 'calculate_croco_cable_geometry' function for consistency
…ate references for clarity in CroCo strand area calculations
…cable geometry with detailed parameters
1a46c41 to
ea5bbd8
Compare
…tency in input validation
…geometry' function for clarity
timothy-nunn
requested changes
Oct 14, 2025
Collaborator
timothy-nunn
left a comment
There was a problem hiding this comment.
Couple of questions/minor changes. Havent checked documentation/eng-models/superconductors.md
470e384 to
69ab458
Compare
timothy-nunn
approved these changes
Oct 15, 2025
j-a-foster
approved these changes
Oct 15, 2025
Collaborator
j-a-foster
left a comment
There was a problem hiding this comment.
Happy with the image attached to the PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request refactors and standardizes the naming conventions for CroCo cable and REBCO tape geometry variables throughout the codebase, updates related documentation, and introduces a new plotting function for CroCo cable geometry. The changes improve code clarity, consistency, and maintainability, and provide better documentation and visualization of CroCo cable geometry.
A new function
calculate_croco_cable_geometry()has been made to specifically calculate the cable dimensions🔄 Variable renaming and standardization (most impactful):
rebco_thickness,copper_thick,croco_od, andcroco_thickwith standardized names:croco_od->dia_croco_strandcroco_thick->dx_croco_strand_copperrebco_thickness->dx_hts_tape_rebcocopper_thick->dx_hts_tape_copperhastelloy_thickness->dx_hts_tape_hastelloystack_thickness->dx_croco_strand_tape_stacktape_thickness->dx_hts_tape_totaltape_width->dr_hts_tapetapes->n_croco_strand_hts_tapesrebco_area->a_croco_strand_rebcohastelloy_area->a_croco_strand_hastelloysolder_area->a_croco_strand_soldercroco_id->dia_croco_strand_tape_regioncopper_area->a_croco_strand_copper_totalcroco()->calculate_croco_cable_geometry()❇️ New variables
a_croco_strandDocumentation updates:
superconductors.mdto describe the CroCo cable geometry calculation with clear variable mappings to code identifiers, improving traceability between theory and implementation.CroCo cable geometry plotting:
plot_corc_cable_geometrytoprocess/io/plot_proc.pyfor visualizing CroCo strand geometry, including copper jacket, solder, HTS tape stack, and individual tape layers.Data structure and initialization improvements:
process/data_structure/rebco_variables.pyto use the new standardized names and added descriptive comments for each variable.Function and interface updates:
superconpf,supercon_croco) to use the new variable names, ensuring consistency and reducing confusion.Checklist
I confirm that I have completed the following checks: