Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
vmec-jax 0.0.14 documentation
vmec-jax 0.0.14 documentation

User guide

  • Overview
  • Installation
  • Quickstart
  • Optimisation with vmec_jax
  • Optimization Sweep Results

Physics and algorithms

  • Theory and conventions
  • Equations and derivations
  • VMEC wiki primer (for vmec-jax parity)
  • Algorithms
  • Discrete-adjoint differentiation
  • Piecewise-Omnigenous Optimization Plan
  • Comparison with SIMSOPT
  • JXBFORCE / Mercier Diagnostics (jdotb, DMerc, D_R)
  • Bootstrap-Current Fixed-Point Plan

Validation and release

  • Validation and parity with VMEC2000
  • Testing, Coverage, and Repository Size Strategy
  • Release checklist
  • Optional validation plan
  • Free-Boundary Plan
  • Free-Boundary Coil Optimization
  • Performance notes

Development notes

  • Aggressive Performance Plan
  • Optimized Fixed-Boundary Merge Notes
  • Code structure
  • Contributing
  • References

API reference

  • API reference
    • Public API
    • vmec_jax package
      • vmec_jax.boundary
      • vmec_jax.bootstrap_current
      • vmec_jax.config
      • vmec_jax.coords
      • vmec_jax.diagnostics
      • vmec_jax.energy
      • vmec_jax.external_fields
        • vmec_jax.external_fields.base
        • vmec_jax.external_fields.coils_jax
        • vmec_jax.external_fields.essos_adapter
        • vmec_jax.external_fields.mgrid_jax
      • vmec_jax.field
      • vmec_jax.fieldlines
      • vmec_jax.finite_beta
      • vmec_jax.fourier
      • vmec_jax.free_boundary_validation
      • vmec_jax.free_boundary_adjoint
      • vmec_jax.free_boundary_adjoint_controller
      • vmec_jax.geom
      • vmec_jax.grids
      • vmec_jax.implicit
      • vmec_jax.init_guess
      • vmec_jax.integrals
      • vmec_jax.mercier
      • vmec_jax.modes
      • vmec_jax.namelist
      • vmec_jax.optimization
      • vmec_jax.qi_optimization
      • vmec_jax.optimization_workflow
      • vmec_jax.profiles
      • vmec_jax.qi_diagnostics
      • vmec_jax.quasi_isodynamic
      • vmec_jax.quasisymmetry
      • vmec_jax.radial
      • vmec_jax.redl_bootstrap
      • vmec_jax.residuals
      • vmec_jax.robust_coils
      • vmec_jax.solve
      • vmec_jax.state
      • vmec_jax.static
      • vmec_jax.visualization
      • vmec_jax.vmec_constraints
      • vmec_jax.vmec_bcovar
      • vmec_jax.vmec_forces
      • vmec_jax.vmec_jacobian
      • vmec_jax.vmec_parity
      • vmec_jax.vmec_residue
      • vmec_jax.vmec_tomnsp
      • vmec_jax.wout
Back to top
View this page

API referenceΒΆ

This section is generated from docstrings using Sphinx autodoc.

  • Public API
  • vmec_jax package
    • Submodules
Next
Public API
Previous
References
Copyright © 2026, vmec_jax contributors
Made with Sphinx and @pradyunsg's Furo