3208 update the plasma profiles section of the docs to include all new models #3256
Conversation
This file contains 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
Refactor the Profile class in profiles.py to improve code structure and readability. Also, add detailed documentation to explain the purpose and functionality of the class and its methods.
Update the navigation structure in the mkdocs.yml file to include sub-pages for the Profiles section. This change adds separate pages for the Overview, Density Profile, Temperature Profile, and Profile Base Class. It also updates the Composition & Impurities page and adds a new Radiation page. This improves the organization and accessibility of the Plasma Profiles documentation.
…le class documentation
Refactor the Profile class in profiles.py to enhance code structure and readability. Additionally, add comprehensive documentation to clarify the purpose and functionality of the class and its methods.
Update the parameterization method in the PlasmaProfile class to handle the case where ipedestal is equal to 0. This improves the accuracy and reliability of the plasma profile calculations.
…vative plots for the profile graidants
18 tasks
…he-docs-to-include-all-new-models
j-a-foster
requested changes
Jul 24, 2024
j-a-foster
approved these changes
Jul 24, 2024
chris-ashe
deleted the
3208-update-the-plasma-profiles-section-of-the-docs-to-include-all-new-models
branch
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.
Description
This change sees a large expansion to the documentation for the plasma profiles.
All functions that calculate the plasma profiles are now documented along with full derivations of all the maths involved.
The
profiles.pyandplasma_profiles.pyfiles have also been updated to be more pythonic with some functions now utilising modern library'sThe re-derivation for the pedestal profiles showed some errors in the original calculations which showed periodic variation in the core temperature value for increasing$\alpha_T$ . The top figure is the newly derived continuous function, the middle is the non-continuous function for non-integer values and the bottom plot is the difference between the two.
Checklist
I confirm that I have completed the following checks: