Skip to content

Image-X-Institute/TopasOpt

Repository files navigation

TopasOpt

codecovtest docsPyPI version

This code provides a framework for performing optimisation on monte carlo radiation transport simulations using TOPAS.

Install and Requirements

To install: pip install TopasOpt

  • You require a working installation of topas to run the code.
  • This code will only run on linux or mac (as will topas)
  • python3.8 or greater is required.

Usage and Documentation

Detailed documentation is provided here The source code for the worked examples is inside the examples folder.

Directory Structure

  • TopasOpt: source code
  • examples: source code for the worked examples provided in the docs
  • docsrc: markdown/rst documentation.
  • tests: tests which are run through github actions

Citation

This code is described in this paper. If you use this code in your work, please cite this paper!

@article{whelan_topasopt_2022,
	title = {{TopasOpt}: {An} open-source library for optimization with {Topas} {Monte} {Carlo}},
	shorttitle = {{TopasOpt}},
	journal = {Medical Physics},
	author = {Whelan, Brendan and Loo Jr, Billy W. and Wang, Jinghui and Keall, Paul},
	year = {2022},
	note = {Publisher: Wiley Online Library},
}