diff options
| author | Shivesh Mandalia <shivesh.mandalia@outlook.com> | 2020-02-29 18:05:20 +0000 |
|---|---|---|
| committer | Shivesh Mandalia <shivesh.mandalia@outlook.com> | 2020-02-29 18:05:20 +0000 |
| commit | 5dea1c8034c01cacd01a58dd1ba60c590694a3ec (patch) | |
| tree | 87658a98ccb3227adc10e31da756679543af8435 /README.md | |
| parent | b3e87271802a42dac11e12c7e066c1b1b2d6fb54 (diff) | |
| download | G4BeamTest-5dea1c8034c01cacd01a58dd1ba60c590694a3ec.tar.gz G4BeamTest-5dea1c8034c01cacd01a58dd1ba60c590694a3ec.zip | |
add README.md, LICENSE and logo
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d64d17 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# G4BeamTest + + +[](https://github.com/ShiveshM/G4BeamTest/blob/master/LICENSE) + +G4BeamTest is a C++ simulation of an Optical Module Beam Test at the [Fermilab +Test Beam Facility](https://ftbf.fnal.gov/) (FTBF). + + + +## Installation +G4BeamTest can be installed using `cmake` +``` +mkdir build && cd build +cmake -DGEANT4_USE_QT=ON ../ +make +``` + +### Dependencies + +G4BeamTest has the following dependencies: +* [`gcc-c++`](https://gcc.gnu.org/) +* [`CMake`](https://cmake.org/) >= 2.6 +* [`Geant4`](https://geant4.web.cern.ch/) >= 10.4 + +For installation instructions of Geant4 see the [Geant4 +Installation +Guide](https://geant4-userdoc.web.cern.ch/geant4-userdoc/UsersGuides/InstallationGuide/html/). +All G4 data files including hadron cross-sections are required to be +downloaded. Here is a typical example of the environment variables which need +to be set in your `.bash_profile`: +``` +export GEANTTOPDIR="/opt/geant4" +export G4LEVELGAMMADATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/PhotonEvaporation5.2" +export G4NEUTRONXSDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4NEUTRONXS1.4" +export G4LEDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4EMLOW7.3" +export G4NEUTRONHPDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4NDL4.5" +export G4ENSDFSTATEDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4ENSDFSTATE2.2" +export G4RADIOACTIVEDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/RadioactiveDecay5.2" +export G4ABLADATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4ABLA3.1" +export G4PIIDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4PII1.3" +export G4SAIDXSDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/G4SAIDDATA1.1" +export G4REALSURFACEDATA="$GEANTTOPDIR/share/Geant4-10.4.2/data/RealSurface2.1.1" +export LD_LIBRARY_PATH=$GEANTTOPDIR/lib64:$LD_LIBRARY_PATH +export PATH=$GEANTTOPDIR/bin:$PATH +``` + +Additional dependencies: +* [`Qt`](https://www.qt.io/) >= 4 + +Be sure to install with `Qt` support for the GUI interface shown in the +animation above. + +## License + +[MIT License](LICENSE) + +Copyright (c) 2020 Shivesh Mandalia |