DKX

Contents

  • Installation
  • Applications and research workflows
  • Optimization Workflows
  • Examples
  • Usage
  • Inputs (namelist) reference
  • Outputs (HDF5, NetCDF4, and NPZ)
  • Normalizations and units
  • Geometry models and loading
  • VMEC JAX workflow
  • Method overview
  • Numerics and algorithms
  • Differentiability
  • Reduced-model capabilities
  • Source-code map
  • Fortran v3 And dkx Feature Matrix
  • Theory from the upstream SFINCS notes
  • Physics model and equations
  • Physics reference: the radially local drift-kinetic model
  • Drift-kinetic equation and system of equations
  • Parallelism
  • Open research lanes
  • Performance and differentiability
  • Development Roadmap
  • Speed grids (canonical) and the retired adaptive-map research lane
  • Testing, validation, and CI
  • Validation Matrix
  • Paper figures (reproduced)
  • Upstream SFINCS sources and primary literature
  • Fortran v3 example suite status
  • Utils (ported SFINCS v3 scripts)
  • API reference
  • Validation against reference implementations
  • References and related work
  • Contributing
  • Release notes
  • Release checklist
DKX
  • Index

Index

B | D | G | M | N | O | P | R | S | T | W

B

  • batched_er_scan() (in module dkx.api)
  • batched_surface_scan() (in module dkx.api)
  • BenchmarkReport (class in dkx.api)
  • bounce_averaged_transport() (in module dkx.api)

D

  • dkx.api
    • module
  • dkx.namelist
    • module

G

  • GeometryState (class in dkx.api)
  • GridState (class in dkx.api)

M

  • module
    • dkx.api
    • dkx.namelist
  • momentum_corrected_bootstrap() (in module dkx.api)

N

  • Namelist (class in dkx.namelist)

O

  • OperatorState (class in dkx.api)
  • OutputSchema (class in dkx.api)

P

  • parse_sfincs_input_text() (in module dkx.namelist)
  • PreconditionerState (class in dkx.api)

R

  • read_output() (in module dkx.api)
  • read_sfincs_input() (in module dkx.namelist)
  • run_ambipolar_brent() (in module dkx.api)
  • run_monoenergetic_database() (in module dkx.api)

S

  • SolveInputs (class in dkx.api)
  • SolverResult (class in dkx.api)

T

  • TransportResult (class in dkx.api)

W

  • write_output() (in module dkx.api)

© Copyright 2026.

Built with Sphinx using a theme provided by Read the Docs.