vmec_jax package

vmec_jax re-exports a broad convenience surface for interactive use, but the stable user-facing entrypoints are documented in Public API.

For lower-level work, import the specific submodule you need rather than depending on the full package re-export surface. The submodule reference below is the authoritative API documentation for those internal layers.

Submodules

vmec_jax.boundary	Boundary coefficient handling.
vmec_jax.bootstrap_current	Bootstrap-current profile updates for finite-beta VMEC inputs.
vmec_jax.config	High-level configuration extracted from VMEC input (&INDATA).
vmec_jax.coords	Geometry evaluation on the (s,theta,zeta) grid.
vmec_jax.diagnostics	Lightweight diagnostic helpers.
vmec_jax.energy	Energy functionals.
vmec_jax.external_fields	External magnetic-field providers for free-boundary VMEC calculations.
vmec_jax.field	Magnetic field representation utilities.
vmec_jax.fieldlines	Field-line tracing utilities.
vmec_jax.finite_beta	Finite-beta optimization diagnostics and residual helpers.
vmec_jax.fourier	Helical Fourier basis utilities.
vmec_jax.free_boundary_validation	Validation metrics for free-boundary finite-beta response.
vmec_jax.free_boundary_adjoint	Adjoint scaffolding for free-boundary vacuum solves.
vmec_jax.free_boundary_adjoint_controller	JAX-visible nonlinear-controller primitives for free-boundary adjoints.
vmec_jax.geom	Geometry and metric/Jacobian utilities.
vmec_jax.grids	Angle grids consistent with VMEC conventions.
vmec_jax.implicit	Implicit differentiation utilities.
vmec_jax.init_guess	Initial guess construction.
vmec_jax.integrals	Angle and radial integrals.
vmec_jax.mercier	Differentiable Mercier and JXBFORCE algebra kernels.
vmec_jax.modes	Mode tables matching VMEC's conventions.
vmec_jax.namelist	Minimal parser for VMEC-style Fortran namelist (&INDATA).
vmec_jax.optimization	Optimization-oriented helpers for vmec_jax workflows.
vmec_jax.qi_optimization	Support routines for staged bounded QI optimization.
vmec_jax.optimization_workflow	Reusable teaching workflow helpers for fixed-boundary optimizations.
vmec_jax.profiles	VMEC profile evaluation.
vmec_jax.qi_diagnostics	First-class quasi-isodynamic diagnostic records.
vmec_jax.quasi_isodynamic	Differentiable quasi-isodynamic residuals.
vmec_jax.quasisymmetry	JAX-native quasisymmetry diagnostics from VMEC-JAX states.
vmec_jax.radial	Radial operators for vmec_jax.
vmec_jax.redl_bootstrap	Differentiable Redl bootstrap-current algebra.
vmec_jax.residuals	Force/residual diagnostics.
vmec_jax.robust_coils	Pure-JAX utilities for deterministic robust-coil perturbation studies.
vmec_jax.solve	Fixed-boundary solvers.
vmec_jax.state	State layout helpers.
vmec_jax.static	Static (compile-time) data for vmec_jax.
vmec_jax.visualization	Visualization helpers (VTK export, field-line traces).
vmec_jax.vmec_constraints	VMEC constraint pipeline pieces (alias / gcon) for parity work.
vmec_jax.vmec_bcovar	VMEC-style half-mesh metric + B-covariant ingredients.
vmec_jax.vmec_forces	VMEC force/residue kernels for parity work.
vmec_jax.vmec_jacobian	VMEC-style half-mesh Jacobian construction.
vmec_jax.vmec_parity	VMEC parity helper kernels.
vmec_jax.vmec_residue	VMEC residue/getfsq-style scalar residuals for parity work.
vmec_jax.vmec_tomnsp	VMEC Fourier transform conventions (fixaray + tomnsps) for parity work.
vmec_jax.wout	Minimal wout_*.nc reader helpers.