Repository Organisation

Back to Contents.

The source code repository is organised as follows:

• The core repository contains the central Takin modules, which are licensed under the GNU GPL version 2. They are written in C++14. These modules comprise, for example,

  • the real and reciprocal space visualisation,
  • the resolution calculator, convolution simulator and fitter,
  • the scan viewer,
  • etc.

• The mag-core repository contains the Takin modules having to do with (mostly) magnetic and polarised scattering. They are licensed under the GNU GPL version 3. Some other, non-magnetic modules also reside here because they use the same license and codebase as the magnetic ones. They are written in C++20. The modules in this group comprise, for example,

  • the magnon calculator,
  • the magnetic and nuclear structure factor calculators,
  • the polarisation vector calculator,
  • the CIF file loader,
  • the Brillouin zone calculator,
  • the scan browser for treating polarised scan data,
  • etc.

• The tlibs directory contains the physical-mathematical template library tlibs version 1 that is used by the core module. Tlibs is licensed under either the GNU GPL version 2 or the GNU GPL version 3. Its code is written in C++11 / C++14.

• The tlibs2 directory contains the physical-mathematical template library tlibs version 2 that is used by the mag-core module. Tlibs 2 is licensed under the GNU GPL version 3. Its code is written in C++20.

• The data directory contains example data files and tutorials for Takin.

• The setup directory contains scripts to build and install Takin.

• The magnon-plugin directory contains the magnetic dynamics plugin module for the resolution convolution simulator/fitter. It is described here.

Further modules can be found in the internal repository group:

• The mnsi repository contains the helimagnon and skyrmion dynamics plugin module for the resolution convolution simulator that was used in our skyrmion paper.

• The paths repository contains the triple-axis pathfinder, which is described in more detail here.