Welcome to GGEMS Documentation

GGEMS is an advanced Monte Carlo simulation platform using CPU and GPU architecture targeting medical applications (imaging and particle therapy). This code is based on the well-validated Geant4 physics model and capable to be executed in both CPU and GPU devices using the OpenCL library.

This documentation is divided into three parts.

First, as preamble, an introduction to GGEMS and the informations are given in order to install your environment for GGEMS.

Second, for a standard user, informations about all GGEMS potential are given.Examples and tools are also illustrated and explained. And all the command lines are listed using both C++ and python instructions.

And finally, in the last part of this documentation, a more detailed description concerning GGEMS core for advanced user. The purpose of this part is to give enough informations to an user to implement a custom part of code in GGEMS.

Preamble

• Introduction
• Requirements
  • Operating Systems
  • Python Version
  • OpenCL Version
  • Hardware
• Building & Installing
  • Prerequisites
  • GGEMS Installation
• Getting Started

User Documentation

• Multi-Device
• Navigators
  • Systems
  • Phantoms
• World
• Dosimetry
• Physical Processes & Range cuts
  • Physical Processes
  • Range Cuts
• Sources
  • X-ray Source
• GGEMS Commands
• Examples & Tools
  • Examples 0: Cross-Section Computation
  • Examples 1: Total Attenuation
  • Examples 2: CT Scanner
  • Examples 3: Voxelized Phantom Generator
  • Examples 4: Dosimetry
  • Examples 5: World Tracking

Developer Documentation

• Release Notes
  • Supported and Tested Platforms
  • What You Can Do in GGEMS
  • Compilation Warnings
  • GGEMS Software License
• Change log
  • CMAKE
  • C++
  • GGEMS
  • Features
  • Examples
• GGEMS Design
• Make a GGEMS Project
  • Template
  • Python
  • C++

Printable Document

• Portable Document