Calling Options
***************

The following options are available for the |rte_command_name| command:

.. _rte_command_options:

.. list-table:: |rte_command_name| options
    :header-rows: 1
    :widths: 20 60 20

    * - Option
      - Description
      - Optional
    * - ``--rte-log-file``
      - Specifies the absolute or relative path to the log file from the RTEGen tool execution. 
        If a relative path is provided, it is resolved against the project folder (``--dir``)
      - No
    * - ``--rte-inst-folder``
      - Specifies the absolute or relative path to the installation folder of the RTEGen tool. 
        The ``bin`` folder is expected in this path. 
        If a relative path is provided, it is resolved against the project folder (``--dir``)
      - No
    
The General Options, valid for all commands, are listed in :ref:`global-options <global-options>`.

Examples
========

The simplest form of a call uses only the mandatory parameters:

.. code:: bash

    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE"

----

An alternative way is to use the :ref:`dir <rte_command_options>` parameter to resolve relative paths:

.. code:: bash

    rta-sqf rte --dir="C:\RTEProject" --rte-log-file="rte.log" --rte-inst-folder="RTE"

----

The :ref:`only <rte_command_options>` option can be used to limit validation to a subset of AoUs:

.. code:: bash

    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --only=ETAS_RTACAR_SM_RTE_003
    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --only=ETAS_RTACAR_SM_RTE_003,ETAS_RTACAR_SM_RTE_004

----

The :ref:`ignore <rte_command_options>` option can be used to exclude a subset of AoUs from validation:

.. code:: bash

    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --ignore=ETAS_RTACAR_SM_RTE_003
    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --ignore=ETAS_RTACAR_SM_RTE_003,ETAS_RTACAR_SM_RTE_004

----

By defining the :ref:`verbose <rte_command_options>` option, additional information about the execution will be shown on the console.

.. code:: bash

    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --verbose


----

To choose the folder where the rta-sqf tool will store the results, use the :ref:`out-dir <rte_command_options>` option.

.. code:: bash

    rta-sqf rte --rte-log-file="C:\RTE-Output\rte.log" --rte-inst-folder="C:\ETAS\RTE" --out-dir=".\checkResult" --verbose

.. note:: Output folder creation

    If the specified output directory does not exist, the tool will attempt to create it.