diff --git a/README.md b/README.md index f3a9488..3bdb95d 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,47 @@ # MiMeS Misalignment Mechanism Solver The documentation is available on [arXiv](https://arxiv.org/abs/2110.12253). 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
Another option is the master branch, which is 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 the master branch may not always work. However, 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. So feel free to check them out. Detailed description of what MiMeS does can be found in the [documentation](https://arxiv.org/abs/2110.12253). However, for those brave enough, almost every line of code is commented, in order to be able to follow the logic yourselves. +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