MHX documentation¶
MHX is a validation-first, differentiable JAX framework for magnetic reconnection and magnetohydrodynamics.
The active package is under src/mhx/.
Active scope boundaries¶
The current repository supports deterministic FAST validation, seed-robust QI,
fitted latent-ODE reproducibility, timing/readiness reports, nonlinear
reduced-MHD media examples such as double-Harris, Orszag–Tang, decaying
turbulence, and forced turbulent reconnection, plus short validation-grade
Rutherford executor chunks. The latest bounded GPU double-Harris campaign
(outputs/campaigns/gpu_nonlinear_20260522_085049/double_harris_long_n128_t160)
is gate_ready = true for validation media and
production_claim_ready = false; its promotion report explicitly permits only
claim_level_if_passed = "validation". Long nonlinear Rutherford/plasmoid
production campaigns are still gated as future production claims and must
pass duration, checkpoint-restart, convergence, seed/QI, positive
reconnecting-flux and island-width response, artifact-hash, and explicit
production-claim checks before being used as paper evidence.
Evidence guide¶
Start with these pages when checking validation evidence and scope boundaries:
Evidence map links claims to source files, tests, reproduction commands, artifacts, and explicit limitations.
Physics validation contains the equations, citations, still-figure gallery, and numerical gates that are intentionally kept out of the README.
Benchmark command index lists validation, scaffold, comparison, campaign, and neural-ODE commands with expected output families.
Validation movies separates solver-generated movies from theory schematics, documents the residual-flux media policy, and keeps the literature anchors next to the visuals.
Publication checklist states which figures are ready as validation evidence and which remain roadmap or production-only.
Nonlinear campaign evidence claims is the claim table plus reviewer commands for double-Harris, Rutherford, and forced turbulent-reconnection long-run evidence.
- Installation
- Tutorial: from first run to validation media
- Quickstart
- Reviewer evidence map
- Physics validation
- Exact resistive decay
- Nonlinear Orszag–Tang reduced-MHD gate
- Decaying turbulence and forced turbulent reconnection
- Validation figures
- Literature anchors
- Source links
- Seed-robust QI validation
- Reconnection scaling gates
- FKR constant-psi regime window
- FKR growth-rate gate
- Harris-sheet Delta-prime gate
- Direct Harris-sheet tearing eigenvalue gate
- Finite-domain tearing dispersion gate
- Harris eigenfunction layer gate
- Time-domain Harris eigenmode replay
- Matrix-free linearized RHS
- Reduced-MHD linear eigenmode gate
- Nonzero cosine-equilibrium linearization gate
- Periodic current-sheet eigenvalue gate
- Periodic current-sheet time-domain replay
- Nonlinear current-sheet differentiability bridge
- Periodic double-Harris nonlinear growth gate
- Seeded double-Harris long-run validation
- Seeded double-Harris convergence evidence
- Seeded double-Harris parameter sweeps
- Nonlinear reduced-MHD energy budget
- Nonlinear duration audit
- Duration-policy gate
- Diffusion eigenvalue scaffold
- Power-iteration scaffold
- Arnoldi Ritz-spectrum scaffold
- Benchmarks
- Architecture
- Reduced-MHD spectral smoke benchmark
- Diagnostics registry
- Output schema
- Run directory
- Manifest claim levels
trajectory.npzkeysdiagnostics.jsonkeys- Figures
- Reports
- Artifact manifests
- Paper-pipeline bundle
- Validation-suite outputs
- Campaign-template outputs
- FAST Rutherford runner outputs
- Seed-robust QI outputs
- Exact-decay validation outputs
- Reconnection scaling validation outputs
- FKR-window validation outputs
- FKR growth-rate validation outputs
- Harris Delta-prime validation outputs
- Direct Harris-sheet tearing eigenvalue outputs
- Finite-domain tearing dispersion outputs
- Harris tearing eigenfunction-layer outputs
- Harris tearing time-domain replay outputs
- Linearized-RHS validation outputs
- Reduced-MHD linear eigenmode outputs
- Cosine-equilibrium linearization outputs
- Periodic current-sheet eigenvalue outputs
- Periodic current-sheet time-domain outputs
- Nonlinear current-sheet bridge outputs
- Periodic double-Harris nonlinear-growth outputs
- Periodic double-Harris seeded long-run outputs
- Periodic double-Harris convergence outputs
- Periodic double-Harris parameter-sweep outputs
- Periodic double-Harris promotion report
- Nonlinear energy-budget outputs
- Nonlinear duration-audit outputs
- Duration-policy outputs
- Diffusion eigenvalue validation outputs
- Power-iteration validation outputs
- Arnoldi validation outputs
- Timing benchmark outputs
- Neural-ODE reproducibility outputs
- Benchmark catalog outputs
- Performance guide
- Long-run evidence
- Nonlinear campaign evidence claims
- Seed-robust QI lane
- Neural-ODE reproducibility and fitted latent-ODE lane
- Simulation time windows
- Production campaign templates
- Campaign runner operations
- Publication plot checklist
- Paper plan and claim boundaries
- Reproducible paper pipeline
- Validation media
- README media scope
- Residual-flux media policy
- At-a-glance media table
- README Harris-sheet reconnection previews
- Decaying and forced MHD turbulence
- Orszag–Tang nonlinear reduced-MHD vortex
- Harris tearing layer sweep
- Sweet-Parker plasmoid scaling schematic
- MHD turbulence cascade schematic
- Nonlinear validation movies
- Latest GPU validation media status
- Skeptical validation audit
- API compatibility policy
- Model assembly
- Physics plugins
- Release readiness
- Migration from legacy scripts
- Literature and code context
- API reference
DiagnosticsConfigMeshConfigNumericsConfigPhysicsConfigRunConfigTimeConfigload_config()CartesianGridfft_derivative()gradient()inverse_laplacian()laplacian()spectral_wavenumbers()current_density()finite_difference_linearized_reduced_mhd_rhs()linearized_reduced_mhd_operator()linearized_reduced_mhd_rhs()poisson_bracket()reduced_mhd_residual_norm()reduced_mhd_rhs()stream_function()DiagnosticContextDiagnosticSpecDiagnosticsRegistryFluxCriticalPointcompute_reduced_mhd_diagnostics()critical_points_by_kind()default_diagnostics_registry()detect_flux_critical_points()fit_exponential_growth()island_width_from_mode()kinetic_energy()load_diagnostics_entry_points()load_diagnostics_plugin_modules()magnetic_divergence_linf()magnetic_energy()mode_amplitude()reconnected_flux_amplitude()rutherford_island_full_width()select_fit_window()total_energy()track_critical_points()trajectory_energies()trajectory_mode_amplitude()ArnoldiValidationResultBenchmarkCatalogEntryCosineEquilibriumLinearizationResultDiffusionEigenvalueResultDurationAssessmentFKRConstantPsiEstimateFKRGrowthRateResultFKRWindowResultForcedTurbulentReconnectionReadinessAssessmentHarrisDeltaPrimeResultLinearTearingDispersionResultLinearTearingEigenvalueResultLinearTearingLayerResultLinearTearingTimeDomainResultLinearizedRHSResultNonlinearDurationAuditResultNonlinearEnergyBudgetResultOrszagTangVortexResultPaperPipelineResultPeriodicCurrentSheetEigenvalueResultPeriodicCurrentSheetNonlinearBridgeResultPeriodicCurrentSheetTimeDomainResultPeriodicDoubleHarrisConvergenceResultPeriodicDoubleHarrisNonlinearGrowthResultPeriodicDoubleHarrisParameterSweepResultPeriodicDoubleHarrisPromotionAssessmentPeriodicDoubleHarrisSeededLongRunResultPlasmoidScalingEstimatePowerIterationValidationResultQIMetricGateReadinessAssessmentReconnectionScalingResultReducedMHDLinearEigenmodeResultReleaseCandidateAssessmentResistiveDecayResultRutherfordCampaignRunResultRutherfordCampaignTemplateRutherfordFastCampaignResultSeedRobustQIResultSeedRobustQISweepResultTimingBenchmarkResultTimingCaseResultTurbulenceResultValidationSuiteCaseassess_duration()assess_forced_turbulent_reconnection_readiness()assess_periodic_double_harris_promotion()build_rutherford_campaign_template()compute_metric_statistics()default_seed_robust_qi_gates()double_harris_seeded_long_run_presets()duration_policy_assessments()fkr_constant_psi_estimate()generate_seed_ensemble()harris_sheet_delta_prime()ideal_tearing_aspect_ratio()linear_tearing_initial_state()loglog_slope()loureiro_plasmoid_estimate()make_seeded_initial_state()orszag_tang_initial_state()require_duration_for_claim()required_time_for_efolds()resistive_decay_rate()run_arnoldi_validation()run_cosine_equilibrium_linearization_validation()run_decaying_mhd_turbulence_validation()run_diffusion_eigenvalue_validation()run_fkr_growth_rate_validation()run_fkr_window_validation()run_forced_turbulent_reconnection_validation()run_harris_delta_prime_validation()run_linear_tearing_dispersion_validation()run_linear_tearing_eigenvalue_validation()run_linear_tearing_layer_validation()run_linear_tearing_smoke()run_linear_tearing_timedomain_validation()run_linearized_rhs_validation()run_nonlinear_duration_audit()run_nonlinear_energy_budget_validation()run_orszag_tang_vortex_validation()run_periodic_current_sheet_eigenvalue_validation()run_periodic_current_sheet_nonlinear_bridge_validation()run_periodic_current_sheet_timedomain_validation()run_periodic_double_harris_convergence_validation()run_periodic_double_harris_nonlinear_growth_validation()run_periodic_double_harris_parameter_sweep_validation()run_periodic_double_harris_seeded_long_run_validation()run_power_iteration_validation()run_readiness_assessment()run_reconnection_scaling_validation()run_reduced_mhd_linear_eigenmode_validation()run_release_candidate_assessment()run_resistive_decay_validation()run_rutherford_campaign_fast()run_seed_robust_qi()run_seed_robust_qi_sweep()run_seed_robust_qi_validation()run_timing_benchmark()seeded_perturbation()seeded_tearing_initial_state()turbulent_initial_state()validate_run()validation_catalog_entries()validation_suite_cases()write_arnoldi_validation()write_benchmark_catalog()write_cosine_equilibrium_linearization_validation()write_decaying_mhd_turbulence_validation()write_diffusion_eigenvalue_validation()write_duration_policy()write_fkr_growth_rate_validation()write_fkr_window_validation()write_forced_turbulent_reconnection_readiness_report()write_forced_turbulent_reconnection_validation()write_harris_delta_prime_validation()write_linear_tearing_dispersion_validation()write_linear_tearing_eigenvalue_validation()write_linear_tearing_layer_validation()write_linear_tearing_timedomain_validation()write_linearized_rhs_validation()write_nonlinear_duration_audit()write_nonlinear_energy_budget_validation()write_orszag_tang_vortex_validation()write_paper_pipeline()write_periodic_current_sheet_eigenvalue_validation()write_periodic_current_sheet_nonlinear_bridge_validation()write_periodic_current_sheet_timedomain_validation()write_periodic_double_harris_convergence_validation()write_periodic_double_harris_nonlinear_growth_validation()write_periodic_double_harris_parameter_sweep_validation()write_periodic_double_harris_promotion_report()write_periodic_double_harris_seeded_long_run_validation()write_power_iteration_validation()write_readiness_report()write_reconnection_scaling_validation()write_reduced_mhd_linear_eigenmode_validation()write_release_candidate_report()write_resistive_decay_validation()write_run_report()write_rutherford_campaign_fast()write_rutherford_campaign_template()write_seed_robust_qi()write_seed_robust_qi_sweep()write_seed_robust_qi_validation()write_timing_benchmark()write_validation_suite()FKRConstantPsiEstimatePlasmoidScalingEstimatefkr_constant_psi_estimate()harris_sheet_delta_prime()ideal_tearing_aspect_ratio()loureiro_plasmoid_estimate()ResistiveDecayResultresistive_decay_rate()run_resistive_decay_validation()write_resistive_decay_validation()ReconnectionScalingResultloglog_slope()run_reconnection_scaling_validation()write_reconnection_scaling_validation()TimingBenchmarkResultTimingCaseResultrun_timing_benchmark()write_timing_benchmark()BaselineEvaluationLatentODEFitNeuralODEDatasetSplitManifestbuild_seed_qi_trajectory_dataset()evaluate_baselines()evaluate_latent_ode_failure_modes()fit_latent_ode()make_train_val_test_split()write_neural_ode_reproducibility_bundle()write_neural_ode_training_bundle()BaselineEvaluationLatentODEFitNeuralODEDatasetSplitManifestbuild_seed_qi_trajectory_dataset()evaluate_baselines()evaluate_latent_ode_failure_modes()fit_latent_ode()make_train_val_test_split()write_neural_ode_reproducibility_bundle()write_neural_ode_training_bundle()ProductionCampaignPlanProductionExecutionResultProductionPromotionAssessmentResumePlanWalltimePolicyassess_rutherford_production_promotion()execute_rutherford_production_campaign()load_checkpoint_index()plan_rutherford_production_campaign()select_resume_checkpoint()write_checkpoint_metadata()write_rutherford_production_execution()write_rutherford_production_plan()write_rutherford_production_promotion_report()write_rutherford_resume_plan()ProductionCampaignPlanProductionExecutionResultProductionPromotionAssessmentResumePlanWalltimePolicyassess_rutherford_production_promotion()execute_rutherford_production_campaign()load_checkpoint_index()plan_rutherford_production_campaign()select_resume_checkpoint()write_checkpoint_metadata()write_rutherford_production_execution()write_rutherford_production_plan()write_rutherford_production_promotion_report()write_rutherford_resume_plan()CosineTearingEquilibriumElectronPressureTensorTermEquilibriumEquilibriumMetadataEquilibriumRegistryHyperResistivityTermPeriodicDoubleHarrisEquilibriumPhysicsRegistryPhysicsTermPhysicsTermMetadataToyHallOhmTermVorticityDragTermZeroEquilibriumapply_physics_terms()build_equilibrium()build_physics_terms()default_equilibrium_registry()default_physics_registry()load_physics_entry_points()load_physics_plugin_modules()CosineTearingEquilibriumEquilibriumEquilibriumMetadataEquilibriumRegistryPeriodicDoubleHarrisEquilibriumZeroEquilibriumbuild_equilibrium()default_equilibrium_registry()ElectronPressureTensorTermHyperResistivityTermPhysicsRegistryPhysicsTermPhysicsTermMetadataToyHallOhmTermVorticityDragTermapply_physics_terms()build_physics_terms()default_physics_registry()load_physics_entry_points()load_physics_plugin_modules()read_reduced_mhd_trajectory_npz()write_artifact_manifest()write_manifest()write_reduced_mhd_trajectory_npz()APIVersionInfoactive_api_version()api_version_info()require_supported_api_version()require_supported_claim_level()