README.txt for Xolotl

Xolotl is a continuum simulator under development within two DOE SciDAC programs, available at https://github.com/ORNL-Fusion/xolotl . It is a high-performance computing code using advection-reaction-diffusion (ADR) kinetic rate theory to model the time evolution of the divertor material in next generation tokamaks like ITER, as well as nuclear fuel in fission reactors.

Here is a quick start guide to install Xolotl if you have all the required dependencies (CMake higher than 3.13, MPI compiler with C++17 support, Boost, Kokkos 3.3 or earlier, HDF5, PETSc):

git clone https://github.com/ORNL-Fusion/xolotl $HOME/xolotl-source
mkdir $HOME/xolotl-build
cd $HOME/xolotl-build
cmake -DCMAKE_BUILD_TYPE=Release -DKokkos_DIR=/opt/kokkos-install -DPETSC_DIR=/opt/petsc-install -DCMAKE_INSTALL_PREFIX=$HOME/xolotl-build/install $HOME/xolotl-source/
make

You can find more information about this code on our Wiki and how to install Xolotl and its dependencies in Build Configuration.

Once installed, you can use a Benchmark file to run the code:

./xolotl <input_parameter_file> 

as described in Running Xolotl, with the description of the available options at Parameter File.

If you want to contribute please check Guidelines.

For any question you can send an email to our mailing list: [email protected].