booz_xform Logo

Contents

  • Getting started
    • Requirements
    • Installation
      • 1. Installation from PyPI
      • 2. Installation from a local copy of the repository
      • 3. Installation without pip from a local copy of the repository
      • 4. Building outside of the python package system
  • Theory and numerical implementation
    • Theory
      • 1. Determining the toroidal angle difference
      • 2. Transforming other quantities
    • Implementation details
  • Typical usage
    • Overview
    • Python
    • C++
  • Plotting
    • modeplot()
    • surfplot()
    • symplot()
  • API Reference
    • Python
      • Booz_xform
        • Booz_xform.init_from_vmec()
        • Booz_xform.read_boozmn()
        • Booz_xform.read_wout()
        • Booz_xform.run()
        • Booz_xform.write_boozmn()
        • Booz_xform.Boozer_G
        • Booz_xform.Boozer_G_all
        • Booz_xform.Boozer_I
        • Booz_xform.Boozer_I_all
        • Booz_xform.aspect
        • Booz_xform.asym
        • Booz_xform.bmnc
        • Booz_xform.bmnc_b
        • Booz_xform.bmns
        • Booz_xform.bmns_b
        • Booz_xform.bsubumnc
        • Booz_xform.bsubumns
        • Booz_xform.bsubvmnc
        • Booz_xform.bsubvmns
        • Booz_xform.chi
        • Booz_xform.compute_surfs
        • Booz_xform.gmnc_b
        • Booz_xform.gmns_b
        • Booz_xform.iota
        • Booz_xform.lmnc
        • Booz_xform.lmns
        • Booz_xform.mboz
        • Booz_xform.mnboz
        • Booz_xform.mnmax
        • Booz_xform.mnmax_nyq
        • Booz_xform.mpol
        • Booz_xform.mpol_nyq
        • Booz_xform.nboz
        • Booz_xform.nfp
        • Booz_xform.ns_b
        • Booz_xform.ns_in
        • Booz_xform.ntor
        • Booz_xform.ntor_nyq
        • Booz_xform.numnc_b
        • Booz_xform.numns_b
        • Booz_xform.phi
        • Booz_xform.phip
        • Booz_xform.pres
        • Booz_xform.rmnc
        • Booz_xform.rmnc_b
        • Booz_xform.rmns
        • Booz_xform.rmns_b
        • Booz_xform.s_b
        • Booz_xform.s_in
        • Booz_xform.toroidal_flux
        • Booz_xform.verbose
        • Booz_xform.xm
        • Booz_xform.xm_b
        • Booz_xform.xm_nyq
        • Booz_xform.xn
        • Booz_xform.xn_b
        • Booz_xform.xn_nyq
        • Booz_xform.zmnc
        • Booz_xform.zmnc_b
        • Booz_xform.zmns
        • Booz_xform.zmns_b
    • C++
  • Developer notes
    • Testing
      • C++ tests
      • Python tests
      • Continuous integration
  • Source code on GitHub
booz_xform
  • Search

© Copyright 2025, Matt Landreman.

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