Skip to content

Commit

Permalink
update package content and add it to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Voigt authored and Alexander Voigt committed Mar 22, 2018
1 parent 89d83f9 commit fb6a411
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 5 deletions.
49 changes: 49 additions & 0 deletions README
Expand Up @@ -33,6 +33,7 @@ Optional:
* LoopTools (version 2.8 or higher) http://www.feynarts.de/looptools/
* Himalaya https://github.com/Himalaya-Library/Himalaya


Installation of SARAH
=====================

Expand Down Expand Up @@ -467,3 +468,51 @@ remove model-specific files:
$ make clean-<model>-obj # deletes .o files

$ make clean-<model>-src # deletes generated files


Package content
===============

In the following all sub-directories within the FlexibleSUSY package
are listed:

* addons/ contains addons for FlexibleSUSY, such as GM2Calc

* config/ contains helper scripts and makefile modules for the build
system

* doc/ contains the FlexibleSUSY documentation

* examples/ contains examples how to build you own spectrum generator
based on FlexibleSUSY

* fflite/ contains an alternative implementation of the
Passarino-Veltman loop functions, based on FF

* meta/ contains the Mathematica meta code which generates the
spectrum generators

* model_files/ contains default model files for some frequently used
models (SM, SplitMSSM, MSSM, NMSSM, SMSSM, UMSSM, etc.)

* model_specific/ contains model-specific higher order corrections
for the MSSM, NMSSM, SM and SplitMSSM from the literature

* models/ This is the output directory where the generated C++ code
for the spectrum generators will be stored.

* Output/ contains SARAHs model-specific output files

* sarah/ contains SARAH model files shipped with FlexibleSUSY

* slhaea/ contains the SLHA reader library from
https://github.com/fthomas/slhaea

* src/ contains non-model specific FlexibleSUSY C++ source code

* templates/ contains C++ template files for the spectrum generators

* test/ contains the FlexibleSUSY test suite

* utils/ contains some utility scripts to perform scans or extract
data from SLHA files
21 changes: 16 additions & 5 deletions doc/package.dox
Expand Up @@ -4,27 +4,38 @@

\section Directories

- <code>addons/</code> contains addons for FlexibleSUSY, such as
GM2Calc

- <code>config/</code> contains helper scripts and makefile modules
for the build system

- <code>doc/</code> contains the FlexibleSUSY documentation

- <code>examples/</code> contains some example spectrum generators
- <code>examples/</code> contains examples how to build you own
spectrum generator based on FlexibleSUSY

- <code>fflite/</code> contains an alternative implementation of the
Passarino-Veltman loop functions, based on FF

- <code>meta/</code> contains the @ref meta_code "Mathematica meta code"
- <code>meta/</code> contains the @ref meta_code "Mathematica meta
code" which generates the spectrum generators

- <code>model_files/</code> contains default model files for some
frequently used models (MSSM, NMSSM, SMSSM, UMSSM, etc.)
frequently used models (SM, SplitMSSM, MSSM, NMSSM, SMSSM, UMSSM,
etc.)

- <code>model_specific/</code> contains model-specific higher order
corrections for the MSSM, NMSSM, SM and SplitMSSM from the
literature

- <code>models/</code> This is the output directory where the
generated C++ code for the spectrum generators will be stored.

- <code>Output/</code> contains SARAH's model-specific output files

- <code>sarah/</code> contains extra SARAH model files
- <code>sarah/</code> contains SARAH model files shipped with
FlexibleSUSY

- <code>slhaea/</code> contains the SLHA reader library from
https://github.com/fthomas/slhaea
Expand All @@ -38,6 +49,6 @@
- <code>test/</code> contains the FlexibleSUSY test suite

- <code>utils/</code> contains some utility scripts to perform scans
or extract data from SLHA files.
or extract data from SLHA files

*/

0 comments on commit fb6a411

Please sign in to comment.