Skip to main content

optimisation for topas Monte Carlo

Project description

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},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TopasOpt-0.4.5.tar.gz (32.3 kB view hashes)

Uploaded Source

Built Distribution

TopasOpt-0.4.5-py3-none-any.whl (29.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page