From a9ce8a47b1ffd8661f03e0d7f24dbecdb8cb8428 Mon Sep 17 00:00:00 2001 From: salman Date: Sun, 12 Feb 2023 10:56:42 +0100 Subject: [PATCH] Update the README file. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9bee650..3c838bd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ### Contents ### -This is the C++ source code for the musrSim simulation software. This software is intended to be a general tool for the whole µSR community. To compile and run musrSim, the user has to have a recent Geant4 (tested with v11.0.3) and Root (tested with v6-22-06) installed. The Root version is not critical. +This is the C++ source code for the musrSim simulation software which is intended to be a general tool to design and simulate µSR spectrometer with very high accuracy. To compile and run musrSim, the user must have a recent Geant4 (tested with v11.0.3) and Root (tested with v6-22-06) installed (Root version is not critical). * The code is specifically tuned to simulate muon spin spectrometers. * The code is maintained by the Laboratory for Muon Spin Spectroscopy at PSI. @@ -13,6 +13,10 @@ This is the C++ source code for the musrSim simulation software. This software i ### Installation ### +Compile and install Geant4, we recomment the use of the following cmake flags + +cmake -DCMAKE_INSTALL_PREFIX=/usr/local/geant4-v11.0.3-install/ /usr/local/src/geant4-v11.0.3 -DGEANT4_USE_QT=ON -DGEANT4_INSTALL_DATA=ON -DGEANT4_USE_OPENGL_X11=ON + Clone the musrSim repository git clone https://zaher-salman@bitbucket.org/zaher-salman/musrsim.git @@ -22,11 +26,11 @@ then cd musrsim mkdir build cd build - cmake ../ + cmake ../ make -j8 make install -This will install the `musrSim` in `/usr/local/bin`, but can be moved to any other directory in your `PATH`. +This will install the `musrSim` binary in `/usr/local/bin`, but it can be moved to any other directory in your `PATH`. ### Running the simulations ###