Welcome to BDSIM’s documentation!

BDSIM is a code to make 3D models of particle accelerators using Geant4.

• https://bitbucket.org/jairhul/bdsim/

• http://www.pp.rhul.ac.uk/twiki/bin/view/JAI/BdSim

User Guide

• Licence & Disclaimer
  • Licence
  • Referencing & Citation
  • Geant4 Acknowledgement
  • Funding Acknowledgements
• Authorship
  • Current Authors
  • Past Authors
• Introduction
  • Purpose of BDSIM
  • Capabilities
  • Simulation Procedure
  • How BDSIM Works
  • Tracking
  • Limits
• Installation
  • Supported Systems
  • Solutions
  • Download BDSIM Source Code
  • Requirements & Environment
  • Compilation Environment Setup
  • Compiling BDSIM
  • Python Utilities
  • Upgrading BDSIM
  • Troubleshooting
  • XWindows With MacOS
  • Programs Included
  • Tested Platforms
• Running BDSIM
  • Basic Operation
  • Executable Options
  • Interactively
  • In Batch Mode
  • Recreate Mode
• Input Syntax
  • GMAD Syntax
  • Coordinates & Units
• Model Construction
  • Lattice Description
  • Circular Machines
  • Beamline Starting Point
  • Magnet Strength Polarity
  • Synchronous Time and Phase
  • Beamline Elements
  • Offsets & Tilts - Component Misalignment
  • Lattice Sequence
  • Multiple Beam Lines
  • Detectors
• Model Control
  • Random Engine
  • Beam Parameters
  • Physics Processes
  • Physics Biasing
  • Options
  • Output at a Surface - Samplers
  • Scoring
  • Controlling Simulation Speed
  • Dipole Behaviour
• Model Customisation
  • Fields
  • Materials and Atoms
  • Aperture Parameters
  • Magnet Geometry Parameters
  • Cavity Geometry Parameters
  • Externally Provided Geometry
  • Placements
  • Tunnel Geometry
  • Crystals
  • Colours
  • Automatic Colours
  • Regions
  • One Turn Map
• Model Conversion
  • Manual Preparation
  • MAD-X Conversion
  • MAD8 Conversion
  • Python Builder
  • Optical Validation
• External Geometry Formats
  • GDML
  • Mokka
• Output
  • File Writing Policy
  • Units
  • Output Format
  • Output Data Selection & Reduction
  • Output Information
  • Particle Identification
  • Ion Identification
  • Basic Data Inspection
  • Structure Of Output
• Output Analysis
  • Setup
  • Quick Recipes
  • bdskim - Skimming Tool
  • bdsimCombine - Combine BDSIM Output Files
  • rebdsim - General Analysis Tool
  • rebdsimCombine - Output Combination
  • rebdsimHistoMerge - Simple Histogram Merging
  • rebdsimOptics - Optical Functions
  • rebdsimOrbit - Orbit Extraction
  • Data Workflows - Speed & Efficiency
  • User Analysis
  • Numerical Methods
• Python Utilities
  • Installing Python Utilities
  • Documentation
  • Geometry Preparation
• Visualisation
  • Colour Coding
  • BDSIM Visualisation Commands
  • Common Useful Commands
  • Visualisation Features
  • Visualising Step Points
  • Default and Custom Visualisers
  • Adding Other Visualisers
• Interfacing
  • Compiling Against BDSIM
  • Custom Beam Line Component
  • Custom Physics List
  • Tracking Link Interface
• Examples & Tests
  • Basic Examples
  • Worked Examples
  • Specific Machines
  • Features
• Support
  • BDSIM News Letter
  • Trouble Running BDSIM
  • Feature Request

Developer Guide

• Version History
• Developer Documentation
• Model Description

Indices and tables

• Index

• Module Index

• Search Page