---

NEOPAX documentation

Welcome to NEOPAX! This is a Python package in JAX to perform optimization of Neoclassical and 1D transport calculations in JAX

Contents:

• Overview
  • Capabilities And Advantages
  • Equations Solved
  • Algorithms And Numerical Methods
  • Flux Models
  • Source Models
  • Benchmarks And Current Validation
  • See Also
• Transport Physics And Flux Models
  • Flux-Surface-Averaged Transport Form
  • Density Equation
  • Pressure / Temperature Equation
  • Radial Electric Field Equation
  • Flux-Model Composition
  • NTX / NTSS-Inspired Neoclassical Models
  • Built-In Neoclassical Models
  • Built-In Turbulent Models
  • File-Driven Flux Model
  • Classical Channel
• Solver Backends
  • Available Backends
  • Diffrax Backends
  • Theta Backends
  • Custom Radau Solver
  • How The NEOPAX Radau Implementation Works
  • Important Radau Settings
  • RHS Modes
  • Why Radau Matters In NEOPAX
  • Current Practical Guidance
• Expensive Response Methods
  • Design Goal
  • What The NTX Review Suggests
  • Recommended Response Hierarchy
  • Why JVP Is Preferred
  • Coefficient-Level Versus Lij-Level Response
  • What Should Stay Live
  • Face-Flux Strategy
  • No-Python-Loop Scan Principle
  • Recommended NEOPAX Template For Future Expensive Models
  • Decision For The NTX Realtime Path
• Getting started
  • Installation
  • Run an example
  • CLI and API entry paths
• Methods of Use
  • Recommended Use Cases
  • CLI Path
  • Direct Python API
  • Which API Should You Prefer?
  • Runtime NTX Scan From Python
  • Extending NEOPAX
• Custom Flux And Source Models
  • What The Extension API Provides
  • Transport Flux Model Contract
  • Source Model Contract
  • Validated Registration
  • Decorator Registration
  • Using make_validation_context(...)
  • Minimal Flux Example
  • Minimal Source Example
  • Using Custom Models From TOML
  • Practical Guidance
  • Current Limits
  • See Also
• Input File Reference
  • Top-Level Structure
  • [general]
  • [geometry]
  • [neoclassical], [turbulence], [classical]
  • [ambipolarity]
  • [energy_grid]
  • [species]
  • [profiles]
  • [extensions]
  • [boundary.*]
  • [equations]
  • [sources] and [sources.parameters.*]
  • [transport_solver]
  • [transport_output]
  • [fluxes]
  • Mode-to-Section Summary
  • See Also
• Worked Examples
  • Transport Example
  • Lagged-Response Benchmark Example
  • Ambipolarity Example
  • Fluxes Example
  • Sources Example
  • Runtime NTX Direct-API Example
  • Choosing A Usage Path
  • See Also
• API Reference
  • NEOPAX