Web Service and Demonstration Applications
Included in this package are a few web-based service and demonstration applications, providing a view into the functionality provided by the included algorithms and utilities.
runApplication
This script can be used to run any conforming (derived from SmqtkWebApp) SMQTK web based application.
Web services should be runnable via the bin/runApplication.py script.
Runs conforming SMQTK Web Applications.
usage: runApplication [-h] [-v] [-c PATH] [-g PATH] [-l] [-a APPLICATION] [-r]
[-t] [--host HOST] [--port PORT] [--use-basic-auth]
[--use-simple-cors] [--debug-server] [--debug-smqtk]
[--debug-app] [--debug-ns DEBUG_NS]
Named Arguments
- -v, --verbose
Output additional debug logging.
Default: False
Configuration
- -c, --config
Path to the JSON configuration file.
- -g, --generate-config
Optionally generate a default configuration file at the specified path. If a configuration file was provided, we update the default configuration with the contents of the given configuration.
Application Selection
- -l, --list
List currently available applications for running. More description is included if SMQTK verbosity is increased (-v | –debug-smqtk)
Default: False
- -a, --application
Label of the web application to run.
Server options
- -r, --reload
Turn on server reloading.
Default: False
- -t, --threaded
Turn on server multi-threading.
Default: False
- --host
Run host address specification override. This will override all other configuration method specifications.
- --port
Run port specification override. This will override all other configuration method specifications.
- --use-basic-auth
Use global basic authentication as configured.
Default: False
- --use-simple-cors
Allow CORS for all domains on all routes. This follows the “Simple Usage” of flask-cors: https://flask-cors.readthedocs.io/en/latest/#simple-usage
Default: False
Other options
- --debug-server
Turn on server debugging messages ONLY. This is implied when -v|–verbose is enabled.
Default: False
- --debug-smqtk
Turn on SMQTK debugging messages ONLY. This is implied when -v|–verbose is enabled.
Default: False
- --debug-app
Turn on flask app logger namespace debugging messages ONLY. This is effectively enabled if the flask app is provided with SMQTK and “–debug-smqtk” is passed. This is also implied if -v|–verbose is enabled.
Default: False
- --debug-ns
Specify additional python module namespaces to enable debug logging for.
Default: []