Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restrepo/bsm-submodules
SARAH toolbox with each tool as a submodule
https://github.com/restrepo/bsm-submodules
binder jupyter jupyter-notebook madgraph micromegas sarah sarah-toolbox spheno
Last synced: 10 days ago
JSON representation
SARAH toolbox with each tool as a submodule
- Host: GitHub
- URL: https://github.com/restrepo/bsm-submodules
- Owner: restrepo
- Created: 2017-10-11T20:21:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T17:53:58.000Z (8 months ago)
- Last Synced: 2024-04-01T19:00:38.116Z (8 months ago)
- Topics: binder, jupyter, jupyter-notebook, madgraph, micromegas, sarah, sarah-toolbox, spheno
- Language: Jupyter Notebook
- Size: 9.69 MB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Beyond the Standard Model Submodules
Run SARAH models precompiled by the butler script of SARAH Toolbox.
TUTORIAL: SARAH talk at IPP-UFRN-Natal (Sept. 2019): http://bit.ly/SARAHIIP
WARNING! Clone with `--recursive` option in order to download the Toolbox submodles:
```
git clone --recursive [email protected]:restrepo/BSM-Submodules.git
```
To clone an specific model, check the associtated branch in the format: `CATEGORY+MODEL` (see below) and clone with
```
git clone --recursive -b CATEGORY+MODEL [email protected]:restrepo/BSM-Submodules.git
cd BSM-Submodules
./install.sh #Fast butler
```
Or try directly here:
[](https://mybinder.org/v2/gh/restrepo/BSM-Submodules/master)
Design
-----------------------------------------------------------------------------
The rules to implement the fermion/scalars multiplets are in the files:
- `SARAH/Models/blocks.fermions.lha`
- `SARAH/Models/blocks.scalars.lha`
implemented as LHA blocks.
The `master` branch only contains the standard SARAH-Toolbox distribution plus
the new generic files.
Each new model MODEL is build inside a CATEGORY under the branch:
`CATEGORY+MODEL`
based in the predefined blocks in the fermion/scalars multiplets files. __Explore the branches__!
Implemened CATEGORY's:
- SM: Explore SARAH feautures
- SimplifiedDM: Simplified Dark Matter Models
- radinert: Models with radiative neutrino masses and dark matter candidates with SM + Z2-odd particles
- B-L: $B-L$ models
Each implemented model have a notebook in BSM dir:
`BSM/CATEGORY-MODEL.ipynb`
with examples to run and scan the parameter space.
The module `hep` (in `BSM/hep.py`) used there, have the objects to _automatically_ run the model in a similar way to the SSP SARAH-toolbox package.
See [README_CREATES_NEW_MODEL.md](./README_CREATES_NEW_MODEL.md) to help with build new models. __Send the new models as a pull request__.
See [README_deploy_mybinder.md](./README_deploy_mybinder.md): To deploy a mybinder virtual machine:
Updating submodules
------------------------------------------------------------------------
External dependences are tried as git submodules. Each submodule, SBM, is update as follow
```
rm -rf SBM/*
wget http://....SBM_vN.N.tar.gz
tar -zxvf SBM_vN.N.tar.gz -C SBM --strip-components=1
cd SBM
find . -type d -empty -not -path "./.git/*" -exec touch {}/.gitkeep \;
git add .
git commit -am 'vN.N.N'
git push origin master
```
In addtion a tagged release is created in the SBM repo, or locally for some commit_HASH:
```bash
git tag -am "SBM-N.N.N.tar.gz" vN.N.N commit_HASH
git push origin vN.N.N
```
and saving the "Draft" in the releases of GitHub.
### Switch to an specific tag
One specific tagged version, which is no necessarily a release,
can be used after [use](https://devconnected.com/how-to-checkout-git-tags/):
```
git tag -l #list tags
git checkout tags/v4.12.3 -b v4.12.3_branch
```
inside the specific submodule.
After some change in the official submodule repository at https://github.com/restrepo/sbm,
to update all the submodules inside this repository (https://github.com/restrepo/BSM-Submodules), which add an specific tag each submodule, use the following sequence of git commands:
```
git pull --recurse-submodules
git submodule update --remote --recursive #Check changes in official sbm repo
git commit -am 'Updated Submodules tags'
git push origin master
```
Fix submodule tag
------------------------------------------------------------------------------
Tag is just an alias to an specific commit. We need to recover that commit, fix it creating a new branch,
deleting the old tag, and creating a new tag but pointing to a commit inside that new branch
After clone a clean copy of the submodule, e.g. https://github.com/restrepo/SARAH,
checkout to the [specific tag](https://devconnected.com/how-to-checkout-git-tags/)
```bash
git checkout tags/v4.12.3 -b v4.12.3_branch
```
Make all the necessary fixes and push the changes to the new remote `v4.12.3_branch` branch.
Now, the old tag need to be deleted both locally an remotely and recreted with the last commit to that branch
```
git push origin --delete v4.12.3
git tag -d v4.12.3
git tag -a v4.12.3 2f1e527b
git push origin v4.12.3
```
Installation
------------------------------------------------------------------------------
Everything could be installed after the git clone. To choose an specific release version,
e.g vN.N, of some submodule, go there and
```
git checkout -b vN.N
```
Finally, be sure to execute `install.sh` to compile the SPHENO, calchep and micromegas submodules
Debian 9 and related Linux distributions
-------------------------------------------------------------
#### Problems with the `ar` command
In Debian 9 there is bug which breaks backward compatibility of compilers. It is fixed by declaring a global variable for the `ar` command. For example, by adding to the `~/.bashrc` file:
```bash
export ARFLAGS=rvU
```
#### Problems with C++ compiler
In the new version of the `g++` compilers such as the one in Debian 9:
`g++ (Debian 6.3.0-18) 6.3.0 20170516`
we need to enforce the `c++98` standard in order to compile the `CalcOmega.cpp` file of `SARAH` models in `micrOMEGAS` without errors.
It is done for example by changing the following line in `./micromegas/include/modelMakefile`:
```c
$(DLSET) $(CXX) $(CXXFLAGS) -o $(main:.cpp=) $(main) $(SSS) $(lDL) -lm -lpthread
```
to
```c
$(DLSET) $(CXX) $(CXXFLAGS) -std=c++98 -o $(main:.cpp=) $(main) $(SSS) $(lDL) -lm -lpthread
```
In addition, `CalcOmega5.cpp` must be modified for `micrOMEGAS` 5.0 which requires now a new argument in the `darkOmega` function.
```c
$ diff CalcOmega.cpp CalcOmega5.cpp
14a15
> int* Err;
25c26
< Omega = darkOmega(&Xf,fast,Beps);
---
> Omega = darkOmega(&Xf,fast,Beps,Err);
```
Official README stars here
-------------------------------------------------------------------------------
This README file describes the contents and usage of the SUSY toolbox package.
1) Content
-------------------------------------------------------------------------------
All file locations are relative to the package root.
- configure
This is the compiled configuration script which is invoked by the user (see
below).
- butler.in
The input file which is translated into the butler script (see below) by
configure.
- Makefile.in
Translated into Makefile by configure.
- m4/*
Files necessary for the automatic creation of aclocal.m4 via aclocal (NB: this
is _not_ necessary for ordinary usage).
- aclocal.m4
Autoconf helper macros required to create configure from configure.ac via
autoconf, automatically generated from the contents of m4 by aclocal (NB: _not_
necessary for ordinary usage).
- configure.ac
The source which is translated into configure by autoconf (NB: _not_ required
for ordinary usage).
-tarballs
The configure script will store any automatically fetched tarballs in this
directory.
2) Description
-------------------------------------------------------------------------------
The package is built around a configure shell script which is implemented using
autoconf for enhanced portability. Note that the script is shipped ready to use,
neither installation nor invocation of autoconf is required by the user (unless
he/she wants to modify the script itself). The prerequisites to use the toolbox
are
- Mathematica: mandatory as SARAH is a Mathematica program. Versions >= 5 will
work.
- A FORTRAN compiler is required for Spheno, HiggsBounds, CalcHep, Micromegas
and WHIZARD. gfortran is recommended and works fine for all programs (note
that WHIZARD requires gfortran 4.5 or better).
- A C compiler is required for CalcHep and Micromegas (the GNU C compiler works
fine).
- O'Caml and latex is required by WHIZARD and checked for during the WHIZARD
configuration.
- wget or curl are required for automatic downloading of the package tarballs by
configure.
- Make
In order to use the script, first create a directory in which the toolbox shall
be set up. Change to this directory and invoke the configure script, e.g. via
../configure. The script will now proceed to check the prerequisites and
download any required packages from the Internet. For WHIZARD, the WHIZARD
configure script is invoked automatically.
If the default configuration is not sufficient, command line options can be used
to disable a subset of packages (e.g. --disable-micromegas) or to configure the
names and options of the compilers and the mathematica kernel (e.g.
MATH=math_5.2). An exhaustive list of options can be obtained via the --help
option.
Please note that the goal of this package is not to create modified forks of the
various programs; therefore, the versions of the programs provided by the
authors on the web and their various build systems are used. Unfortunately, this
implies that the compiler settings don't automatically propagate to CalcHep and
Micromegas which have rather convoluted build systems. Thus, any changes to the
setup of those two packages have to be made by hand before running make.
On finalization, configure creates a Makefile and the butler script in the
toolbox directory. Invoking make triggers the compilation and installation of
the various packages by calling the respective build systems. Upon completion,
the compiled packages can be found in there respective directories, with an
additional unversioned symlink pointing to the versioned directory (e.g. SPHENO ->
SPHENO-3.1.5). The only exception is WHIZARD which is installed directly into a
directory called whizard.
For simple use cases, the butler script can be used to completely automate the
implementation of a new model into the various packages, provided that the model
is added to SARAH. The script is invoked using "butler modelname" and will first
create the necessary model files using SARAH and then proceed to compile and add
the model to the various packages. A list of the supported command line options
can be obtained via "--help" or "-h" which includes options to disable
individual packages (however, no packages disabled during configure can be
enabled this way).
3) Troubleshooting
-------------------------------------------------------------------------------
- Configure complains about missing prerequisites.
Make sure that the corresponding programs are installed and working correctly.
- Errors in the build process of individual packages.
Make sure that the necessary compilers are installed and working.
Unfortunately, there is a limit on the influence which the toolbox script has
over the build process of the individual packages, so it might be necessary to
build the packages manually (in the directories where configure has untarred
them) in order to solve uncommon build problems. After manual compilation, the
toolbox make should go through, and butler will work as intended.
- Download and / or checksum failures.
Make sure that your Internet connection is working properly and the download
sites can be reached in a browser. If a checksum fails, the file might have
been damaged during download. In this case, remove the file from the tarballs
directory (see above) and retry. If this doesn't help (or if the download
location has moved), please contact one of the toolbox authors.
===============================================================================
Authors:
Werner Porod [email protected]
Thorsten Ohl [email protected]
Christian Speckner [email protected]
Florian Staub [email protected]