quarchpy.qis package¶
Submodules¶
quarchpy.qis.qisFuncs module¶
Contains general functions for starting and stopping QIS processes
- quarchpy.qis.qisFuncs.GetQisModuleSelection(QisConnection)¶
Prints a list of modules for user selection
Deprecated since version 2.0.12: Use the module selection functions of the QisInterface class instead
- quarchpy.qis.qisFuncs.checkAndCloseQis(host='127.0.0.1', port=9722)¶
- quarchpy.qis.qisFuncs.check_remote_qis(host='127.0.0.1', port=9722, timeout=0)¶
Checks if a local or specified instance of QIS is running and responding This continues to scan until qis is found or a timeout is hit.
- Returns
is_running – True if QIS is running and responding
- Return type
bool
- quarchpy.qis.qisFuncs.closeQis(host='127.0.0.1', port=9722)¶
Helper function to close an instance of QIS. By default this is the local version, but an address can be specified for remote systems.
- Parameters
host (str, optional) – Host IP address if not localhost
port (str, optional) – QIS connection port if set to a value other than the default
- quarchpy.qis.qisFuncs.isQisRunning()¶
Checks if a local instance of QIS is running and responding
- Returns
is_running – True if QIS is running and responding
- Return type
bool
- quarchpy.qis.qisFuncs.startLocalQis(terminal=False, headless=False, args=None)¶
Executes QIS on the local system, using the version contained within quarchpy
- Parameters
terminal (bool, optional) – True if QIS terminal should be shown on startup
headless (bool, optional) – True if app should be run in headless mode for non graphical environments
args (list[str], optional) – List of additional parameters to be supplied to QIS on the command line
Module contents¶
- quarchpy.qis.checkAndCloseQis(host='127.0.0.1', port=9722)¶
- quarchpy.qis.closeQis(host='127.0.0.1', port=9722)¶
Helper function to close an instance of QIS. By default this is the local version, but an address can be specified for remote systems.
- Parameters
host (str, optional) – Host IP address if not localhost
port (str, optional) – QIS connection port if set to a value other than the default
- quarchpy.qis.isQisRunning()¶
Checks if a local instance of QIS is running and responding
- Returns
is_running – True if QIS is running and responding
- Return type
bool
- quarchpy.qis.startLocalQis(terminal=False, headless=False, args=None)¶
Executes QIS on the local system, using the version contained within quarchpy
- Parameters
terminal (bool, optional) – True if QIS terminal should be shown on startup
headless (bool, optional) – True if app should be run in headless mode for non graphical environments
args (list[str], optional) – List of additional parameters to be supplied to QIS on the command line