Scans a directory for IMRT QA results
Project description
What does it do?
Scans a directory for IMRT QA reports and parses data into a CSV.
Other information
This library is part of the IMRT QA Data Mining (IQDM) project for the AAPM’s IMRT Working Group (WGIMRT).
Free software: MIT license
Documentation: Read the docs
Tested on Python 3.6, 3.7, 3.8, 3.9
Dependencies
Install
Latest PyPI release:
$ pip install iqdmpdf
Latest dev:
$ pip install git+https://github.com/IQDM/IQDM-PDF.git@dev
Install from source:
$ python setup.py install
Usage
To scan a directory for IMRT QA report files and generate a results .csv file into your current directory:
$ iqdmpdf [init_directory]
usage: iqdmpdf [-h] [-ie] [-od OUTPUT_DIR] [-of OUTPUT_FILE] [-ver] [-nr]
[-re]
[init_directory]
Command line interface for IQDM
positional arguments:
init_directory Initiate scan here
optional arguments:
-h, --help show this help message and exit
-ie, --ignore-extension
Script will check all files, not just ones with .pdf
extensions
-od OUTPUT_DIR, --output-dir OUTPUT_DIR
Output stored in local directory by default, specify
otherwise here
-of OUTPUT_FILE, --output-file OUTPUT_FILE
Output will be saved as <report_type>_results_<time-
stamp>.csv by default. Define this tag to customize
file name after <report_type>_
-ver, --version Print the IQDM version
-nr, --no-recursive-search
Include this flag to skip sub-directories
-re, --raise-errors Allow failed file parsing to halt the program
Vendor Compatibility
We plan to support many vendors. If the report is very consistent, a new JSON file in the report_templates is essentially all that is needed. Additional documentation for custom templates can be found here.
Sun Nuclear: SNC Patient
ScandiDos: Delta4
Credits
Development Lead
Dan Cutright
Contributors
Marc Chamberland
Aditya Panchal
Test Data
Example IMRT QA reports used for unit testing and design are available here.
- Dan Cutright, University of Chicago Hospital
delta4/UChicago
sncpatient/UChicago
- Serpil Kucuker Dogan, Nortwestern Memorial Hospital
sncpatient/Northwestern_Memorial
sncpatient2020/Northwestern_Memorial
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.