Repository navigation
Add a VMEX interoperability example - #62
Draft
rogeriojorge wants to merge 8 commits into
Draft
rogeriojorge wants to merge 8 commits into
rogeriojorge wants to merge 8 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. |
rogeriojorge
force-pushed
the
docs/vmex-interop
branch
from
September 27, 2026 04:43
495228f to
94c38b2
Compare
rogeriojorge
marked this pull request as draft
October 3, 2026 03:55
ESSOS optimizes coils; the equilibrium those coils hold is what VMEX (pip install vmex) solves. The two meet without either importing the other, but nothing in the repository showed how. examples/simple_examples/equilibrium_from_coils_vmex.py takes the bundled Landreman-Paul QA Coils, tabulates their Biot-Savart field onto the cylindrical grid VMEX's free-boundary solver consumes, solves the vacuum free boundary, reads the result back as an essos.fields.Vmec and traces field lines through it. The rotational transform it measures agrees with VMEC's own iotaf to 1e-4 relative. Uses only released VMEX 0.6.0 (MgridField.from_cartesian_field, scale_input, solve_free_boundary, wout_from_state, write_wout), so it runs against the published wheel. README and getting_started gain a short section pointing at it.
rogeriojorge
force-pushed
the
docs/vmex-interop
branch
from
October 5, 2026 18:19
3ce1170 to
fce874a
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add an ESSOS-to-VMEX example: tabulate the coil field, solve a free-boundary equilibrium, write its wout, and trace field lines with ESSOS. README and getting-started links show the workflow.
The example uses released VMEX 0.6.0 APIs. Measured rotational transform at s=0.5 is 0.417488 from tracing versus 0.417531 from the equilibrium. A full CPU run and headless run completed; the recorded 79-test suite passed with one expected failure. Python 3.10–3.12 CI passes.
GPU execution was not tested. The tabulation wrapper can use
MgridField.from_coilswhen the minimum VMEX version is updated.