musrsim/README.md
2022-11-04 17:18:11 +01:00

41 lines
1.2 KiB
Markdown

# musrSim simulation #
### 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.
* 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 ###
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` in `/usr/local/bin`, but 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>