⚡ Tidy superconductors.py part 1
#3657
Merged
Conversation
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
…rameterization and strain function notes
…d documentation and parameter definitions
…g_nb3sn` for clarity and consistency
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3657 +/- ##
=======================================
Coverage 36.23% 36.23%
=======================================
Files 88 88
Lines 22191 22191
=======================================
Hits 8041 8041
Misses 14150 14150 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…d update documentation
acb3037 to
98a54d9
Compare
j-a-foster
approved these changes
May 13, 2025
j-a-foster
approved these changes
May 13, 2025
j-a-foster
approved these changes
May 13, 2025
ym1906
pushed a commit
that referenced
this pull request
May 16, 2025
* 📝 Add Superconductors documentation page to navigation * 📝 Re-factor bottura scaling and add equations to docs * 📝 Enhance documentation for Bottura scaling function with detailed parameterization and strain function notes * 📝 Update WST Nb3Sn critical surface model implementation with enhanced documentation and parameter definitions * ♻️ Refactor superconductors function names to `western_superconducting_nb3sn` for clarity and consistency * 🎨 Add critical surface plot for Western Superconducting Ltd. Nb3Sn and update documentation * Implement code changes to enhance functionality and improve performance
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 introduces significant updates to the documentation, codebase, and testing infrastructure for the modeling of superconductors, specifically focusing on the Western Superconducting Nb₃Sn critical surface model. The changes include the addition of detailed documentation, the replacement of an older method (
wstsc) with a new implementation (western_superconducting_nb3sn), and the integration of this new implementation across various modules and tests.Documentation Enhancements:
superconductors.mdexplaining the Bottura scaling model and its application to Western Superconducting Nb₃Sn, including equations, parameter definitions, and references.Code Updates:
wstscfunction with the newwestern_superconducting_nb3snfunction inprocess/superconductors.py. The new implementation improves readability, adds type annotations, and provides detailed docstrings.wstscacross the codebase to usewestern_superconducting_nb3sn, ensuring consistency inpfcoil.py,stellarator.py,superconducting_tf_coil.py, andsuperconductors.py.Visualization:
plotting_scripts/western_nb3sn_critical_surface.py, to generate both static and interactive visualizations of the critical current density surface for Western Superconducting Nb₃Sn. The script uses Matplotlib and Plotly for visualization.Navigation and Testing:
mkdocs.ymlto include the new superconductors documentation.wstscto validate the newwestern_superconducting_nb3snfunction, ensuring the correctness of the updated implementation.Checklist
I confirm that I have completed the following checks: