Allpix Squared v3.0.3 User Manual

This is the online version of the documentation for Allpix Squared v3.0.3. To download the PDF version visit this page.


A brief introduction to the Allpix Squared framework and its goals.


Instructions on how to build and install Allpix Squared.

Getting Started

Get to know the basics of the framework.

Structure of the Framework

Description of the structure & the components of the framework.

Geometry and Detectors

Definition of coordinate systems, detector models and support layers.

Physics Models & Materials

Description of the different physics models and material properties for semiconductor detectors.


Objects which can be used to transfer data between modules.


Description and parameter documentation of all available Allpix Squared modules.


Description of the example configurations.

Module & Detector Development

How to develop new simulation modules and detector models.

Development Tools & CI

A few tools to ease development and help to maintain a high code quality.

Automated Testing

The testing framework to prevent regressions.


Some of the most frequently asked questions.

Additional Tools & Resources

Tools provided with Allpix Squared.