A quality assurance webapp for the RADIFOX framework.
Project description
Installation
pip install radifox-qa
Quality Assurance
The web-based quality assurance system is a system for viewing images and recording QA results.
It is a Flask-based webapp that can be run locally.
There are two modes: conversion
and processing
that can be switched between using the links in the top navigation bar.
The conversion
mode is used to view and make corrections to the naming of images after conversion.
There are three types of actions that can be taken in conversion
mode.
- Ignore Button: This will mark the image to be skipped by the conversion process on update.
- Body Type Buttons: This will change the
bodypart
of the image to the selected value. It is currently available forBRAIN
,CSPINE
,TSPINE
,LSPINE
, andORBITS
. - Correct Name Button: This will open a form to correct any of the core aspects of the RADIFOX naming convention.
extras
are not yet supported.
The processing
mode is used to view outputs of various processing steps.
For each processing step, images of the outputs are shown with the provenance record for that step.
No actions are currently availabe in processing
mode, but we hope to record QA results directly from the app.
The QA webapp is launched with the radifox-qa
command.
It is a webapp that runs locally on port 5000 by default.
Be sure to copy down the Secret Key that is printed to the console when the webapp is launched.
This will be required to log into the webapp and changes each time the app is launched.
It can also be specified using the --secret-key
option.
For convenience, you can log into the app using http://{HOST}:{PORT}/login?key={SECRET_KEY}
, which is printed when the app is launched.
It can also be accessed at http://{HOST}:{PORT}
(http://localhost:5000
by default) and the key can be entered there.
Usage
The radifox-qa
script is used to run the web-based quality assurance system.
Example Usage:
radifox-qa --port 8888 --root-directory /path/to/output
This will launch the QA webapp on port 8888, pointing to /path/to/output
.
The QA webapp will be accessible at http://localhost:8888
and will show projects in /path/to/output
.
Be sure to note the secret key printed to the terminal when the app starts.
You will need this to log into the webapp.
The secret key changes each time the app is launched.
You can specify your own secret key using the --secret-key
option.
radifox-qa --port 8888 --root-directory /path/to/output --secret-key my-secret-key
Advanced CLI Usage
radifox-qa
Option | Description | Default |
---|---|---|
--port |
The port to run the QA webapp on. | 5000 |
--host |
The host bind address for the QA webapp. | localhost |
--root-directory |
The output root to read projects from (contains project directories) | /data |
--secret-key |
The secret key to use for the QA webapp. | None |
--workers |
Number of workers to use for web server. | 1 |
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.
Source Distribution
Built Distribution
File details
Details for the file radifox_qa-1.0.1.tar.gz
.
File metadata
- Download URL: radifox_qa-1.0.1.tar.gz
- Upload date:
- Size: 20.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9bcc8fad81afeb5c4aa4ff74849cf27cd228c4b3a19e57c8f9b5d2e46567de9 |
|
MD5 | e9a3ed3356bcfc08f27e311baf986c15 |
|
BLAKE2b-256 | 21ca09cf1708fe2eb37c94b2dab038d4dcebb8fb668ea9ed9e9a67f9dd6c096f |
File details
Details for the file radifox_qa-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: radifox_qa-1.0.1-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | de7558ed6e832ae46492840f8e94350b6ff1d3b78571e1b9315c9ac3b065b5bc |
|
MD5 | d4208a78621f131872a187f2196bddb9 |
|
BLAKE2b-256 | 848ce846b7f97606990dfc6d4c91b6336136d3ccec8c38a40869390846bef6a6 |