pyg4ometry Documentation

pyg4ometry is a package to create, load, write and visualise solid geometry for particle tracking simulations.

Example accelerator tunnel complex at CERN.

• Licence & Disclaimer
• Authorship
• Referencing & Citation
• Installation
  • Requirements
  • Installation
  • Docker image
  • Linux installation
  • FreeCAD support for CAD to GDML conversion
  • Python 3.9
• Introduction
  • Need for programatic geometry generation
  • Geant4 key concepts
  • Geometry key concepts
  • Implementation concepts
• Loading Geometry
• Viewing Geometry
  • Visualiser Classes
  • Using the Visualiser
  • Solid or Wireframe
  • Logical Volume
  • Solid
  • Boolean Solid
  • Default Colour Coding
  • Custom Colour Coding
  • Random Colours
  • Overlaying Two Geometries
• Validating Geometry
  • Overlap Checking
• Exporting Geometry
  • Registry and GDML Output
  • GDML Output
  • Export scene to paraview/vtk
  • Export scene to unity/unreal
• Creating Geometry
  • Precepts
  • Units
  • Geant4 Python Scripting
  • GDML Defines
  • Solids
  • Materials
  • Detector Construction
  • Transformations & Physical Volumes
  • Optical Surfaces
  • Properties of Materials and Optical Surfaces
  • FLUKA Geometry Creation
• Converting Geometry
  • Assembly Conversion
  • GDML to FLUKA
  • FLUKA To GDML
  • CAD (STEP/IGES) To GDML
• Combining Geometry
• Comparing Geometry
  • Tests
  • Running a Comparison
  • Seeing the Results
  • Examples
• Analysing Geometry
  • Finding volumes
  • Navigating the LV-PV hierarchy
  • Geometry Complexity Analysis
• CAD interface
  • Controlling tesselation
  • Setting materials
  • Object names
  • Tetrahedralisation
  • Topology exploration
• Command Line Interface
• Module Contents
  • Defines and variables
  • Geant4 solids
  • Geant4 module
  • Visualisation module
  • STL module
  • GDML module
  • CGAL module
  • OpenCascade module
  • Fluka bodies
  • Fluka module
  • IO Module
  • Transformation
  • Misc
  • Convert
  • Compare
  • Features
• Developer
  • Unit tests
  • Coverage
  • Profiling
  • Updating A Version
  • Updating Copyright
• Version History
  • V1.0.6 - 2023 / XX / XX
  • V1.0.5 - 2023 / 03 / 03
  • V1.0.2 - 2022 / 04 / 11
  • v1.0.1 - 2022 / 02 / 10
  • v0.9.0 - 2021 / 07 / 01
  • Pre-History

Indices and tables

• Index

• Module Index

• Search Page