Geant-simulation

For GRAMS simulation toy model. If you are going through this the first time, please navigate to section Download GRAMS toy model.

Download GRAMS toy model

First please use any method you like to download all of the files from this git repository. You could use git clone command if you already got a github account

git clone https://github.com/Eclipsedclaw/GRAMS.git

If you don't have one, I strongly suggest you creat one. But at the same time you could directly click the code button on the top right and then download a zip file of it.

Install GRAMS toy model

first we need to make sure root and geant4 are properly working. Specificly for Aramaki Lab's ubuntu machine, you could use following command to activate root and geant4

source /opt/root/root_install/bin/thisroot.sh

source /opt/geant4/geant4-11.1.0-install/bin/geant4.sh

Saving time tips

There are ways to prevent you from typing same commands every time. One way is to activate shell environment automatically when you open a new terminal. This will slow down the speed and potentially have some unknown shell conflict issues. But it's less concern if you don't have a long term plan. You could run these command to setup auto activation

echo 'source /opt/geant4/geant4-11.1.0-install/bin/geant4.sh' >> ~/.bashrc
echo 'source /opt/root/root_install/bin/thisroot.sh' >> ~/.bashrc
echo 'cd' >> ~/.bashrc 
source ~/.bashrc

You could also use .profile to keep track of the shell file directory. If you do this

echo 'export ROOTsh=/opt/root/root_install/bin/thisroot.sh' >> ~/.profile
echo 'export Geant4sh=/opt/geant4/geant4-11.1.0-install/bin/geant4.sh' >> ~/.profile

source ~/.profile

You should be able to directly use string ROOTsh and Geant4sh to call the directory instead of typing them out everytime.

source $ROOTsh
source $Geant4sh

You only need one of these two solutions. Please choose the one that you like better!

install toy model

For the first time that you open the toy model or the first time after you change something in the source folder, you need to reinstall the toy model. Go to local GRAMS toy model directory and we will install the model in another build directory. Here I suggest to have another installation directory aside from the source directory. You should run the following commands in the parent directory of GRAMS git directory. You could do

cd ..

to go to the parent directory.

Then you could make a work directory and install GRAMS toymodel using commands below

mkdir toymodel_work && cd toymodel_work
cmake ../GRAMS
make

After these commands you should see GRAMS successfully installed as showed below. If there is error, please check the error messege and contact me if you don't know how to fix it.

Run GRAMS toy model

We use macro files to control the operation of the simulation such as choosing particle types and energy range. Check macro file README.md to see all the different options that you can change. Specificly there are geant4 library GPS that you could use in the macro files to control the behavior of the input event, such as initial angle and generated location. And the normal simulation running command is to run command below in the source directory

./GRAMS macro/"YOUR MACRO FILES"

visulization

There is a vis.mac file under macro directory, you could use this to generate heprep files. For default setting you could run

./GRAMS macro/vis.mac

This will generate heprep files, G4data0 usually just represents for empty geometry without any events. And to actually see the simulation visulization we need HepRApp. Run this command to link HepRapp to a simple format

echo 'alias HepRApp="java -jar /opt/HepRApp/HepRApp.jar"' >> ~/.bashrc
source ~/.bashrc

Then you should be able to call HepRApp in the source folder by simply typing

HepRApp G4Data0.heprep

You should be able to see the UI interface of HepRApp. You could explore all the function of it!

Get the newest version

If you want to follow the newest version of this software that has the development feature and analysis code by others, you could type codes below in your source directory(where you downloaded this software from github)

git pull
cd ../toymodel_work
ccmake .

From the UI interface of ccmake, you could hit 'c' to configure your software with newest updates, then follow the instruction showed on screen. Once configured successfully, you should see the option 'generate'. Then you could re-generate GRAMS toy model by press button 'g'. After re-generate the software, you could use make to install it with updated version again.

make