API: vaft.diagram
Generated from each module's __all__ by python -m vaft._api_catalog:
222 published objects in 3 modules.
Signatures and summaries are read from the source; nothing here is written by hand.
All API pages
No object matches.
vaft.diagram
Reproducible scientific schematics (issue #890).
adapter_contract_map — Which VAFT code adapter consumes which ordering contract, and in what role. Reference source
analytic_mhd_equilibrium — Analytic MHD equilibria: forward generation and projection onto a Solov’ev basis. Reference source
ballooning_boundary_conditions — Two ways to close the field line: decay on the covering space, or a sheared parallel join. Reference source
ballooning_curvature_drive — Normal curvature and the total ballooning drive along the extended angle. Reference source
ballooning_eigenfunction — A ballooning mode: localised on the extended angle where the curvature is bad. Reference source
ballooning_formulation_hierarchy — How the reduced $s$-$\alpha$ model and the full-geometry ballooning codes relate. Reference source
ballooning_harmonic_envelope — A ballooning mode is many coupled harmonics $m \approx nq$ under one envelope. Reference source
ballooning_newcomb_test — Newcomb’s test on the extended angle: stable, unstable and second stable. Reference source
ballooning_transit_map — Where the extended angle is in the cross-section: one poloidal circle per transit. Reference source
ballooning_workflow — From global harmonics to the infinite-$n$ ballooning equation, and the coordinate genealogy. Reference source
basin_of_attraction — Branch selection by the initial condition: two stable solutions at one control parameter. Reference source
blob_current_closure — Where the polarization current of a filament closes: the sheaths or the cross-field inertia. Reference source
blob_polarization — Why a blob moves: curvature polarizes it into a dipole, and the dipole drifts it. Reference source
blob_regimes — The two-region regime plane of blob motion: collisionality against size. Reference source
blob_velocity_scaling — Normalized blob velocity against normalized size: two closures, their crossing, and the bridge. Reference source
branch_bifurcation — Stable and unstable branches, two folds, the jumps and the hysteresis loop. Reference source
branch_selection — Physical branch selection beside numerical cycling: the two causes of non-convergence side by side. Reference source
canonical_toroidal_momentum — $P_\phi = q\psi + mv_\parallel Rb_\phi$ along one banana: the parts trade, the sum stays. Reference source
clebsch_field_line_label — A field line is where $\psi$ = const meets $\alpha$ = const. Reference source
cocos_orientation — What a COCOS index fixes, on a generic poloidal cross-section: one panel per index. Reference source
cold_vde_bifurcation — Cold VDE as the loss of a centred vertical equilibrium while the current decays (schematic). Reference source
collision_processes — Collision processes in fusion plasmas: Coulomb, atomic and nuclear. Reference source
complex_field_superposition — External and plasma-response fields add as complex numbers. Reference source
complex_harmonic — One harmonic as a complex coefficient $\hat b = b_R + i\,b_I = A\,e^{i\alpha}$. Reference source
computational_realization — How a model is evaluated: analytical, semi-analytical, reduced numerical, fully numerical. Reference source
coordinates_vs_cocos — Coordinate choice and COCOS convention are independent axes, not branches of one tree. Reference source
current_diffusion — Ohmic current diffusion after a fast ramp: hollow current, reversed shear, relaxation. Reference source
current_drive_profiles — Ohmic, ECCD and NBCD: actuator $\to$ source $j_\mathrm{drive}(\rho)$ $\to$ total $j_\phi(\rho, t)$ $\to$ $q(\rho, t)$. Reference source
current_profile_shapes — Current-profile shapes at the same $I_p$: $j(r) \to I(r) \to B_\theta(r) \to l_i$. Reference source
current_sheet — A current sheet seen along the current: reversing field, sheet, normal, thickness, $J_z$. Reference source
current_to_q_profile — From the current profile to the safety factor: $j(r) \to B_\theta(r) \to q(r)$. Reference source
cylindrical_mode_morphology — The poloidal mode number as a shape: sausage, kink, and higher helical distortions. Reference source
cylindrical_rational_surfaces — For one $n$, every $m$ with $q_0 < m/n < q_a$ has its rational surface $q(r_s) = m/n$. Reference source
cylindrical_tearing_outer — The outer tearing solution of one rational surface on the cylinder, and where the inner layer takes over. Reference source
delta_prime — What $\Delta’$ measures: the slope jump of the outer solution across $r_s$. Reference source
Diagram
class
source
Diagram(name: str, scene: Scene, *, model=None)
A built scientific diagram: TikZ source now, SVG on first request.
4 members
tikzproperty — The complete LaTeX/TikZ document. Needs no TeX installation. sourcesource_sha256property — Hash oftikzandRENDER_RECIPE: what the committed-asset check compares. sourcesvgproperty — The rendered, normalised SVG text. Renders on first access. sourcesavemethod — Write the diagram in one ofSAVE_FORMATS:.svg(canonical),.texor.pdf. source
DiagramToolchainError
class
source
The TeX tools a render needs are not on PATH.
disruption_causal_chain — The thermal-quench -> current-quench -> runaway chain as cause and effect. Reference source
disruption_energy_pathways — Where a disruption’s thermal and magnetic energies go. Reference source
disruption_timeline — A disruption on one time axis, from a 0-D reference model built of the formulas. Reference source
divertor_heat_footprint — An Eich heat-flux profile on the divertor target of a diverted equilibrium. Reference source
equilibrium_problem_taxonomy — Forward/inverse and fixed/free boundary are two axes, not one. Reference source
experiment_modeling_theory_data_network — Why a common fusion data model: four research modes, pairwise against a shared representation. Reference source
experimental_research_infrastructure — Experimental research, fragmented and integrated: why a Common Data Model alone is not enough (#1636). Reference source
external_code_integration — How an independently maintained scientific code becomes a reproducible VAFT capability. Reference source
EXTERNAL_CODES
data
EXTERNAL_CODES = <builtins.tuple>
fast_magnetosonic_wave — Fast magnetosonic polarization at $\mathbf k \perp \mathbf B_0$: compression and rarefaction. Reference source
field_aligned_basis — Why a field-aligned system is simple: two coordinates are constant along the field, one follows it. Reference source
field_aligned_xpoint_limitation — Why field-aligned and flux coordinates fail at the X-point, on the diverted toy equilibrium. Reference source
field_line_action_angle — Straight-field-line coordinates are the action-angle variables of the field-line flow. Reference source
field_line_geometry — The same field-line structure in toroidal, cylindrical and local sheared-slab geometry. Reference source
field_line_pitch — A field line on a toroidal surface and its field $\mathbf B = B_\phi\hat{\boldsymbol\phi} + B_\theta\hat{\boldsymbol\theta}$. Reference source
fixed_vs_free_boundary_equilibrium — The boundary as an input against the boundary as part of the solution. Reference source
flux_coordinates — Flux coordinates $(\psi, \theta, \phi)$ on a shaped cross-section. Reference source
flux_tube_patch — From a tokamak flux surface to a local flux tube: one surface, one line, its neighbourhood, a box. Reference source
formalism_axes_map — The independent axes of a plasma-formalism record, with three runs drawn across them. Reference source
fusion_research_ecosystem — Who does fusion research, what they do, and the shared scientific states that connect it (#1643). Reference source
fusion_science_knowledge_lifecycle — The research-learning cycle the infrastructure enables: from experiment back to experiment. Reference source
geometry_to_mesh — Geometry, then regions, then mesh: the numerical workflow, not one code’s. Reference source
grad_shafranov_domain_decomposition — Same flux function, different sources: plasma, vacuum and coil regions of one elliptic problem. Reference source
grid_induced_two_cycle — A numerical 2-cycle: the discrete state hops between two adjacent grid nodes. Reference source
guiding_center_invariants — Gyration, bounce and toroidal drift, and the invariant each carries. Reference source
harmonic_real_space_projection — From a complex coefficient to the real field it stands for, $\mathrm{Re}[\hat b\,e^{i(m\theta - n\phi)}]$. Reference source
hfs_lfs_field — $B_\phi \propto 1/R$: the high-field side is inboard, the low-field side outboard. Reference source
hot_vde_sequence — A hot VDE: the plasma drifts into the wall, is scraped, and its edge $q$ falls at constant $I_p$. Reference source
hugill — Hugill diagram: $1/q_\mathrm{cyl}$ against the Murakami parameter $\bar n R/B$. Reference source
hugill_st — Spherical-tokamak Hugill diagram: $1/q^{ST}_\mathrm{cyl}$ against $\bar n R/B$ (Sykes et al. 2000, MAST). Reference source
integrated_modeling_process — How models interact: a graph of models, data and states with typed couplings. Reference source
integrated_modeling_space — The three axes combined: where models sit, and what character they have. Reference source
integrated_scientific_framework — The research modes and their common state inside one integrated framework, serving analysis (#1698). Reference source
interchange_criteria — Suydam’s and Mercier’s local interchange criteria across one schematic profile. Reference source
internal_external_kink — Internal kink: displacement inside $q = 1$; external kink: displacement reaching the boundary. Reference source
interoperability_layers — Interoperability as layers: from the machine to scientific workflows, in both directions. Reference source
island_formation — From a sheared field to a magnetic island: slab_perturbed_flux with growing tearing amplitude. Reference source
iteration_behavior — Four iteration behaviours in one format: state $x_k$ against iteration $k$. Reference source
kinetic_efit — Kinetically constrained reconstruction: magnetic constraints plus kinetic pressure points. Reference source
kinetic_mhd_coupling — Kinetic-MHD as a loop between a fluid bulk and a drift-kinetic population. Reference source
kink_mode — A prescribed $m/n$ ideal displacement drawn on an equilibrium’s own flux surfaces. Reference source
knowledge_basis — Where a model’s knowledge comes from: first-principles to data-driven. Reference source
li_qa — The $l_i$-$q$ diagram of one source: Wesson 1989 (JET, empirical) or Cheng 1987 (theory). Reference source
limiter_and_diverted_topologies — Where the plasma ends: limiter contact against an X-point separatrix. Reference source
logical_to_physical_mapping — A regular logical mesh $(\xi, \eta)$ mapped onto curved flux-aligned coordinates in $(R, Z)$. Reference source
machine_agnostic_architecture — A machine-agnostic scientific framework for integrated fusion research. Reference source
machine_and_equilibrium_geometry — Machine geometry against equilibrium geometry: built objects against found ones. Reference source
machine_research_archive — The machine and research archive: VEST’s institutional and scientific memory since 2012. Reference source
magnetic_efit — Magnetic equilibrium reconstruction: a free-boundary inverse problem. Reference source
magnetic_island — Schematic of an $m/n$ magnetic island in one of three projections. Reference source
magnetic_reconnection — Model-neutral 2-D reconnection: inflow, outflow, diffusion region, upstream and reconnected field. Reference source
magnetic_shear_field_aligned — Magnetic shear rotates the phase fronts of a field-aligned mode as it is followed along the line. Reference source
magnetization_current — Gyrating ions in a bounded region: interior currents cancel, the edge carries one. Reference source
mhd_mode_geometry_map — MHD mode families across slab, cylindrical and toroidal geometry, with typed relations. Reference source
mhd_wave_family — The Friedrichs diagram: phase speed against the angle to $\mathbf B_0$, three branches. Reference source
mode_number_mapping — $(m, n) \to (k_y, k_z)$: the rational surface is where $k_\parallel = 0$. Reference source
nbi_neutral_attenuation — Neutral survival and fast-ion birth along the beam path, and the shine-through at the exit. Reference source
nbi_particle_lifecycle — What happens to a beam particle, and the three different ways it is lost. Reference source
neo_neoclassical — Neoclassical transport: Sauter / Redl fits and NEO at one state. Reference source
neoclassical_collisionality — Banana, plateau and Pfirsch–Schl"uter: the axisymmetric neoclassical regimes. Reference source
normal_field_component — $\delta B_n = \delta\mathbf B\cdot\hat{\mathbf n}$: the part of a perturbation that crosses a surface. Reference source
ntv_collisionality — Shaing’s NTV regimes: the non-resonant and resonant branches of the flux against collisionality. Reference source
ntv_precession_regimes — Collisionality alone does not fix the NTV regime: the precession plane. Reference source
o_mode_cutoff — O-mode refractive index against frequency: propagation above $\omega_{pe}$, evanescence below. Reference source
ordering_contract_map — Which reduced model assumes which ordering, read from the registered contracts. Reference source
parameter_inference_dependency_graph — How provenance propagates through inferred plasma parameters (#1601). Reference source
parameter_inference_overview — Where plasma parameter inference sits between reconstruction and simulation (#1601). Reference source
physical_abstraction — At what description level the system is represented, and how each level reduces to the next. Reference source
physical_to_flux_mapping — Measurements at $(R, Z)$ become a profile in $\psi_N$: two halves of a chord, one curve. Reference source
plasma_model_reduction_map — One starting point and the reductions to every description VAFT uses. Reference source
plasma_parameter_inference — Electron profiles and the equilibrium resolved into T_i, the species mix and the local state. Reference source
plasma_state_provenance — Where each quantity of a plasma state comes from: measured, reconstructed, assumed or derived. Reference source
plasma_vacuum_wall — One harmonic across plasma, vacuum and an ideal conducting wall. Reference source
plasma_wall_halo_current — Wall contact in a VDE: one halo-current circuit, the eddy currents, and the force on the wall. Reference source
plasma_wall_interaction_angle_dependence — Normal and grazing incidence side by side, angles measured from the surface normal. Reference source
plasma_wall_interaction_energy_partition — Particle balance and energy balance, side by side: not the same bookkeeping. Reference source
plasma_wall_interaction_particle_balance — The projectile’s particle balance, and the target-material source beside it, not inside it. Reference source
plasma_wall_interaction_processes — One ion impact and its outcomes, the projectile and target species kept apart. Reference source
plasma_wall_interaction_recycling — Reflection, re-emission and retention as flux bookkeeping. Reference source
plasma_wall_interaction_reflection — Particle reflection: incident and reflected energy and angle are separate quantities. Reference source
plasma_wall_interaction_reflection_energy — Incident energy to reflected energy: two distributions joined by the surface interaction. Reference source
plasma_wall_interaction_sputtering — Physical sputtering by a light projectile: backscatter from below ejects a surface atom. Reference source
plasma_wall_interaction_sputtering_threshold — Sputtering yield against incident energy: a threshold, drawn qualitatively. Reference source
plasma_wall_interaction_surface_response — The generic surface-response model: what a PWI backend takes in and returns. Reference source
poloidal_angle_comparison — The geometric poloidal angle and the straight-field-line angle $\theta^*$ are different coordinates. Reference source
poloidal_flux_source_decomposition — $\psi_\mathrm{plasma} + \psi_\mathrm{coil} = \psi_\mathrm{total}$: the topology belongs to the sum. Reference source
poloidal_harmonic_coupling — Toroidicity couples $m$ to $m \pm 1$, elongation to $m \pm 2$, at fixed $n$. Reference source
profile_propagation — O- and X-mode $n^2$ along the midplane of an example tokamak, with its cutoff and resonance layers. Reference source
q_profile_landmarks — Where $q_0$, $q_\min$, $q_{95}$ and the edge $q_a$ sit on one safety-factor profile. Reference source
q_profile_topologies — Monotonic, weak-shear and reversed-shear $q$, each from its current shape, with the sign of the shear. Reference source
rational_surface — Where a helical perturbation resonates: the rational surface $q(r_s) = m/n$. Reference source
rational_surface_topology — How one $m/n$ meets each $q$ topology: once on a monotonic $q$, twice on a reversed-shear $q$. Reference source
reduced_model_ancestry — Parent theory, model reduction and computational realization of every reduced mode. Reference source
reduced_representation_hierarchy — Spatial reduction and dimensionless normalisation as two independent axes. Reference source
reduced_representation_hierarchy_compact — The two-axis representation hierarchy with symbols only, compactly spaced. Reference source
refractive_index_vs_X — $n^2$ against $X = \omega_{pe}^2/\omega^2$ at fixed $Y$: rising density at one frequency and field. Reference source
refractive_index_vs_Y —
| $n^2$ against $Y = | \Omega_e | /\omega$ at fixed $X$: rising field at one frequency and density. |
research_modality_architecture — Research software, locked in and modular: one scientific core, many ways to research (#1640). Reference source
resistive_zeff_inference — The resistively equivalent scalar Zeff a conductivity model needs to match the observed resistance. Reference source
resonant_layer_matching — Several rational surfaces, each with a tearing and a twisting channel, matched through the outer region. Reference source
ripple_well_formation — Along a field line the ripple makes local wells where $\alpha^* < 1$. Reference source
romero_transformer_balance — Plasma resistance from Romero’s exact transformer balance. Reference source
runaway_generation — Dreicer and avalanche generation against the field, and the regimes they define. Reference source
s_alpha_ballooning — First and second ballooning stability in the circular $s$-$\alpha$ model. Reference source
safety_factor_winding — $q$ is the number of toroidal turns a field line makes per poloidal turn. Reference source
sawtooth — A reduced, Kadomtsev-like sawtooth crash in one of three states, on an equilibrium’s surfaces. Reference source
scientific_credibility — Scientific credibility, fragmented and qualified: why reproducibility is not enough (#1638). Reference source
scientific_infrastructure_principles — Two complementary foundations of VAFT, converging on one infrastructure. Reference source
scientific_ownership_architecture — Where scientific logic lives as research software matures (#1645). Reference source
scientific_provenance_chain — Traceable provenance: every scientific product points to its inputs, configuration and version. Reference source
scientific_representation — Scientific representation, fragmented and layered: one meaning, many representations and names (#1641). Reference source
scientific_workflow — A managed scientific processing pipeline: heterogeneous sources to qualified, analysis-ready data. Reference source
separatrix_lobes — Stable and unstable manifolds of a perturbed X-point, and the lobes between them. Reference source
sfl_coordinate_grids — PEST, Boozer, Hamada and equal-arc on the same equilibrium: only the angle changes. Reference source
sfl_coordinate_taxonomy — Flux coordinates, the straight-field-line condition, and what each named choice fixes. Reference source
sfl_coordinate_validity — Where nested-surface straight-field-line coordinates hold, and where they fail. Reference source
sfl_fourier_convergence — The same physical perturbation has a different poloidal spectrum in each straight-field-line angle. Reference source
shaping_family — Elongation $\kappa$ and triangularity $\delta$ on one boundary family. Reference source
shear_alfven_wave — Shear Alfven polarization: field-line bending without compression. Reference source
slab_field_configuration — Field direction on stacked $x$ = const sheets: uniform, sheared, reversed, guide-field. Reference source
slab_parity — Tearing or twisting parity at a rational surface, as contours of the helical flux. Reference source
slab_parity_comparison — Tearing and twisting parity side by side, with what tells them apart. Reference source
software_dependency_ecosystem — Which software capabilities are core, and which an extra or development install activates. Reference source
solver_placement_map — Every VAFT adapter mode against the main formalism axes, then the codes not in VAFT. Reference source
spatial_scale_orderings — The lengths of one illustrative state on a logarithmic axis, with the ratios that order them. Reference source
spectroscopy_energy_levels — The hydrogenic level ladder, with the Lyman, Balmer and Paschen series. Reference source
spectroscopy_ionization_stages — All ionization stages of an element, the one a term names highlighted. Reference source
spectroscopy_spectrum — Declared spectral lines on a wavelength axis, each at the wavelength its label states. Reference source
spectroscopy_transitions — The transition behind one emission term, with no more metadata than exists. Reference source
stability_diagnostic_taxonomy — Reduced MHD stability diagnostics by physical problem and logical status. Reference source
stochastic_layer — Island overlap on an equilibrium: a Poincare section of two resonant harmonics. Reference source
stochastic_ripple_orbit — Ripple kicks at successive banana tips decorrelate above the GWB threshold. Reference source
structured_rz_grid — A structured $(R, Z)$ grid: rectangular computational domain, curved plasma boundary. Reference source
tearing_layer_matching — Why tearing theory splits the plasma into ideal outer regions and a thin inner layer. Reference source
tglf_cgyro_local_transport — Local turbulent transport: TGLF and CGYRO from one local state. Reference source
timescale_hierarchy — The timescales of one illustrative state on a logarithmic axis, with the ratios that order them. Reference source
tokamak_top_view — The torus seen from above: machine centre, major radius $R$ and toroidal angle $\phi$. Reference source
tokamak_torus — The tokamak torus: major radius $R_0$, minor radius $a$, toroidal $\phi$ and poloidal $\theta$. Reference source
toroidal_field_ripple — $N_\mathrm{TF}$ discrete coils corrugate $B(\phi)$ around the smooth $1/R$ field. Reference source
toroidal_harmonic_phase — The toroidal mode number is the rate at which the phase winds around the torus. Reference source
toroidal_symmetry_breaking — Axisymmetry keeps $P_\phi$; a 3-D field changes it, secularly only at resonance. Reference source
trapped_and_passing_orbits — The $1/R$ mirror: passing orbits go round, trapped ones bounce as bananas. Reference source
troyon — Troyon diagram: toroidal beta against the normalised current $I_p/(aB_T)$. Reference source
unwrapped_flux_surface — On an unwrapped flux surface a field line is straight in $(\theta^, \phi)$: $d\phi/d\theta^ = q$. Reference source
vaft_four_pillars — The four pillars of VAFT, under its purpose and on its design principles. Reference source
vest_data_platform — The VEST data platform: a per-shot database at the centre of experiment, inference and simulation. Reference source
vest_data_platform_overview — The VEST data platform in five stages, for papers, slides and introductions. Reference source
wall_conditioning_baking — Baking: external heat desorbs water and gases from the wall into the pump. Reference source
wall_conditioning_boronization — Boronization: a B-containing precursor in a deposition plasma coats the wall. Reference source
wall_conditioning_gdc — Glow-discharge cleaning: one apparatus template, gas-specific content. Reference source
wall_conditioning_sequence — Conditioning stages in order, each a transition of the wall state. Reference source
wave_dispersion_omega_k — The cold electron plasma in the $\omega$-$k$ plane: where each branch exists and where it ends. Reference source
vaft.diagram.docs_catalog
The canonical diagrams as a deterministic snapshot for the documentation site.
ASSET_DIR
data
ASSET_DIR = <pathlib.PosixPath>
builder_names
function
source
builder_names() -> list[str]
Public builders: the functions of vaft.diagram.__all__, in its order.
documentation_snapshot
function
source
documentation_snapshot(provenance: Mapping[str, str] | None = None) -> dict
Builders in __all__ order, grouped by the module that defines them, and their assets.
export_documentation_snapshot
function
source
export_documentation_snapshot(output: str | Path, provenance: Mapping[str, str] | None = None) -> Path
Write the YAML snapshot and return its path.
formula_references
function
source
formula_references(module_path: Path, builder: str) -> list[str]
vaft.formula functions reachable from builder in its own module.
main
function
source
main(argv: list[str] | None = None) -> None
SCHEMA_VERSION
data
SCHEMA_VERSION = 1
vaft.diagram.ml
Portable ML computational and scientific graphs (#2015).
extract_torch_graph
function
source
extract_torch_graph(module, args, *, name='model', method='fx', provenance=None)
Observe a model copy on example positional inputs (including dictionaries).
GraphEdge
class
source
GraphEdge(source: str, target: str, coupling: str = 'data_flow', evidence: str = 'executed') -> None
4 fields
source: strtarget: strcoupling: strevidence: str
GraphExtraction
class
source
GraphExtraction(graph: MLGraph | None, method: str, diagnostics: tuple[str, ...] = ()) -> None
3 fields · 1 members
graph: MLGraph | Nonemethod: strdiagnostics: tuple[str, ...]supportedproperty source
GraphNode
class
source
GraphNode(key: str, label: str, kind: str = 'operation', tensors: tuple[TensorDescriptor, ...] = (), module: str = '', parameter_count: int = 0, unit: str = '', convention: str = '') -> None
8 fields
key: strlabel: strkind: strtensors: tuple[TensorDescriptor, ...]module: strparameter_count: intunit: strconvention: str
MLGraph
class
source
MLGraph(name: str, nodes: tuple[GraphNode, ...], edges: tuple[GraphEdge, ...], parameter_count: int = 0, method: str = 'semantic', limitations: tuple[str, ...] = (), provenance: Mapping = <factory>) -> None
7 fields · 3 members
scientific_graph_diagram
function
source
scientific_graph_diagram(graph)
Render a declared scientific graph using VAFT’s existing scene/TikZ API.
TensorDescriptor
class
source
TensorDescriptor(shape: tuple, dtype: str) -> None
2 fields
shape: tupledtype: str
Modules without a declared public surface
These modules declare no __all__, so this reference cannot tell what they publish and lists nothing
from them (docs/api_inventory.yml). Some are reached through a package that re-exports and declares
them – vaft.omas publishes the functions of the wrapper modules it star-imports, under vaft.omas
above – and the rest are described in the hand-written guides until they declare one:
vaft.diagram.build.