Skip to main content

Open Flexible Unstructured Simulation Infrastructure with Open Numerics (FUSION) Toolkit (OFT)

CI status CD status Container CD status codecov DOI

The Open FUSION Toolkit (OFT) is a suite of modeling tools, and their underlying finite element framework, for problems in plasma and fusion research and engineering in arbitrary 2D and 3D geometries. The underlying framework and its component tools support the use of variable order finite element methods on unstructured tetrahedral (triangular) or hexahedral (quadralateral) grids.

NOTE: This project is under active development, please watch releases for any new features and breaking changes that may be introduced.

Component tools

The suite currently includes the following tools:

  • TokaMaker: A time-dependent free-boundary Grad-Shafranov equilibrium code

  • ThinCurr: A 3D thin-wall electromagnetic simulation package

  • MUG: A 2D/3D linear/nonlinear extended MHD simulation package

  • Marklin: A 3D force-free, uniform λ equilibrium solver

Installation

PyPI packages

Pre-built Python packages are available on PyPI and can be installed using pip install openfusiontoolkit (using a virtual environment is strongly recommended).

Binary packages

Binaries are available for Linux (x86 and arm64) and macOS (x86 and arm64) for each release on GitHub as well as recent commits to main via the CD workflow (see artifacts on each run).

Container images

Pre-built container images capable of running Open FUSION Toolkit via python scripts and/or Jupyter notebooks are available on the GitHub Container Registry and can be used by Docker or other container runtimes at ghcr.io/openfusiontoolkit/{base|jupyter|extras} (see registry for available images/tags).

Installation from source

The framework and its components can also be built from source using the instructions provided on the wiki.

NOTE: To use the python interfaces for a binary or source install add the python directory for your installation to your PYTHONPATH environment variable.

Documentation

Detailed documentation is available online and is also included in the binary packages at /path/to/oft/install/doc/Documentation.html (please note /path/to/oft/install is a placeholder for the actual install path).

Contributing

See CONTRIBUTING.md for information on how to contribute.

Copyright

Open FUSION Toolkit code development project, up to version 26.9 Copyright (c) 2023 - 2026, Open FUSION Toolkit team.

Written by Open FUSION Toolkit team and collaborators with Christopher J. Hansen as principle developer. All rights reserved.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

openfusiontoolkit-26.9-py3-none-manylinux_2_28_x86_64.whl (20.2 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

openfusiontoolkit-26.9-py3-none-manylinux_2_28_aarch64.whl (15.8 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

openfusiontoolkit-26.9-py3-none-macosx_15_0_x86_64.whl (27.5 MB view details)

Uploaded Python 3macOS 15.0+ x86-64

openfusiontoolkit-26.9-py3-none-macosx_14_0_arm64.whl (25.8 MB view details)

Uploaded Python 3macOS 14.0+ ARM64

File details

Details for the file openfusiontoolkit-26.9-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for openfusiontoolkit-26.9-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a3c7a588052298e353f386121192e8db5f4bfa2d0db6e0142f89c80a35979463
MD5 68e6d7a5514f1702bfd2615f07358e0e
BLAKE2b-256 4c4cae11bdb7b61ec778839b55d5b580689a710d1d53aa0c03325529223261ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for openfusiontoolkit-26.9-py3-none-manylinux_2_28_x86_64.whl:

Publisher: cd_combined.yaml on OpenFUSIONToolkit/OpenFUSIONToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openfusiontoolkit-26.9-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for openfusiontoolkit-26.9-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 42f8a15b6afff23755881713b2194932e53718d138a09b46d3fc6be0805378f3
MD5 298935f19bab543c98dd6f23f40a4c63
BLAKE2b-256 bc6aaa70a2ce2662d4038af1e7cd31243d0b706c4d03735c58a8cf9521d59f51

See more details on using hashes here.

Provenance

The following attestation bundles were made for openfusiontoolkit-26.9-py3-none-manylinux_2_28_aarch64.whl:

Publisher: cd_combined.yaml on OpenFUSIONToolkit/OpenFUSIONToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openfusiontoolkit-26.9-py3-none-macosx_15_0_x86_64.whl.

File metadata

File hashes

Hashes for openfusiontoolkit-26.9-py3-none-macosx_15_0_x86_64.whl
Algorithm Hash digest
SHA256 e69cb9aeb21f15f0a625d48bf53a1de4e951d2dcf12091247c0587a46d3114f6
MD5 90a59d1e4cbe90d0562949c16c752a37
BLAKE2b-256 df9d61c632802dfadf13791b3d306f11a3d75dcda90939d8a46edfd4b267797d

See more details on using hashes here.

Provenance

The following attestation bundles were made for openfusiontoolkit-26.9-py3-none-macosx_15_0_x86_64.whl:

Publisher: cd_combined.yaml on OpenFUSIONToolkit/OpenFUSIONToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openfusiontoolkit-26.9-py3-none-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for openfusiontoolkit-26.9-py3-none-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 c29fda2ade5ed175299d730aef103de656ed6e348d25004d31d8b56587fc2695
MD5 33c1f96610a67f8cc44de1c9e0673f5b
BLAKE2b-256 00a4df08bfc1c8b990d7e25013045671f7c20cabd598368c4974225b636333c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for openfusiontoolkit-26.9-py3-none-macosx_14_0_arm64.whl:

Publisher: cd_combined.yaml on OpenFUSIONToolkit/OpenFUSIONToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

26.9 This release

4 files

26.6

4 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page