📝 Reconfigure tf docs 1 #3704

chris-ashe · 2025-07-03T07:51:19Z

This pull request introduces detailed documentation updates for resistive and superconducting TF (toroidal field) coils, along with navigation improvements in the mkdocs.yml file. The changes provide comprehensive descriptions of coil geometries, parametrization options, material properties, and constraints for both coil types, enhancing clarity and usability for engineering modeling.

Documentation Updates for TF Coils:

Resistive TF Coil:

Added detailed descriptions of resistive coil geometry, including the bucking cylinder, conductor area, and outer cylinder. Included figures to illustrate the coil structure and turns.
Described the resistive center-post geometry used in spherical tokamaks, with options for setting the top radius (r_cp_top) and considerations for resistive heating and cooling.
Provided equations for calculating the inboard peak field radius and added a new class definition for ResistiveTFCoil.

Superconducting TF Coil:

Documented the geometry of superconducting TF coils, including winding pack and steel casing, along with parametrization options for radial sizes, case geometry, and winding pack shapes.
Explained turn geometry, cable composition, and critical current density constraints for superconducting materials, with options for material selection and technology adjustment factors.
Included equations for calculating the inboard peak field radius and added a new class definition for SuperconductingTFCoil.

Navigation Improvements:

Updated mkdocs.yml to include separate sections for "Resistive TF Coil" and "Superconducting TF Coil" under the "TF Coil" category for better organization and accessibility.## Description

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.

…d update navigation structure in mkdocs.yml

…ding class definitions and structural details

…e, and conductor types - Consolidated and clarified the topology of TF coils and central solenoid, including options for ITER-like and alternative configurations. - Revised descriptions of TF coil shapes, introducing D-shape and picture frame options with clear definitions. - Updated the section on TF coil conductor types, detailing resistive and superconducting magnets with associated cooling methods. - Removed redundant sections and improved overall structure for better readability and coherence.

…ing TF coil documentation

codecov-commenter · 2025-07-03T07:54:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3704   +/-   ##
=======================================
  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.

j-a-foster

Happy with changes.

* 📝 Add new documentation for Resistive and Superconducting TF Coils and update navigation structure in mkdocs.yml * 📝 Add documentation for Resistive and Superconducting TF coils, including class definitions and structural details * Refactor TF coil documentation: streamline sections on topology, shape, and conductor types - Consolidated and clarified the topology of TF coils and central solenoid, including options for ITER-like and alternative configurations. - Revised descriptions of TF coil shapes, introducing D-shape and picture frame options with clear definitions. - Updated the section on TF coil conductor types, detailing resistive and superconducting magnets with associated cooling methods. - Removed redundant sections and improved overall structure for better readability and coherence. * 📝 Add inboard peak field radius section to Resistive and Superconducting TF coil documentation

chris-ashe added 4 commits July 3, 2025 08:50

📝 Add new documentation for Resistive and Superconducting TF Coils an…

306d202

…d update navigation structure in mkdocs.yml

📝 Add documentation for Resistive and Superconducting TF coils, inclu…

3a0f06b

…ding class definitions and structural details

📝 Add inboard peak field radius section to Resistive and Superconduct…

d4a2083

…ing TF coil documentation

chris-ashe self-assigned this Jul 3, 2025

chris-ashe added Documentation Improvements or additions to documentation TF Coil Toroidal field coil labels Jul 3, 2025

chris-ashe requested a review from j-a-foster July 3, 2025 07:51

chris-ashe assigned j-a-foster Jul 3, 2025

j-a-foster approved these changes Jul 4, 2025

View reviewed changes

chris-ashe merged commit 05d0a8d into main Jul 4, 2025
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

📝 Reconfigure tf docs 1 #3704

📝 Reconfigure tf docs 1 #3704

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

📝 Reconfigure tf docs 1 #3704

📝 Reconfigure tf docs 1 #3704

Uh oh!

Conversation

Documentation Updates for TF Coils:

Resistive TF Coil:

Superconducting TF Coil:

Navigation Improvements:

Checklist

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!