Open FUSION Toolkit

The Open FUSION Toolkit (OFT) is suite of tools, built on a common finite element framework, designed for simulating physical systems relevant to plasma and fusion science and engineering in complex 2D and 3D geometries. The code supports the use of high order finite element methods on unstructured hexahedral/quadrilateral and tetrahedral/triangular grids for a variety of relevant physics models.

Component tools

• TokaMaker: A time-dependent free-boundary Grad-Shafranov equilibrium code
• ThinCurr: A 3D thin-wall electromagnetic simulation package
• MUG: A 3D linear/nonlinear extended MHD simulation package
• Marklin: A 3D force-free, uniform λ equilibrium solver

Binary Packages

We supply pre-built binary packages for the following platforms:

• Linux x86_64^*
• macos arm64
• macos x86_64

^* - Linux binaries may work on Windows via WSL, however this is not explictly tested at this time.

Note: Rolling binary builds for all commits to main are also provided via the CD workflow (see artifacts on each run).

Install from Source

Please refer to the wiki for instructions on how to build the code from source. Presently we support building on Linux and macos with GCC 8+ and Intel oneAPI 2023 compiler suites. Other platforms and compilers may work, but are not explictly tested at this time.

Documentation

Full documentation, including examples, is included in the binary distributions and also can be accessed here.

Note: Documentation is still under construction and may be incomplete or contain errors. Please open issues or pull requests to help us improve our documentation, but please be constructive and avoid generic "add more documentation" issues.

Publications

A list of publications using the Open FUSION Toolkit can be found here. To be added to this list please open an issue or create a pull request.

How To Cite

To cite the Open FUSION Toolkit, please cite the zenodo DOI corresponding to the code version and the appropriate publication(s) from below for the component tools used in your research.

• TokaMaker:
  • C. Hansen et al., Comput. Phys. Commun. 289, 109111 (2024) [DOI]
• ThinCurr:
  • A. Battey et al., Nucl. Fusion 64, 016010 (2023) [DOI]
  • C. Hansen et al., Phys. Plasmas 24, 042513 (2017) [DOI]
• MUG:
  • C. Hansen et al., Phys. Plasmas 22, 042505 (2015) [DOI]
  • C. Hansen, PhD Thesis: U. Washington (2014) [URI]
• Marklin:
  • T. Benedett et al., Nucl. Fusion 61 036022 (2021) [DOI]
  • T. Jarboe et al., Phys. Rev. Lett. 97, 115003 (2006) [DOI]