Welcome to Geant 4 EIC’s documentation!

Getting Started:

• Quick start
• Containers
  • Docker quick start
  • Run without jupyter lab
  • Software installed
  • Changing and saving the contents
• Build/Install
  • Use ejpm
  • Spack install
  • CMake build
• Run
  • Environment variables
  • Flags
• Visualization

Design:

• Generators
  • Cone particle gun
  • BeAGLE format
  • HEPMC2 format
  • LUND format
  • Sample configuration
• Root Output
  • G4E output data structure
  • Controlling what is written
  • API v3
• Detector naming convention
• Subdetector design
  • Quick design overview
  • Adding subdetector
• Multi-threading
• Python Orchestration
  • Geant4Eic class
  • Geant4EicManager class

How to:

• v1.3.x to 1.4.x migration
• Process MC files
• Increase simulation speed
  • Controlling secondary level

Escalate:

• Escalate main docs

Links:

• GitHub
• Issues? Help is here

G4E is a lightweight pure Geant4 implementation of full simulation for EIC.