The OPALX Universe
User guide, physics manual, reference, and developer handbook
Main Developers & Institutions
Andreas Adelmann (PSI); Pedro Calvo (CIEMAT); Achim Gsell (PSI); Sriramkrishnan Muralikrishnan (JSC); Philippe Piot (NIU); Chris Rogers (RAL); Mohsen Sadr (PSI/MIT); Jochem Snuverink (PSI); Jonathan Thompson (RAL); Daniel Winklehner (MIT); Yuanjie Bi (Sun Yat-sen University); John Biddiscombe (CSCS/ETH)
Simulate charged-particle accelerators across CPUs and GPUs
OPALX is the performance-portable accelerator simulation framework for high-statistics, three-dimensional beam dynamics. This manual brings the user guide, physics models, command reference, and developer handbook into one searchable source.
Find your path
Start here
Getting Started
Build OPALX, choose a platform backend, and run a first input file.
Run simulations
User Guide
Learn the input language, beam definitions, runtime options, tracking workflow, elements, reusable structures, field solvers, and outputs.
Understand the models
Physics
Follow coordinate conventions, equations of motion, element fields, collective effects, decay, spin, and photon physics.
Look something up
Reference
See the commands and elements registered by the current executable, build configuration, file formats, and external API documentation.
Contribute
Developer Guide
Understand the architecture, build and test workflows, and how to add features without losing GPU portability.
Resolve a problem
Troubleshooting
Diagnose build and runtime failures, prepare reproducible bug reports, and check known limitations.
Live resources OPALX API documentation Regression-test dashboard OPALX source
Documentation status
This redesign is an actively curated foundation. Pages marked current have been checked against the present OPALX source. Experimental pages describe implemented work whose interface may still change. Planned pages make documentation gaps visible instead of filling them with unverified OPAL text.
Acknowledgments and citation
OPALX builds on the original OPAL project and is developed across PSI and its international accelerator-science partners. Use the publications and citation guidance when citing the software. The original OPAL manual remains available as a separate historical resource.