General information about model implementations
All information of the different models are saved in three different files which have to be in one directory
$SARAH_Directory/Models/$ModelName/
The three files are
- one model file with the same name as the model directory (
ModelName.m
): Main Model File - a file containing additional information about the particles of the model (
particles.m
): particles.m - a file containing additional information about the parameters of the model (
parameters.m
): parameters.m
Only the first file is really necessary for calculating the Lagrangian. It contains the following information:
- Basic definitions for a non-supersymmetric model or Basic definitions for a supersymmetric model
- Definition of the properties of different eigenstates
For defining properties of parameters and particles and for producing an appropriate output the other two files are needed.
There is also the option to auto-generate templates for particles.m and parameters.m.
Sub-Models/Model-Categories
In some cases a model might be implemented in different bases, such as (super-)CKM or with diagonal Yukawas which may be managed in the same directory. Similary it is convenient to store models that belong to a certain category (e.g. all SplitSUSY low-energy EFTs) within one directory.
To do so, the following directory structure is supported:
- $SARAH_Directory/Models/...
- $Model/$Model.m
- $Model/$SubModel1/$Model-$SubModel1.m
- $Model/$SubModel2/$Model-$SubModel2.m
where each directory contains a model .m file as well as a parameter.m and particles.m
The models are started using:
-
Start["$Model"]
, -
Start["$Model","$SubModel1"]
or Start["$Model","$SubModel2"]
e.g. Start["SM","CKM"]
starts the Standard Model with the CKM basis.
The maximum depth of sub-models is one.
Custom Model Directory
A custom model directory can be set in the file SARAH.config
SARAH[InputDirectories]={
ToFileName[{$sarahDir, "Models"}],
"/home/$user/Documents/SARAH-Models/"
};
which is located in the SARAH root-directory.