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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file TopasOpt-0.4.5.tar.gz.

File metadata

  • Download URL: TopasOpt-0.4.5.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for TopasOpt-0.4.5.tar.gz
Algorithm Hash digest
SHA256 1fc3827cf2a268ee48fcce0178bb399b6400841144ed6633a12500a5108bed23
MD5 856df95387c6b5ec0badddb2bcf099c7
BLAKE2b-256 66c0eecc39000b8fd9a4067b47bc1cf2617f5244a0b08eeb4f77b9487749a006

See more details on using hashes here.

File details

Details for the file TopasOpt-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: TopasOpt-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 29.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for TopasOpt-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9b62fe18acdc528a7d1279d795f17a4df8f8834528058d68ff01df63d2fa1093
MD5 6bb8d0f186f7f17fc0ce797ea14b9bfe
BLAKE2b-256 9a3c90695906d53b96668658d86a7f3ff6fccd2bd895e8cc2f4c5c5b29cd8cf2

See more details on using hashes here.

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