vmec_jax.qi_diagnostics

First-class quasi-isodynamic diagnostic records.

This module centralizes the unweighted QI diagnostics used by optimization audits. It deliberately wraps the existing smooth QI, legacy QI, mirror-ratio, elongation, and LgradB implementations instead of defining a new objective.

Functions

annotate_qi_seed_suitability(record, *[, ...])	Return record with deterministic QI seed-ranking and gate fields.
qi_cleanup_candidate_promotable(candidate, *)	Annotate whether a QI cleanup candidate should replace a reference.
qi_diagnostics_from_boozer_output(booz, *[, ...])	Evaluate QI diagnostics from an existing Boozer output dictionary.
qi_diagnostics_from_state(*, state, static, ...)	Evaluate a complete QI diagnostic record from a solved VMEC state.
qi_promotion_score(record, *[, targets, ...])	Lexicographic score for promoting final QI optimization candidates.
rank_qi_seed_records(records, *[, targets])	Annotate and rank QI seed records by smooth+legacy QI quality.

Classes

QIDiagnosticOptions([surfaces, mboz, nboz, ...])	Resolution and threshold controls for QI diagnostic records.
QISeedSuitabilityTargets([smooth_qi_max, ...])	Promotion gates used to compare solved QI seed candidates.