Tutorials
++++++++++

There is a tutorial project named `mtf_basic_tuto <https://git.technica-engineering.net/te-libraries/mtf_tutorials/-/tree/develop/mtf_basic_tuto?ref_type=heads>`_
that provides tutorials test cases covering **some of the basic features of the MTF Python Api** and help getting started with it.

Getting started
#####################

Cloning MTF_tutorials repo
****************************

Begin by cloning the **'MTF_tutorials'** repository.
Here are the instructions for cloning the repository on different operating systems:

Clone repository in Windows
=============================

1. Download and install `Git <https://git-scm.com/downloads>`_.
2. Open your command prompt or terminal window.
3. Navigate to the directory where you want to clone the repository.
4. Use the **'git clone'** command followed by the URL of the **'MTF_tutorials'** repository.

.. code-block:: bash

    git clone https://git.technica-engineering.net/te-libraries/mtf_tutorials

Clone repository in Linux
===========================

1. Download and install Git following this instructions provided here: `Download for Linux and Unix <https://git-scm.com/download/linux>`_.
2. Open your terminal window from the application menu or by pressing **'Ctrl+Alt+T'**.
3. Navigate to the directory where you want to clone the repository.
4. Use the **'git clone'** command followed by the URL of the **'MTF_tutorials'** repository.

.. code-block:: bash

    git clone https://git.technica-engineering.net/te-libraries/mtf_tutorials


Install the Microsoft Loopback ETHERNET Adapter
##################################################

To execute the test cases, follow this guide to create a Microsoft Loopback Ethernet Adapter,
which is already included in the YAML test bench configuration file: `Install the Microsoft Loopback ETHERNET Adapter <https://git.technica-engineering.net/te-libraries/mtf_tutorials/-/blob/develop/mtf_basic_tuto/README.md?ref_type=heads>`_

Available test cases
######################

This project contains multiple test cases, including **basic burst transmission**, **frames transmission**,
**frames capture**, **signal checking**, **faulty alive apply**, **faulty CRC apply**, and other test cases.
You can find these test cases inside the project repository: `tests folder <https://git.technica-engineering.net/te-libraries/mtf_tutorials/-/tree/develop/mtf_basic_tuto/tests?ref_type=heads>`_

Executing test cases
######################

To execute the test cases, run the following command line: `Execution command line <https://git.technica-engineering.net/te-libraries/mtf_tutorials/-/blob/develop/mtf_basic_tuto/commandt.txt?ref_type=heads>`_

.. important::

    You need to change the test series configuration file name to run the desired test series.