Choose the installation section that follows depending on your operating system and environment.
Linux Install
The preferred method of installation on Linux is using the pre-built development environment using Apptainer.
Developer Install: Apptainer (preferred)
Use Apptainer to execute in development environment containers.
Contains optional dependencies (libTorch, MFEM, NEML2).
Developer Install: Conda (Linux)
Use Conda to distribute the development environment.
Does not contain optional dependencies (libTorch, MFEM, NEML2).
INL HPC Install
These instructions describe building on INL HPC resources.
Use modules on INL HPC that provide convenient access to a containerized development environment.
Contains optional dependencies (libTorch, MFEM, NEML2).
Mac OS Install
We generally advise against the use of Homebrew on Mac OS. Intel Macs are currently still supported but this support will end at the end of 2026 as software updates to these machines are reduced to only security updates.
Developer Install: Conda (Mac) (preferred)
Use Conda to distribute the development environment.
Does not contain optional dependencies (libTorch, MFEM, NEML2).
Windows Install
Developer Install: Conda (Windows) (preferred)
Use Conda to distribute the development environment within WSL (Windows Subsystem for Linux).
Does not contain optional dependencies (libTorch, MFEM, NEML2).
Support is limited.