LMU/musrsim
LMU/musrsim
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
salman 2022-11-04 17:15:32 +01:00
parent 296b604658
commit 7db3d1cfcb
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,22 +2,23 @@
### 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 Geant4 and Root installed. musrSim was tested with Geant versions 4.9.5, 4.10.0 and Root version 5.32, and Geant4.10.3 with root version 6. Root version should not be critical, but Geant4 version should be 9.5, 10.0, or 10.3 for the corresponding source codes.
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 code is specifically tuned to simulate implantation of low energy projectiles in materials.
* The code is maintained by the Low Energy Muons group at PSI.
* The GUI is written in Node.js, JavaScript and Electron.
* The binary (statically linked) from the fortran code is also included.
* RPM and DEB packages are also included
* 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 ###
###### C++ code compilation ######
Clone the musrSim repository git clone https://zaher-salman@bitbucket.org/zaher-salman/musrsim.git
Clone the musrSim repository
git clone https://zaher-salman@bitbucket.org/zaher-salman/musrsim.git
then
cd musrsim
mkdir build
cd build
@ -27,12 +28,13 @@ Clone the musrSim repository git clone https://zaher-salman@bitbucket.org/zaher-
This will install the `musrSim` in `/usr/local/bin`, but can be moved to any other directory in your `PATH`.
###### Running the simulation ######
### Running the simulations ###
Prepare a file with your beamline and spectrometer design following the instruction in the musrSim manual, finlename.mac.
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>