simsopt
simsopt copied to clipboard
Vmec Compute Geometry
The vmec_compute_geometry function is the primary access point for computing basic quantities from a vmec equilibrium. Currently, the output of this function is lacking somewhat. It would be useful to expand the output of this function to compute more quantities, and to also expand the documentation of this function to show all of the quantities being computed (currently the documentation is not up-to-date).
The gold standard is to have something like the DESC list of variables which shows all quantities which are computed and their code name.
The goals of this issue are three-fold:
- Make sure that
vmec_compute_geometrycomputes every basic quantity that is needed. - Rewrite the documentation so that it is clear what is being computed and how they can be accessed.
- Promote the
vmec_compute_geometryfunction by putting it in the VMEC tutorial and other places, so that users can easily find it.