diff --git a/README.md b/README.md
index 7cb47bc..a4b11c1 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,46 @@
# MiMeS
Misalignment Mechanism Solver
The documentation is available on [arXiv](https://arxiv.org/abs/2110.12253).[^doc]
The master branch is the one where developement mostly happens, including the implementation of the new versions of [NaBBODES
](https://github.com/dkaramit/NaBBODES.git) and [SimpleSplines
](https://github.com/dkaramit/SimpleSplines.git) (both are being developed independently by myself). This means that the code in this branch may not always work. If you wish to just use MiMeS
, clone the [stabe](https://github.com/dkaramit/MiMeS/tree/stable) branch:
git clone -b stable https://github.com/dkaramit/MiMeS.git
If you would like to try and run the master branch, you need to run
git clone https://github.com/dkaramit/MiMeS.git
cd MiMeS
git submodule init
git submodule update --remote
In order to begin using MiMes
, you need a machine that can run bash
and a version of g++
that supports the C++17
standard.
Once you have downloaded MiMeS
, just run
cd MiMeS
bash configure.sh
make
-This will compile the shared libraries you'll need in order to call MiMeS
from python
. Also, it compiles some examples written in C++
. There are several examples C++
python
(including python
in jupyter
notebooks) that can be found in MiMeS/UserSpace
. Although the [documentation](https://arxiv.org/abs/2110.12253) is detailed enough, the code is also carefully commented. This mean that one can also "read" the code in order to follow how MiMeS
works.
+This will compile the shared libraries you'll need in order to call MiMeS
from python
. Also, it compiles some examples written in C++
. There are several examples in C++
and python
(including python
in jupyter
notebooks) that can be found in MiMeS/UserSpace
. Although the [documentation](https://arxiv.org/abs/2110.12253) is detailed enough, the code is also carefully commented. This mean that one can also "read" the code in order to follow how MiMeS
works.
If you use MiMeS
, cite it as
@article{Karamitros:2021nxi,
author = "Karamitros, Dimitrios",
title = "{MiMeS: Misalignment Mechanism Solver}",
eprint = "2110.12253",
archivePrefix = "arXiv",
primaryClass = "hep-ph",
month = "10",
year = "2021"
}
Enjoy,
Dimitris
[^doc]: You can get your own version of the documentation by running make doc
, which creates MiMeS/Documentation/Tex/MiMeS.pdf
.