xmarte 0.1.0__tar.gz

xmarte-0.1.0/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2024 UKAEA 
+
+Licensed under the EUPL, Version 1.1 or - subsequent versions of the EUPL (the "Licence"). You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl
+
+Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence permissions and limitations under the Licence.

xmarte-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include *.xmt
+include *.png
+include *.json
+include *.css
+recursive-include xmarte *.xmt
+recursive-include xmarte *.png
+recursive-include xmarte *.json
+recursive-include xmarte *.css

xmarte-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.1
+Name: xmarte
+Version: 0.1.0
+Summary: A GUI Application for configuration MARTe2 applications.
+Author-email: Edward Jones <edward.jones1@ukaea.uk>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyQt5>=5.15.2
+Requires-Dist: PyQt5-Qt5>=5.15.2
+Requires-Dist: qdarkgraystyle>=1.0.2
+Requires-Dist: pandas>=2.0.2
+Requires-Dist: qtpy>=2.4.1
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: pytest>=8.1.1
+Requires-Dist: pytest-qt>=4.4.0
+Requires-Dist: ruff>=0.3.5
+Requires-Dist: fpdf>=1.7.2
+Requires-Dist: pyqtchart>=5.15.2
+Requires-Dist: pyqt-modern-slider>=0.0.5
+Requires-Dist: matplotlib>=3.8.3
+Requires-Dist: cryptography>=42.0.8
+Requires-Dist: pytest-mock>=3.14.0
+Requires-Dist: scipy>=1.13.1
+Requires-Dist: nodeeditor
+Requires-Dist: martepy
+
+# Introduction
+
+Welcome to the documentation for the XMARTe interface. A Graphical user interface for configuring, simulating and compiling MARTe2 Applications in a graphically based configuration method, mostly known as block based programming.
+
+## Intended Use
+
+It is assumed that users have knowledge of MARTe2 prior to using this application.
+
+The application is intended for end users to develop MARTe2 applications rather than text based config files, this gives the user the ability to define and manage configurations in a graphical user interface.
+
+This application helps generate configuration files for MARTe2, to actually use the files you will need MARTe2 compiled alongside MARTe2-components and setup to be usable - namely with the [traditional marte shell script](https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova/-/blob/master/Startup/Main.sh?ref_type=heads). Initial setup instructions for MARTe2 and it's dependencies can be [found here](https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova/-/tree/master?ref_type=heads).
+
+## Contributing & Support
+
+When you require support please open an issue, if you would like to make adjustments to behaviour, code or additions to features, please do so as an issue and merge request.
+
+**Note: You must comply with our guidelines as per the below.**
+
+[Repository Guidelines](./Guidelines.md)
+
+## Installation
+
+This project can work in both Windows and Linux based systems, requiring access right now to our internal gitlab repository - however in future will be available publicly.
+
+``` bash
+pip install xmarte
+```
+
+## Running
+
+Running the GUI can be done via the command:
+
+``` bash
+python -m xmarte
+```
+
+For further guidance and documentation on using the GUI please refer to:
+
+<h2><a href="https://ukaea.github.io/xMARTe/">Official Documentation</h2>
+
+## Current Features
+
+- Define new and read pre-existing configurations.
+- Manage the state machine: states, events and messages.
+- Manage a HTTP Instance and messages included.
+- Use the standard GAMs and DataSources.*
+- Type Database for managing simple, complex and nested types.
+- Simulation framework to test configurations.
+- Graphing to view recorded data.
+
+## Support
+
+For support on using this application you can refer to the documentation found here:
+
+[User Documentation](https://ukaea.github.io/xMARTe/)
+
+If you have found a bug or have a feature request then please submit an issue within this repository.
+
+If you need additional support feel free to contact our team:
+
+- [Edward Jones](mailto:edward.jones1@ukaea.uk)
+- [Adam Stephen](mailto:adam.stephen@ukaea.uk)
+- [Hudson Baker](mailto:hudson.baker@ukaea.uk)
+
+Additionally you can utilise the MARTe Discord community server:
+
+[MARTe Discord Server](https://discord.gg/anSXWtnprW)
+
+## License
+
+This software repository is provided under the European Union Public Licence as it's rooted in the use of MARTe2. You can find further details on the license [here](https://wayback.archive-it.org/12090/20200210204548/https://ec.europa.eu/idabc/en/document/7774.html).

xmarte-0.1.0/README.md

@@ -0,0 +1,71 @@
+# Introduction
+
+Welcome to the documentation for the XMARTe interface. A Graphical user interface for configuring, simulating and compiling MARTe2 Applications in a graphically based configuration method, mostly known as block based programming.
+
+## Intended Use
+
+It is assumed that users have knowledge of MARTe2 prior to using this application.
+
+The application is intended for end users to develop MARTe2 applications rather than text based config files, this gives the user the ability to define and manage configurations in a graphical user interface.
+
+This application helps generate configuration files for MARTe2, to actually use the files you will need MARTe2 compiled alongside MARTe2-components and setup to be usable - namely with the [traditional marte shell script](https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova/-/blob/master/Startup/Main.sh?ref_type=heads). Initial setup instructions for MARTe2 and it's dependencies can be [found here](https://vcis-gitlab.f4e.europa.eu/aneto/MARTe2-demos-padova/-/tree/master?ref_type=heads).
+
+## Contributing & Support
+
+When you require support please open an issue, if you would like to make adjustments to behaviour, code or additions to features, please do so as an issue and merge request.
+
+**Note: You must comply with our guidelines as per the below.**
+
+[Repository Guidelines](./Guidelines.md)
+
+## Installation
+
+This project can work in both Windows and Linux based systems, requiring access right now to our internal gitlab repository - however in future will be available publicly.
+
+``` bash
+pip install xmarte
+```
+
+## Running
+
+Running the GUI can be done via the command:
+
+``` bash
+python -m xmarte
+```
+
+For further guidance and documentation on using the GUI please refer to:
+
+<h2><a href="https://ukaea.github.io/xMARTe/">Official Documentation</h2>
+
+## Current Features
+
+- Define new and read pre-existing configurations.
+- Manage the state machine: states, events and messages.
+- Manage a HTTP Instance and messages included.
+- Use the standard GAMs and DataSources.*
+- Type Database for managing simple, complex and nested types.
+- Simulation framework to test configurations.
+- Graphing to view recorded data.
+
+## Support
+
+For support on using this application you can refer to the documentation found here:
+
+[User Documentation](https://ukaea.github.io/xMARTe/)
+
+If you have found a bug or have a feature request then please submit an issue within this repository.
+
+If you need additional support feel free to contact our team:
+
+- [Edward Jones](mailto:edward.jones1@ukaea.uk)
+- [Adam Stephen](mailto:adam.stephen@ukaea.uk)
+- [Hudson Baker](mailto:hudson.baker@ukaea.uk)
+
+Additionally you can utilise the MARTe Discord community server:
+
+[MARTe Discord Server](https://discord.gg/anSXWtnprW)
+
+## License
+
+This software repository is provided under the European Union Public Licence as it's rooted in the use of MARTe2. You can find further details on the license [here](https://wayback.archive-it.org/12090/20200210204548/https://ec.europa.eu/idabc/en/document/7774.html).

xmarte-0.1.0/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "xmarte"
+version = "0.1.0"
+description = "A GUI Application for configuration MARTe2 applications."
+readme = "README.md"
+authors = [
+    { name = "Edward Jones", email = "edward.jones1@ukaea.uk" }
+]
+requires-python = ">=3.9"
+dependencies = [
+    "PyQt5>=5.15.2",
+    "PyQt5-Qt5>=5.15.2",
+    "qdarkgraystyle>=1.0.2",
+    "pandas>=2.0.2",
+    "qtpy>=2.4.1",
+    "pyyaml>=6.0.1",
+    "pytest>=8.1.1",
+    "pytest-qt>=4.4.0",
+    "ruff>=0.3.5",
+    "fpdf>=1.7.2",
+    "pyqtchart>=5.15.2",
+    "pyqt-modern-slider>=0.0.5",
+    "matplotlib>=3.8.3",
+    "cryptography>=42.0.8",
+    "pytest-mock>=3.14.0",
+    "scipy>=1.13.1",
+    "nodeeditor",
+    "martepy"
+]
+
+[tool.setuptools.packages.find]
+# Specify the include pattern to discover specific packages in the root
+include = ["xmarte","xmarte.*"]
+exclude = ["marte2_python","marte2_python.*"]
+
+[tool.setuptools.package-data]
+"my_package" = ["*.xmt", "*.png", "*.json", "*.css", "**/*.xmt", "**/*.png", "**/*.json", "**/*.css"]  # Include .xmt and .png files
+
+[tool.pylint]
+disable = [
+    "raw-checker-failed",
+    "bad-inline-option",
+    "locally-disabled",
+    "file-ignored",
+    "suppressed-message",
+    "useless-suppression",
+    "deprecated-pragma",
+    "use-symbolic-message-instead",
+    "C0413",
+    "R0902",
+    "W0102",
+    "R0903",
+    "R0913",
+    "W0401",
+    "C0302",
+    "R0917",
+    "duplicate-code"
+]
+extension-pkg-whitelist="PyQt5"
+max-line-length = 100
+ignore = ["CVS","my_first_plugin","docker","build_system","build","test"]
+method-naming-style="camelCase"
+function-naming-style="camelCase"
+variable-naming-style="any"
+class-attribute-naming-style="any"
+argument-naming-style="snake_case"
+attr-naming-style="any"
+
+[tool.coverage.run]
+omit = ["test/*", ".github", "docs/*", "cov_html", "build", ".pytest_cache/*"]
+
+[tool.coverage.report]
+omit = ["test/*", ".github", "docs/*", "cov_html", "build", ".pytest_cache/*"]
+show_missing = true
+precision = 2
+
+[tool.coverage.html]
+directory = "cov_html"
+title = "Coverage Report for xMARTe2"
+
+[tool.pytest.ini_options]
+qt_api = "pyqt5"
+testpaths = ["test"]
+
+addopts = [
+   "--ignore=xmarte",
+   "--ignore=test/marte2_python",
+   "--ignore=test/test_menus/test_deployment_menu.py",
+   "-W", "ignore::DeprecationWarning"
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

xmarte-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xmarte-0.1.0/xmarte/__main__.py

@@ -0,0 +1,43 @@
+'''
+Main entry point to the application from the module instance in site-packages
+'''
+
+import os
+
+from PyQt5.QtGui import QPixmap, QColor
+from PyQt5.QtWidgets import QApplication, QSplashScreen
+from PyQt5.QtCore import Qt
+
+from xmarte import qt
+
+qt.splash = None
+
+if __name__ == "__main__":
+    app = QApplication([])
+    if hasattr(Qt, "AA_EnableHighDpiScaling"):
+        app.setAttribute(Qt.AA_EnableHighDpiScaling, True)
+
+    if hasattr(Qt, "AA_UseHighDpiPixmaps"):
+        app.setAttribute(Qt.AA_UseHighDpiPixmaps, True)
+
+    pixmap_file = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), "splashscreen.jpg")
+    )
+    pixmap = QPixmap(pixmap_file)
+    screen_resolution = QApplication.instance().desktop().screenGeometry().size()
+    SIZE_RATIO = 0.5
+    scaled_width = int(screen_resolution.width() * SIZE_RATIO)
+    scaled_height = int(screen_resolution.height() * SIZE_RATIO)
+    scaled_image = pixmap.scaled(scaled_width, scaled_height,
+                                    aspectRatioMode=Qt.KeepAspectRatio)
+
+    qt.splash = QSplashScreen(scaled_image)
+    qt.splash.show()
+    qt.splash.setStyleSheet("font-size: 15px; font-weight: bold;")
+
+    qt.splash.showMessage("<h1><font color='white'>Importing modules...</font></h1>",
+        Qt.AlignBottom | Qt.AlignLeft, QColor("white"))
+
+    win = qt.XMARTeTool(app)
+    win.show()
+    app.exec_()

xmarte-0.1.0/xmarte/nodeeditor/node_edge.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+"""
+A module containing NodeEditor's class for representing Edge and Edge Type Constants.
+"""
+from nodeeditor.node_edge import Edge
+
+from xmarte.nodeeditor.node_graphics_edge import XMARTeQDMGraphicsEdge
+
+class XMARTeEdge(Edge):
+
+    def createEdgeClassInstance(self):
+        """
+        Create instance of grEdge class
+        :return: Instance of `grEdge` class representing the Graphics Edge in the grScene
+        """
+        self.grEdge = self.getGraphicsEdgeClass()(self)
+        self.scene.grScene.addItem(self.grEdge)
+        if self.start_socket is not None:
+            self.updatePositions()
+        return self.grEdge
+
+    def getGraphicsEdgeClass(self):
+        """Returns the class representing Graphics Edge"""
+        return XMARTeQDMGraphicsEdge
+    
+    def deserialize(self, data:dict, hashmap:dict={}, restore_id:bool=True, *args, **kwargs) -> bool:
+        if restore_id: self.id = data['id']
+        if data['start'] is not None:
+            self.start_socket = hashmap[data['start']]
+            self.end_socket = hashmap[data['end']]
+        self.edge_type = data['edge_type']

xmarte-0.1.0/xmarte/nodeeditor/node_edge_dragging.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+"""
+A module containing the Edge Dragging functionality
+"""
+from nodeeditor.node_graphics_socket import QDMGraphicsSocket
+from nodeeditor.node_edge_dragging import EdgeDragging
+from nodeeditor.utils import dumpException
+
+from nodeeditor.node_edge import EDGE_TYPE_DEFAULT
+
+DEBUG = False
+
+class XMARTeEdgeDragging(EdgeDragging):
+    def edgeDragEnd(self, item:'QGraphicsItem'):
+        """Code handling the end of the dragging an `Edge` operation. If this code returns True then skip the
+        rest of the mouse event processing. Can be called with ``None`` to cancel the edge dragging mode
+
+        :param item: Item in the `Graphics Scene` where we ended dragging an `Edge`
+        :type item: ``QGraphicsItem``
+        """
+
+        # early out - clicked on something else than Socket
+        if not isinstance(item, QDMGraphicsSocket):
+            self.grView.resetMode()
+            if DEBUG: print('View::edgeDragEnd ~ End dragging edge early')
+            self.drag_edge.remove(silent=True)      # don't notify sockets about removing drag_edge
+            self.drag_edge = None
+
+
+        # clicked on socket
+        if isinstance(item, QDMGraphicsSocket):
+
+            # check if edge would be valid
+            if not self.drag_edge.validateEdge(self.drag_start_socket, item.socket):
+                print("NOT VALID EDGE")
+                return False
+
+            # regular processing of drag edge
+            self.grView.resetMode()
+
+            if DEBUG: print('View::edgeDragEnd ~ End dragging edge')
+            self.drag_edge.remove(silent=True)      # don't notify sockets about removing drag_edge
+            self.drag_edge = None
+
+            try:
+                if item.socket != self.drag_start_socket:
+                    # if we released dragging on a socket (other then the beginning socket)
+
+                    ## First remove old edges / send notifications
+                    for socket in (item.socket, self.drag_start_socket):
+                        if not socket.is_multi_edges:
+                            if socket.is_input:
+                                # print("removing SILENTLY edges from input socket (is_input and !is_multi_edges) [DragStart]:", item.socket.edges)
+                                socket.removeAllEdges(silent=True)
+                            else:
+                                socket.removeAllEdges(silent=False)
+
+
+                    ## Create new Edge
+                    # Handle backwards setup
+                    if item.socket.is_input:
+                        new_edge = self.getEdgeClass()(item.socket.node.scene, self.drag_start_socket, item.socket, edge_type=EDGE_TYPE_DEFAULT)
+                    if self.drag_start_socket.is_input:
+                        new_edge = self.getEdgeClass()(item.socket.node.scene, item.socket, self.drag_start_socket, edge_type=EDGE_TYPE_DEFAULT)
+                    if DEBUG: print("View::edgeDragEnd ~  created new edge:", new_edge, "connecting", new_edge.start_socket, "<-->", new_edge.end_socket)
+
+                    ## Send notifications for the new edge
+                    for socket in [self.drag_start_socket, item.socket]:
+                        # @TODO: Add possibility (ie when an input edge was replaced) to be silent and don't trigger change
+                        socket.node.onEdgeConnectionChanged(new_edge)
+                        if socket.is_input: socket.node.onInputChanged(socket)
+
+                    self.grView.grScene.scene.history.storeHistory("Created new edge by dragging", setModified=True)
+                    return True
+            except Exception as e: dumpException(e)
+
+
+        if DEBUG: print('View::edgeDragEnd ~ everything done.')
+        return False

xmarte-0.1.0/xmarte/nodeeditor/node_edge_validators.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+"""
+A module containing the Edge Validator functions which can be registered as callbacks to
+:class:`~nodeeditor.node_edge.Edge` class.
+
+Example of registering Edge Validator callbacks:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can register validation callbacks once for example on the bottom of node_edge.py file or on the
+application start with calling this:
+
+.. code-block:: python
+
+    from nodeeditor.node_edge_validators import *
+
+    Edge.registerEdgeValidator(edge_validator_debug)
+    Edge.registerEdgeValidator(edge_cannot_connect_two_outputs_or_two_inputs)
+    Edge.registerEdgeValidator(edge_cannot_connect_input_and_output_of_same_node)
+    Edge.registerEdgeValidator(edge_cannot_connect_input_and_output_of_different_type)
+
+
+"""
+from nodeeditor.node_edge_validators import print_error
+
+DEBUG = False
+
+def edge_start_socket_must_exist(input: 'Socket', output: 'Socket') -> bool:
+    """Edge is invalid if the node it started from was deleted whilst dragging"""
+    if input.node.grNode is None or output.node.grNode is None:
+        print_error("A connecting node has been deleted")
+        return False
+    return True

xmarte-0.1.0/xmarte/nodeeditor/node_editor_widget.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+"""
+A module containing ``NodeEditorWidget`` class
+"""
+from nodeeditor.node_editor_widget import NodeEditorWidget
+from nodeeditor.utils import dumpException
+from nodeeditor.node_scene import InvalidFile
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QMessageBox, QApplication
+
+class XMARTeNodeEditorWidget(NodeEditorWidget):
+    def fileLoad(self, filename:str, *args, **kwargs):
+        """Load serialized graph from JSON file
+
+        :param filename: file to load
+        :type filename: ``str``
+        """
+        QApplication.setOverrideCursor(Qt.WaitCursor)
+        try:
+            self.scene.loadFromFile(filename, *args, **kwargs)
+            self.filename = filename
+            self.scene.history.clear()
+            self.scene.history.storeInitialHistoryStamp()
+            return True
+        except FileNotFoundError as e:
+            dumpException(e)
+            QMessageBox.warning(self, "Error loading %s" % os.path.basename(filename), str(e).replace('[Errno 2]',''))
+            return False
+        except InvalidFile as e:
+            dumpException(e)
+            # QApplication.restoreOverrideCursor()
+            QMessageBox.warning(self, "Error loading %s" % os.path.basename(filename), str(e))
+            return False
+        finally:
+            QApplication.restoreOverrideCursor()