# <p align="center">TopasGraphSim</p>
## <p align="center">A GUI to simplify and streamline the plotting and analysis of medical physics simulations</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/87897942/152699152-d4d39654-4449-4354-b899-4adc81eb25a7.png" width="320" height="160" />
</p>
This GUI can visualize and analyze percentage depth dose (pdd) and dose profiles (dp) simulations from [TOPAS](http://www.topasmc.org/). Depth dose measurements are assumed to be in the z-direction, dose profiles in the x- or y-directions. Data read-in is handled by [topas2numpy](https://github.com/davidchall/topas2numpy).
## Installation
Install using pip:
```console
$ pip install topasgraphsim
```
Then, start the GUI by running:
```console
$ python -m topasgraphsim
```
Or, if your Python is added to $PATH, simply run:
```console
$ topasgraphsim
```
Open compatible files from the command line:
```console
$ topasgraphsim "path_to_your_file"
```
Since all my testing in done on Windows 11, I cannot guarantee ToapsGrapSim will work on any other plattform. I'm open to suggestions or PRs making the software work better cross-plattfrom!
## Features
Visit the [wiki](https://github.com/sebasj13/TopasGraphSim/wiki) for detailed information!
Highlights include:
- Reproducible graphing and analysis of 1D TOPAS simulation for medical physics
- Simultaneous plotting and parameter calculation for all data sets
- Calculation of the Gamma Index with adjustable parameters
- Graph adjustment options
* Normalization (On/Off)
* Error bars (On/Off)
* Graph order and colors
* Marker size and style
* Line width
- Drag and drop of files
- Center axis deviation correction
- Import of RadCalc OAR and PDD data, RayStation depth doses and dose profiles, and Slicer line profiles
- Import of custom measurements (as numpy .txt files)
- Import of PTW tbaScan (MEPHYSTO mc<sup>2</sup>) measurements
- German and english language support
- Dark mode
## Screenshots
## Parameters
Depending on the imported measurement, the following parameters can be calculated:
| Measurement type | Parameters | | | | | |
| ---------------- | :--------: | :---------------: | :--------------------: | :-------------------: | :------------: | :------------: |
| | | | | | | |
| Depth dose | Q-Factor | z<sub>max</sub> | | | | |
| | | | | | | |
| Dose profile | FWHM | CAX<sub>dev</sub> | FLAT<sub>Krieger</sub> | FLAT<sub>stddev</sub> | Penumbra (L&R) | Integral (L&R) |
- Q-Factor : Radiation Quality Factor
- z<sub>max</sub> : Depth at Maximum
- FWHM : Full-Width at Half-Maximum
- CAX<sub>dev</sub> : Centre Axis Deviation
- FLAT<sub>Krieger</sub> : Flatness of Dose Plateau (Definition by Krieger)
- FLAT<sub>stddev</sub> : Flatness of Dose Plateau (Standard Deviation)
- Penumbra (L&R) : Width of Left and Right Penumbra
- Integral (L&R) : Integral below Left and Right Penumbra
## Dependencies
The UI is based on the [customtkinter](http://github.com/TomSchimansky/CustomTkinter) library.
Requires python3, numpy, scipy, matplotlib, Pillow, python-opencv, pynput, requests, topas2numpy, and python-tkdnd.
## Contact me!
Thank you for using TopasGraphSim! Please let me know about any issues you encounter, or suggestions/wishes you might have!
<br></br>
[](https://pepy.tech/project/topasgraphsim)
Raw data
{
"_id": null,
"home_page": "https://github.com/sebasj13/TopasGraphSim",
"name": "topasgraphsim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "topas,monte-carlo,python,simulation",
"author": "Sebastian Sch\u00e4fer",
"author_email": "sebastian.schaefer@student.uni-halle.de",
"download_url": "https://files.pythonhosted.org/packages/70/87/64662166ac74b9bd14cff61d26cbd8d8502004c1308497ae1101fe066294/topasgraphsim-26.0.0.tar.gz",
"platform": null,
"description": "# <p align=\"center\">TopasGraphSim</p>\r\n\r\n## <p align=\"center\">A GUI to simplify and streamline the plotting and analysis of medical physics simulations</p>\r\n\r\n<p align=\"center\">\r\n<img src=\"https://user-images.githubusercontent.com/87897942/152699152-d4d39654-4449-4354-b899-4adc81eb25a7.png\" width=\"320\" height=\"160\" />\r\n</p>\r\n\r\nThis GUI can visualize and analyze percentage depth dose (pdd) and dose profiles (dp) simulations from [TOPAS](http://www.topasmc.org/). Depth dose measurements are assumed to be in the z-direction, dose profiles in the x- or y-directions. Data read-in is handled by [topas2numpy](https://github.com/davidchall/topas2numpy).\r\n\r\n## Installation\r\n\r\nInstall using pip:\r\n\r\n```console\r\n$ pip install topasgraphsim \r\n```\r\n \r\nThen, start the GUI by running:\r\n \r\n```console\r\n$ python -m topasgraphsim\r\n```\r\n\r\nOr, if your Python is added to $PATH, simply run:\r\n\r\n```console\r\n$ topasgraphsim\r\n```\r\n\r\nOpen compatible files from the command line:\r\n\r\n```console\r\n$ topasgraphsim \"path_to_your_file\"\r\n```\r\n\r\nSince all my testing in done on Windows 11, I cannot guarantee ToapsGrapSim will work on any other plattform. I'm open to suggestions or PRs making the software work better cross-plattfrom!\r\n\r\n## Features\r\n\r\nVisit the [wiki](https://github.com/sebasj13/TopasGraphSim/wiki) for detailed information!\r\n\r\nHighlights include:\r\n\r\n - Reproducible graphing and analysis of 1D TOPAS simulation for medical physics\r\n - Simultaneous plotting and parameter calculation for all data sets\r\n - Calculation of the Gamma Index with adjustable parameters\r\n - Graph adjustment options\r\n * Normalization (On/Off)\r\n * Error bars (On/Off)\r\n * Graph order and colors\r\n * Marker size and style\r\n * Line width\r\n - Drag and drop of files\r\n - Center axis deviation correction\r\n - Import of RadCalc OAR and PDD data, RayStation depth doses and dose profiles, and Slicer line profiles \r\n - Import of custom measurements (as numpy .txt files)\r\n - Import of PTW tbaScan (MEPHYSTO mc<sup>2</sup>) measurements\r\n - German and english language support\r\n - Dark mode\r\n\r\n ## Screenshots\r\n \r\n \r\n \r\n\r\n\r\n ## Parameters\r\n\r\nDepending on the imported measurement, the following parameters can be calculated:\r\n\r\n| Measurement type | Parameters | | | | | |\r\n| ---------------- | :--------: | :---------------: | :--------------------: | :-------------------: | :------------: | :------------: |\r\n| | | | | | | |\r\n| Depth dose | Q-Factor | z<sub>max</sub> | | | | |\r\n| | | | | | | |\r\n| Dose profile | FWHM | CAX<sub>dev</sub> | FLAT<sub>Krieger</sub> | FLAT<sub>stddev</sub> | Penumbra (L&R) | Integral (L&R) |\r\n\r\n- Q-Factor : Radiation Quality Factor\r\n- z<sub>max</sub> : Depth at Maximum\r\n\r\n- FWHM : Full-Width at Half-Maximum\r\n- CAX<sub>dev</sub> : Centre Axis Deviation\r\n- FLAT<sub>Krieger</sub> : Flatness of Dose Plateau (Definition by Krieger)\r\n- FLAT<sub>stddev</sub> : Flatness of Dose Plateau (Standard Deviation)\r\n- Penumbra (L&R) : Width of Left and Right Penumbra\r\n- Integral (L&R) : Integral below Left and Right Penumbra\r\n\r\n## Dependencies\r\n\r\nThe UI is based on the [customtkinter](http://github.com/TomSchimansky/CustomTkinter) library.\r\n\r\nRequires python3, numpy, scipy, matplotlib, Pillow, python-opencv, pynput, requests, topas2numpy, and python-tkdnd.\r\n## Contact me!\r\n\r\nThank you for using TopasGraphSim! Please let me know about any issues you encounter, or suggestions/wishes you might have! \r\n<br></br>\r\n[](https://pepy.tech/project/topasgraphsim)\r\n",
"bugtrack_url": null,
"license": "",
"summary": "GUI to analyze the results of a Monte-Carlo radiation simulation",
"version": "26.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/sebasj13/TopasGraphSim/issues",
"Homepage": "https://github.com/sebasj13/TopasGraphSim"
},
"split_keywords": [
"topas",
"monte-carlo",
"python",
"simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6cba12f4d7ffe8493f4e53dbe7581fb104e93398f60fa1bfd9bc63c78195891",
"md5": "67461de2c16fba63cf77e97eeb7583d1",
"sha256": "0afe4adbcc1017b940c272abb1703703c24ebd28c796e275aa7e826854cb0f47"
},
"downloads": -1,
"filename": "topasgraphsim-26.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67461de2c16fba63cf77e97eeb7583d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 117851,
"upload_time": "2024-03-06T22:13:54",
"upload_time_iso_8601": "2024-03-06T22:13:54.907567Z",
"url": "https://files.pythonhosted.org/packages/d6/cb/a12f4d7ffe8493f4e53dbe7581fb104e93398f60fa1bfd9bc63c78195891/topasgraphsim-26.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "708764662166ac74b9bd14cff61d26cbd8d8502004c1308497ae1101fe066294",
"md5": "21ab1c1a3a91a758a3f74a6b1d17579b",
"sha256": "db32037dd278104a5c8b160fc8e580f7b7b09f7d4e87843cffc04e38b024ccf4"
},
"downloads": -1,
"filename": "topasgraphsim-26.0.0.tar.gz",
"has_sig": false,
"md5_digest": "21ab1c1a3a91a758a3f74a6b1d17579b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 97566,
"upload_time": "2024-03-06T22:13:58",
"upload_time_iso_8601": "2024-03-06T22:13:58.079587Z",
"url": "https://files.pythonhosted.org/packages/70/87/64662166ac74b9bd14cff61d26cbd8d8502004c1308497ae1101fe066294/topasgraphsim-26.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 22:13:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sebasj13",
"github_project": "TopasGraphSim",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "topasgraphsim"
}
JSON
