https://github.com/Image-X-Institute/TopasOpt
Optimisation for topas Monte Carlo
https://github.com/Image-X-Institute/TopasOpt
medical-physics optimization radiation-transport topasmc
Last synced: 6 months ago
JSON representation
Optimisation for topas Monte Carlo
- Host: GitHub
- URL: https://github.com/Image-X-Institute/TopasOpt
- Owner: Image-X-Institute
- License: mit
- Created: 2022-02-04T05:25:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T00:08:58.000Z (9 months ago)
- Last Synced: 2025-04-03T04:34:40.209Z (6 months ago)
- Topics: medical-physics, optimization, radiation-transport, topasmc
- Language: Python
- Homepage: https://image-x-institute.github.io/TopasOpt/
- Size: 40.5 MB
- Stars: 7
- Watchers: 0
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-medphys - TopasOpt -  provides a framework for performing optimisation on monte carlo radiation transport simulations using [TOPAS](https://www.google.com/search?channel=fs&client=ubuntu&q=topas+MC). [](https://badge.fury.io/py/TopasOpt) (Libraries)
README
# TopasOpt
 [](https://codecov.io/gh/Image-X-Institute/TopasOpt) [](https://badge.fury.io/py/TopasOpt)
This code provides a framework for performing optimisation on monte carlo radiation transport
simulations using [TOPAS](https://www.google.com/search?channel=fs&client=ubuntu&q=topas+MC).
## Install and Requirements
To install: ```pip install TopasOpt```
- You require a working installation of [topas](https://topas.readthedocs.io/en/latest/getting-started/intro.html) 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](https://image-x-institute.github.io/TopasOpt/)
The source code for the [worked examples](https://image-x-institute.github.io/TopasOpt/worked_examples.html) is inside the examples folder.
## Directory Structure
- **TopasOpt:** source code
- **examples:** source code for the [worked examples](https://image-x-institute.github.io/TopasOpt/worked_examples.html) provided in the docs
- **docsrc:** markdown/rst documentation.
- **tests:** tests which are run through github actions
## Citation
This code is described in [this paper](https://aapm.onlinelibrary.wiley.com/doi/10.1002/mp.16126).
If you use this code in your work, please cite this paper!
```bibtex
@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},
}
```