Skip to content
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

Minor fixes for docs #1498

Merged
merged 15 commits into from
Jan 22, 2025
Merged

Minor fixes for docs #1498

merged 15 commits into from
Jan 22, 2025

Conversation

YigitElma
Copy link
Collaborator

@YigitElma YigitElma commented Dec 27, 2024

  • Fixes 3D plot issue in use_outputs.ipynb
  • Adds VMECIO.load example
  • Renames some notebooks
  • Refactors documentation main titles for easy access

We have many tutorials but our search engine is not good enough for finding stuff quickly. I renamed some notebooks and divided tutorials section of docs into 3 main parts, namely Guides (general stuff like installation, performance hints, using outputs etc.), Equilibrium Solve Tutorials and Optimization Tutorials. Technically, we treat equilibrium solve as optimization but I think we need some subsections in our tutorials and this separation was the best I could find.

@YigitElma YigitElma added easy Short and simple to code or review skip_changelog No need to update changelog on this PR labels Dec 27, 2024
@YigitElma YigitElma requested a review from a team December 27, 2024 22:23
@YigitElma YigitElma self-assigned this Dec 27, 2024
@YigitElma YigitElma requested review from rahulgaur104, f0uriest, ddudt, dpanici, kianorr, sinaatalay and unalmis and removed request for a team December 27, 2024 22:23
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

review-notebook-app bot commented Jan 2, 2025

View / edit / reply to this conversation on ReviewNB

dpanici commented on 2025-01-02T01:43:46Z
----------------------------------------------------------------

add a note that this is only a fit and not a true equilibrium, and one must run eq.solve or solve_continuation_automatic

also that it will fit the iota profile with a spline by default, and which profile it uses (current or iota) is changed with the profile kwarg of VMECIO.load


Copy link
Collaborator

@dpanici dpanici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make requested change in notebook

@YigitElma YigitElma requested review from dpanici and unalmis January 2, 2025 18:39
Copy link

review-notebook-app bot commented Jan 3, 2025

View / edit / reply to this conversation on ReviewNB

dpanici commented on 2025-01-03T20:41:42Z
----------------------------------------------------------------

It is not that you have to specify the profile, it works perfectly fine if you don't specify bc it defaults to iota. It is just good practice to to ensure you know what profile you are fixing. Also put that the profile specified will be created by spline-fitting the profile from the .nc file.


Copy link
Collaborator

@dpanici dpanici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change VMEC load part again

@f0uriest
Copy link
Member

f0uriest commented Jan 3, 2025

Can we do this after #1425

@YigitElma
Copy link
Collaborator Author

YigitElma commented Jan 8, 2025

Note about kernel stuff: The important name of the environment for CI tests to pass is the name not display_name. As long as the name in kernel_spec is python3, it is fine, whatever the display_name is.

This problem probably arise from the difference between VS Code's jupyter notebook extension and jupyter lab. VS-CODE doesn't change the name only changes display_name so it works.

rahulgaur104
rahulgaur104 previously approved these changes Jan 8, 2025
f0uriest
f0uriest previously approved these changes Jan 21, 2025
@YigitElma YigitElma added the override codecov Override codecov label Jan 22, 2025
@dpanici dpanici merged commit 1b5fbff into master Jan 22, 2025
26 checks passed
@dpanici dpanici deleted the yge/3dplot_fix branch January 22, 2025 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Short and simple to code or review override codecov Override codecov skip_changelog No need to update changelog on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants