-
Notifications
You must be signed in to change notification settings - Fork 17
♻️ Refactor CroCo routines and variables #3891
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
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of questions/minor changes. Havent checked documentation/eng-models/superconductors.md
470e384 to
69ab458
Compare
j-a-foster
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy with the image attached to the PR.
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: