Vmec tutorial

[ejpaul]

This PR adds a tutorial on running VMEC. Some text is incorporated from the docstring in vmec.py, while additional material related to input parameters, interpretation of output, and debugging has been contributed.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.46%. Comparing base (dd721ab) to head (0a19ab6). Report is 40 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #511      +/-   ##
==========================================
+ Coverage   92.33%   92.46%   +0.12%     
==========================================
  Files          83       82       -1     
  Lines       16051    15995      -56     
==========================================
- Hits        14821    14790      -31     
+ Misses       1230     1205      -25     

Flag	Coverage Δ
unittests	92.46% <ø> (+0.12%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[mbkumar]

If it helps https://simsopt.readthedocs.io/en/vmec_tutorial/example_vmec.html

[ejpaul]

There is some commonality between the high-level MHD code integration that I have in #508 and here.

Could you review that PR, and align with it?

As a tutorial I would also like to see a bit more code, and discussion of inputs/outputs. Could you step through a simplified version of the LandremanPaul optimisation?

I have referenced this tutorial to/from your new MHD page.

I have added more text blocks with example input parameters from example scripts.

Since this is a tutorial on running VMEC, not optimizing VMEC, I'm not discussing any optimization inputs.

I have dedicated sections discussing inputs/outputs, so please be more specific about what you are looking for in this regard.

[mishapadidar]

I think this tutorial looks fantastic. Thank you, Elizabeth. I caught one small typo above. I am happy to have this merged! I think many users will be happy to see this tutorial.

[ejpaul]

Thanks @mishapadidar. I fixed the typo, and I think it's ready to go.