Downloading & Installing QTools

The recommended way of obtaining QTools is by downloading the QP-bundle↑, which includes QTools as well as all QP Frameworks and also the QM modeling tool↑. The main advantage of obtaining QTools bundled together like that is that you get all components, tools and examples ready to go.

Note: QP-bundle↑ is the recommended way of downloading and installing QTools.
It is also highly recommended that you keep checking the QP-bundle download page↑ for newer releases.

Alternatively, you can download QTools separately as described below.

Installing QTools on Windows

On Windows, you simply unzip the qtools-windows_<x.y.z>.zip archive to the installation folder of your choice; (C:\qp\qtools is the recommended default). After the installation, you still need to:

add the <qtools>\bin and <qtools>\MinGW\bin directories to the global PATH on your system, where <qtools> denotes the directory where you have installed QTools (e.g., C:\qp\qtools\bin;C:\qp\qtools\MinGW\bin).

Note: Adding <qtools>\bin and <qtools>\MinGW\bin directories to your PATH will enable you to invoke all QTools utilities (like QSpy or QClean) by simply typing qspy or qclean at the command prompt, regardless of your current directory. This will come in handy, because typically you will not invoke qspy or qclean from the <qtools>\bin directory.

define the QTOOLS environment variable, for example:

set QTOOLS=C:\qp\qtools

Note: Defining the QTOOLS environment variable is required to run QUTest Unit Testing and the QView Visualization and Monitoring utilities.

Installing QTools on POSIX (Linux/MacOS)

On POSIX (Linux/MacOS), you simply unzip the qtools-posix_<x.y.z>.zip archive to the installation folder of your choice (~/qp/qtools is the recommended default). After the installation, you still need to:

add the <qtools>/bin directory to the global PATH on your system, where <qtools> denotes the directory where you have installed QTools (e.g., ~/qp/qtools).
define the QTOOLS environment variable, for example:

export QTOOLS=~/qp/qtools

Note: Defining the QTOOLS environment variable is required to run QUTest Unit Testing and QView Visualization and Monitoring utilities.

Directories and Files

The following annotated directory tree in the standard QTools distribution lists the top-level directories and files:

qtools
- bin — binaries (executables and libraries)
  - qspy.exe (Windows) or qspy (POSIX) — QSPY executable
  - qclean.exe (Windows) or qclean (POSIX) — QClean Code Whitespace Cleanup executable
  - qfsgen.exe (Windows) or qfsgen (POSIX) — QFSGen ROM File-System Generator executable
  - ~ ~ ~
  - make.exe — make utility (Windows only)
  - rm.exe — rm (remove) utility (Windows only)
  - python.bat — Batch file to call Python (Windows only)
- The following directories are present in QTools for Windows only
- qwin — QWin GUI Prototyping Toolkit
- mingw32 — GNU C/C++ toolset for Windows (32-bit)
- gnu_arm-none-eabi — GNU ARM-EABI toolset for Windows
- python3 — Python 3.8 for Windows

OverviewQP/Spy Software Tracing