************
Installation
************

.. _Chapter-Installation:

.. tags:: ETAS_RTACAR_SQF 001

RTA-SQF is distributed as a platform-specific installer package. Separate installers are provided for Windows and Linux (Ubuntu).

.. TODO: Add information about where to download the installer (Artifactory, ETAS portal, etc.)

Prerequisites
#############
Before installing RTA-SQF, ensure the following components are present on the target system:

- **Administrator / root privileges** — administrator privileges are required to run the installer.
- **RTA-CAR** — RTA-SQF is designed to work with a licensed installed version of RTA-CAR.
- **RTA-SQF license file** — a valid ``.lic`` file is required to run the tool. See `License Configuration`_ for details.

Windows
#######

Installation
************
RTA-SQF is distributed as a self-contained ``.exe`` installer.

**Supported platforms:**

- Windows 11 version 24H2 or later

**Installation steps:**

.. list-table::
   :widths: 10 45 45
   :header-rows: 0

   * - **1.**
     - **Run the RTA-SQF Setup executable**. The Setup Wizard guides through the installation.
     - .. image:: images/win_installer_1.png
          :align: center
          :alt: RTA-SQF Windows installer welcome screen
   * - **2.**
     - **Select the installation directory** and continue with the installation.
     - .. image:: images/win_installer_2.png
          :align: center
          :alt: Select Destination Location page of the Windows installer
   * - **3.**
     - If you want to make ``rta-sqf`` available from any command prompt without specifying the full path, select *Add RTA-SQF to system PATH*.
     - .. image:: images/win_installer_4.png
          :align: center
          :alt: Select Additional Tasks page of the Windows installer
   * - **4.**
     - **Finish** the installation.
     - .. image:: images/win_installer_7.png
          :align: center
          :alt: Installation complete page of the Windows installer

**Installation paths:**

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Item
     - Path
   * - Application directory
     - ``C:\ETAS\RTA-SQF_<version>``
   * - Executable
     - ``C:\ETAS\RTA-SQF_<version>\rta-sqf.exe``
   * - Documentation (PDF)
     - ``C:\ETAS\RTA-SQF_<version>\Documents\``
   * - Start Menu shortcut
     - ``ETAS\RTA-SQF <version>``

Uninstallation
**************

Use *Programs and Features* (or *Apps & features*) in the Windows Control Panel to uninstall RTA-SQF. Each version appears as a separate entry. Alternatively, run the uninstaller from the Start Menu shortcut *ETAS\\RTA-SQF <version>\\Uninstall RTA-SQF <version>*.

Linux
#####

Installation
************
RTA-SQF is distributed as a Debian package (``rta-sqf_<version>_amd64.deb``).

**Supported platforms:**

- Ubuntu 22.04 or later

**Installation steps:**

.. list-table::
   :widths: 10 45 45
   :header-rows: 0

   * - **1.**
     - Install the RTA-SQF package:

       .. code-block:: bash

           sudo dpkg -i rta-sqf_<version>_amd64.deb

     - .. image:: images/linux_installer_1.png
          :align: center
          :alt: Terminal showing the dpkg install command
   * - **2.**
     - The installer runs pre-installation checks (platform detection, ETAS License Manager verification) and then unpacks and configures the package. Upon success, the installation paths and license instructions are printed to the terminal.
     - .. image:: images/linux_installer_2.png
          :align: center
          :alt: Terminal showing successful RTA-SQF package installation output

**Installation paths:**

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - Item
     - Path
   * - Application directory
     - ``/usr/share/ETAS/rta-sqf_<version>/``
   * - Executable
     - ``/usr/share/ETAS/rta-sqf_<version>/rta-sqf``
   * - Shell command (versioned)
     - ``/usr/bin/rta-sqf-<version>``
   * - Shell command (generic)
     - ``/usr/bin/rta-sqf`` — points to the last installed version
   * - Documentation (PDF)
     - ``/usr/share/ETAS/rta-sqf_<version>/Documents/``

Uninstallation
**************

Each version is an independent package. To remove a specific version:

.. code-block:: bash

    sudo dpkg --purge rta-sqf-<version>

License Configuration
#####################
A valid ``.lic`` license file is required to run analysis commands in RTA-SQF.

.. seealso::

   For full details on ETAS license models, activation, and the ETAS License Manager, refer to the **Software Licensing** chapter in the *RTA-CAR User Manual*.

Verifying the Installation
##########################
After installation, verify that RTA-SQF is working correctly by running the following commands:

.. code-block:: bash

    rta-sqf --version
    rta-sqf --help

``--version`` prints the installed version string. 
``--help`` lists all available commands and global options. 

For a complete description of the command-line interface, available commands, and options, refer to chapter :ref:`Working with RTA-SQF <Command-Line-Interface>`.