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 and MARTe2-components. Instructions on how to set this up can be found here.

Installing

This project is compatible with Windows and Linux systems.

  1. Install via PyPI:

pip install xmarte

  1. Run XMARTe:

python -m xmarte

Support

If you have found a bug or would like to request a feature, please submit an issue to the XMARTe repository.

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

Or ask a member of the MARTe community over on Discord.

Contributing

If you would like to contribute to XMARTe yourself, please refer to our contributor guidelines.

Licence

This software repository is provided under the European Union Public Licence.