musrsim/README.md
2023-02-12 11:11:05 +01:00

45 lines
1.5 KiB
Markdown

# musrSim simulation #
### Contents ###
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.
### Supported platforms ###
* Linux and any other decent OS that can run Root and GEANT4.
### Installation ###
Compile and install Geant4, we recomment the use of the following cmake flags
cmake -DCMAKE_INSTALL_PREFIX=/path/to/installation /path/to/source -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
then
cd musrsim
mkdir build
cd build
cmake ../
make -j8
make install
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 ###
Prepare a file, `finlename.mac`, with your beamline and spectrometer design following the instruction in the [musrSim manual](https://bitbucket.org/zaher-salman/musrsim/src/master/doc/musrSim.pdf).
musrSim filename.mac
### Contact ###
Zaher Salman <zaher.salman@psi.ch>