Introduction
============

Welcome to the documentation for the XMARTe interface - a graphical user interface for configuring, simulating, and compiling MARTe2 applications using block-based programming.

Users are assumed to have knowledge of MARTe2 prior to developing with XMARTe.

The application is designed to abstract the complexity of text-based configuration files by enabling the user to define and manage MARTe2 applications graphically.

To use configuration files after generating them from XMARTe, you will need to compile `MARTe2 <https://github.com/aneto0/MARTe2>`_ and `MARTe2-components <https://github.com/aneto0/MARTe2-components>`_.
Instructions on how to set this up can be found `here <https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova/-/tree/master?ref_type=heads#:~:text=Setting%20up%20environment>`_.

Installing
----------
This project is compatible with Windows and Linux systems.

1. Install via PyPI:

.. code-block:: bash

   pip install xmarte

2. Run XMARTe:

.. code-block:: bash

   python -m xmarte

Support
-------
If you have found a bug or would like to request a feature, please `submit an issue <https://git.ccfe.ac.uk/marte21/xmarte/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=>`_ to the XMARTe repository.

For further support, please contact a member of our team:

- `Edward Jones <edward.jones1@ukaea.uk>`_
- `Adam Stephen <adam.stephen@ukaea.uk>`_
- `Hudson Baker <hudson.baker@ukaea.uk>`_

Or ask a member of the `MARTe community <https://discord.gg/anSXWtnprW>`_ over on Discord.

Contributing
------------
If you would like to contribute to XMARTe yourself, please refer to our :doc:`contributor guidelines <contributing>`.

Licence
-------
This software repository is provided under the `European Union Public Licence <https://wayback.archive-it.org/12090/20200210204548/https://ec.europa.eu/idabc/en/document/7774.html>`_.