Everything you need to install, operate, and contribute to OpenTOPAS—straight from the official manuals.
Official Manual
The canonical reference for physics models, geometry components, scoring functions, graphics and release notes lives on Read the Docs.
OpenTOPAS on ReadTheDocs →
Code Wiki (automatically generated by Gemini)
A description of the base code highlighting features can be found in this link.
OpenTOPAS on Code Wiki →
Install · macOS
Follow the quickstart for Apple Silicon and Intel Macs, including dependency setup and
validation runs.
macOS quickstart guide →
Install · Debian / Ubuntu
Step-by-step instructions for Debian-based systems, covering apt packages, Geant4 data sets, and sanity
tests.
Debian quickstart guide →
Install · Windows WSL
Use Windows Subsystem for Linux to run OpenTOPAS on Windows with near-native performance.
WSL quickstart guide →
Contribute via Fork
Keep contributions aligned with the `develop` branch and validate them through our qi-opentopas workflow.
- Fork
OpenTOPAS/OpenTOPAS, create a feature branch off develop, and sync often.
- Clone your fork
git clone https://github.com/OpenTOPAS/qi-opentopas.git for QA automation.
- Run qi-opentopas checks locally (build, regression, formatting) before opening a Pull Request (PR).
- Open the PR against
develop, link related issues, and describe datasets/settings used.
qi-opentopas repository →
License & Usage
OpenTOPAS is distributed under the MIT License. Review the terms to understand how you can reuse and
redistribute the software.
Read the MIT License →
How to Cite?
Acknowledge the TOPAS collaboration by including these references in your publications:
-
B. Faddegon, J. Ramos-Méndez, J. Schümann, A. McNamara, J. Shin, J. Perl, H. Paganetti. “The TOPAS Tool
for Particle Simulation, a Monte Carlo Simulation Tool for Physics, Biology and Clinical Research.”
Phys Med. 2020;72:114-121. PMID: 32247964. PMCID: PMC7192305.
-
J. Perl, J. Shin, J. Schümann, B. Faddegon, H. Paganetti. “TOPAS: an innovative proton Monte Carlo
platform for research and clinical applications.” Med Phys. 2012;39(11):6818-37.