Metadata-Version: 2.4
Name: booz_xform
Version: 0.1.0
Summary: Transformation to Boozer coordinates
Author-email: Matt Landreman <matt.landreman@gmail.com>
License-Expression: BSD-2-Clause
Project-URL: Homepage, https://github.com/hiddenSymmetries/booz_xform
Project-URL: Documentation, https://hiddensymmetries.github.io/booz_xform/
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: scipy; extra == "test"
Requires-Dist: matplotlib; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: scipy; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: tbump; extra == "dev"
Requires-Dist: pybind11; extra == "dev"
Requires-Dist: cmake; extra == "dev"
Requires-Dist: ninja; extra == "dev"
Dynamic: license-file

# booz_xform
![booz_xform logo](docs/source/logo_lores.png)

`booz_xform` is a package for computing Boozer coordinates in toroidal
magnetohydrodynamic equilibria, including both stellarators and
tokamaks.  The package described here follows the same algorithm as
the fortran 77 code of the same name in
[Stellopt](https://github.com/PrincetonUniversity/STELLOPT/tree/develop/BOOZ_XFORM).
However the package here is written in C++, with python bindings.  The
package here is also written so as to allow input from equilibrium
codes other than VMEC, it is parallelized using OpenMP, and it
includes functions for plotting output.  It is also equipped with unit
and regression tests and continuous integration.

For most users, the code can be installed by executing

    pip install booz_xform

Pre-compiled wheels are available for Linux (x86-64 and aarch64) and
macOS (Apple Silicon and Intel) on CPython 3.10 and newer, so this
requires nothing but python3. On other
platforms, `pip` builds from source, which requires NetCDF, a C++
compiler, and `cmake`.

For more installation options and other information, see the
[booz_xform documentation
here.](https://hiddensymmetries.github.io/booz_xform/)
