README -- QAMgr v0.9.0
==============================================================

---

---

## Introduction

Welcome to *QAManager*!
This is a [Python](https://www.python.org/) package designed to streamline the process
  of performing Proton Patient QA.
An example screenshot of the graphical interface is shown below.

---



---

---

## Quick Reference {#quick}

The full documentation can be found as described [below](#doc); please refer to it
  if you have any trouble with the following abbreviated version
  of the instructions.

*Note: You will need GhostScript installed on your machine in order to use the `prepare_report()` function.
  Mac / Linux users can probably do this using their terminal's respective package manager,
  but Windows users will probably need to contact OCF for assistance.*

To get up and running quickly, follow these steps:


- Download [the package](https://trocksscience.com/mjd/QAMgr_Windows/QAMgr_Windows.zip).
- Extract the files into a folder of your choosing -- for example, your home directory (this can usually be done by double-clicking the `.zip` file).
- Open a file browser (for example, Windows Explorer) and navigate to the directory that you chose.
- Run the installer by double-clicking `install.py`.
- Open a terminal (on Windows, either `cmd` or `powershell`).
- Navigate to the folder containing the patient's RTPlan file.
- Start Python.
- Enter the two Python commands below.
- Enter your initials, select the patient's RTPLAN file, then click `Execute`
    on the steps in order, following any instructions you receive along the way.
```python
from qamgr import *
q = GuiQAMgr()
```

---

## Full Documentation {#doc}

The complete QAMgr documentation should be included in the `doc` folder
  of the extracted package files.

It is also available online [here](https://trocksscience.com/mjd/QAMgr_Windows/doc/html/index.html).

---

---

_~ Dr. Mark J. Duvall, PhD_ 
_~ [`duvall at wustl dot edu`](mailto:duvall@wustl.edu)_ 
_~ Last updated 2025/07/09_