A synthetic synchrotron diagnostic for runaway electrons in tokamaks
Switch branches/tags
Nothing to show
Clone or download

README.md

SOFT

SOFT (for "Synchrotron-detecting Orbit Following Toolkit") is a synthetic synchrotron diagnostic that can be used to study the synchrotron radiation emitted by runaway electrons in tokamaks. By taking the effect of electron orbits into account, SOFT can accurately reproduce synchrotron images and spectra as obtained in experiments, assuming the runaway electron distribution function is known.

Basic documentation of SOFT is available at [http://soft.readthedocs.io/en/latest/].

Synthetic synchrotron image

Third-party libraries

SOFT utilizes a number of third-party libraries. Some are required for the code to at all compile, while some can be optionally linked to for additional functionality. Software that must be installed on your system is

Optional software that is recommended, but not required, to compile, is

  • HDF5, for reading/writing data in this format.
  • Matlab, for reading/writing data in .mat format.
  • MPI, for MPI support. Allows running SOFT across multiple computers. See for example MPICH or OpenMPI.

Compilation

  1. The first step to compiling SOFT is to configure the source code by running CMake. This is done by entering the build directory and running cmake:
$ cd build/
$ cmake ../

By default, CMake will look for HDF5 and Matlab, and if they are not found on the system, configuration will fail. To disable, HDF5 and Matlab support, run instead

$ cmake ../ -DUSE_HDF5=OFF -DUSE_MATLAB=OFF

Similarly, MPI support can be enabled using

$ cmake ../ -DUSE_MPI=ON
  1. Once SOFT is configured, the code can be compiled with
$ make

in the build directory. The resulting binary can be found under build/src/.

  1. (Optional) To install SOFT on your system, run
$ make install

from the build directory. This will copy the build/src/soft binary to /usr/bin.

Documentation

Documentation of SOFT is available in two forms:

  1. The official SOFT manual, located under docs/. Documenting the details of implementation in SOFT.
  2. The SOFT beginner's guide, found at [http://soft.readthedocs.io/en/latest/].

Who's behind SOFT?

SOFT is developed by the Plasma Theory group at the Department of Physics, Chalmers University of Technology.

How to cite

When refering to SOFT, please cite the SOFT paper:

[1] M. Hoppe, O. Embréus, R. A. Tinguely, R. S. Granetz, A. Stahl and T. Fülöp, "SOFT: a synthetic synchrotron diagnostic for runaway electrons", Nucl. Fusion **58** 026032 [https://doi.org/10.1088/1741-4326/aa9abb].