-
Notifications
You must be signed in to change notification settings - Fork 29
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
Minor fixes for docs #1498
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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 |
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.
make requested change in notebook
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. |
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.
change VMEC load part again
Can we do this after #1425 |
Note about kernel stuff: The important name of the environment for CI tests to pass is the This problem probably arise from the difference between VS Code's jupyter notebook extension and jupyter lab. VS-CODE doesn't change the |
use_outputs.ipynb
VMECIO.load
exampleWe 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
andOptimization 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.