Metadata-Version: 2.1
Name: TopasOpt
Version: 0.1.3
Summary: Inverse optimisation for topas Monte Carlo
Home-page: https://github.com/ACRF-Image-X-Institute/TopasOpt
Author: Brendan Whelan
Author-email: bwheelz360@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/ACRF-Image-X-Institute/TopasOpt/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

# TopasOpt


This code provides a framework for performing inverse optimisation on monte carlo radiation transpoty 
simulations using [TOPAS](https://www.google.com/search?channel=fs&client=ubuntu&q=topas+MC).

## Install and Requirements

To install: ```pip install TopasOpt```

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

## Usage and Documentation

See the examples folder for worked examples.
Detailed documents are provided [here](put sphinx link in!)

## Directory Structure

- **docs:** html documentation created from docsrc using sphinx
- **docsrc:** markdown/rst documentation.
- **examples:** as the name implies!
- **tests:** Unit and integration tests
- **TopasBayesOpt:** source code









