Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
torus-solver
torus-solver

Getting Started

  • Getting started
  • Inputs and outputs (library + scripts)
  • Installation
  • Examples
    • Field-line tracing examples
    • Validation and convergence examples
    • Inverse design / optimization examples
    • GUI examples (interactive, VTK)
    • Performance examples
    • ParaView outputs
  • Applications and workflows
  • Glossary and conventions

Theory

  • Geometry: the circular torus surface
  • Numerics and units
  • Surface differential operators on the torus
  • Model A: electrode-driven surface potential
  • Model B: REGCOIL-like current potential
  • Biot–Savart: magnetic field from surface currents

Algorithms

  • Optimization
  • Field-line tracing
  • Validation and regression testing

API Reference

  • API reference
    • torus_solver.torus
    • torus_solver.spectral
    • torus_solver.poisson
    • torus_solver.sources
    • torus_solver.current_potential
    • torus_solver.biot_savart
    • torus_solver.fields
    • torus_solver.fieldline
    • torus_solver.optimize
    • torus_solver.metrics
    • torus_solver.targets
    • torus_solver.surface_ops
    • torus_solver.vmec
    • torus_solver.plotting
    • torus_solver.gui_vtk

Development

  • Contributing
  • Testing and validation
  • CI/CD and Read the Docs
  • Roadmap and extension ideas
  • References and related work
Back to top
Copyright © 2026, torus-solver contributors
Made with Sphinx and @pradyunsg's Furo