by Mark Geurts [email protected] and Adam Bayliss [email protected]
Copyright © 2018, University of Wisconsin Board of Regents

This repository contains a collection of python scripts that were developed for use with the RayStation treatment planning system. The application of these scripts varies from efficient creation of QA plans to automated planning and plan checks. This repository is actively being developed, so please see our Projects page for more information on what is coming soon!

A full guide to installation is avaiable on the the Installation wiki page. This repository is set up so that only one "selector" script, ScriptSelector.py, actually needs to be imported into RayStation. Once imported, you can change how scripts are loaded through two variables specified at the top of the script: local and module.

If local is left empty, each time the selector is called from RayStation it will use the requests library to connect to this repository and prompt the user to select a branch to run scripts from (the master branch contains all validated Production versions, but other feature development branches can be selected to test new features). After selecting a branch, the selector will download all scripts and prompt the user with a list to select one to execute. Alternatively, users can enter a local directory into the local variable that contains a local copy of this repository. Instead of downloading a fresh copy each time from GitHub, the local scripts will be displayed to the user for execution.

The module variable is used to only show scripts from a particular directory in this repository. For example, setting module = 'general' will only show the general scripts to the user. In this way, multiple copies of ScriptSelector.py can be loaded into RayStation with each pointing to a single focus of scripts.

Packages not included as part of the standard library have been included as submodules in this repository, and should be installed from these references or pip during RayStation setup. A description of each package and how it is used is available on the Dependencies wiki page.

With the exception of the library folder, each python script in this repository performs a standalone function in RayStation. See the wiki for information on what each script does, how it is used, and to see troubleshooting tips. If you experience issues with a script or have improvements to suggest please submit an Issue, otherwise contact the script author for questions or feedback.

Released under the GNU GPL v3.0 License. See the LICENSE file for further details.