Support MES M-XRAY® (MXRAY)

What is MXRAY?

MXRAY is a tool that has been designed to perform architectural analysis on Simulink/Stateflow and TargetLink models, thereby supporting model development and the model review process. MXRAY has been developed to analyze models of every size: from single subsystems to complex models consisting of hundreds of subsystems and dozens of libraries. The results of analysis are compiled in reports designed for use in model development and model reviews. The reports can also be used to evaluate model quality as well as for project management purposes.

What's new?

Highlights in MES M-XRAY® (MXRAY) v.4.1

Enhanced understanding of Stateflow quota in Simulink/Stateflow models:
The new metric 'Global Complexity Stateflow' estimates the proportion of Stateflow parts in the 'Global Complexity' of the model.

Html-report is now stored in a single file.

► Read about all new features in the Release Notes

System requirements

The following system requirements must be in place to use MXRAY:

  • Windows (XP, Vista, Windows 7+8+10 - 32 and 64-bit versions)
  • MATLAB® R2009b ... R2019a
  • Simulink and Stateflow, depending on the models you wish to analyze
  • (Optional) TargetLink V 2.x, 3.x, 4.x (base suite)
  • (Optional) Excel for Windows

Update to the latest version

  • If you added MXRAY folders permanently to the MATLAB path, please remove all these folders from the path.
  • If you added a call to path_mxray to your startup.m and used a folder with version postfix (e.g. x:\project\matlab\mxray_3_7), then please update the call to the folder of the new installation (e.g. run('C:\Program Files\mxray_4_1\path_mxray');
  • If you installed the old version to a folder with version postfix (e.g. x:\project\matlab\mxray_3_7), you can keep that directory as a backup.
  • If you installed without version postfix, you could rename the old installation directory to one with version postfix as a backup.
  • Then proceed according to the installation instructions given below (including license configuration).

Installation

  • Extract the MXRAY zip file (e.g. mxray_4_1.zip) into a target folder with write access. Suggestions:
    • %MATLAB_ROOT%\toolbox\mxray_4_1
    • %MATLAB_ROOT%\toolbox\mxray
    • C:\Program Files\mxray
    • x:\project\matlab\mxray_4_1
    Please keep all the subdirectories.
  • Note: If you want to install MXRAY on a Jenkins machine to use it together with the MES Jenkins-Plugin, it is recommended to skip the next steps and proceed with the license configuration. The next steps add MXRAY permanently to the MATLAB path. But for the Jenkins Plugin it is recommended to specify the MXRAY installation path in Jenkins' global tool configuration.
  • Add a call to the path_mxray.m script from the target folder to your MATLAB startup.m file. Example call: run('C:\Program Files\mxray\path_mxray'); Please make sure, that there is no call to path_mxray of an old MXRAY installation left! If you are not sure whether you have any startup.m file yet, type which startup.m in MATLAB command line. If result is not empty, add the call from above to this file. If result is empty, create a new startup.m file in your userpath. Type userpath in MATLAB command line to get your userpath. Add the call from above to the newly created file (type also doc startup in MATLAB command line for help).
  • Restart MATLAB. Please check if you correctly added the path_mxray call to your startup.m file by typing which('mxray') in the MATLAB command prompt which should return the path of the mxray.p file.

Quick start

Starting MXRAY

    • Open MATLAB.
    • Type mxray in the command prompt.
    If an 'Undefined function' error occurs, please ensure that you added the correct call to path_mxray to your startup.m (see installation instructions above). If a license exception occurs, please ensure that you followed the license configuration instructions above.

Starting an analysis

  • Open a model in MATLAB/Simulink
  • Press "Add open models" in the MXRAY GUI
  • Press "Create Report" in the MXRAY GUI

Suggestions

If you have any suggestions to help us improve MES M-XRAY, please do not hesitate to contact us:
Email: mxray@model-engineers.com

User Guide

MXRAY User Guide

The MES User Guide presents clear instructions on how to work with M-XRAY® (MXRAY). It provides users with information about getting started and working with MXRAY.
You can easily call the User Guide by clicking on “Help” in the tool (see image).


Release Notes

4.1.0 / March 2019

  • New metric for estimating the Stateflow portion of the model:
      A new metric called 'Global Complexity Stateflow' has been added which can be used to estimate the proportion of Stateflow in the 'Global Complexity' of the model being analyzed. The new metric has been added to the 'Global Value Summary' of the HTML report.
  • Entire HTML report is stored as a single file:
      The plots of the HTML report are now embedded into the HTML file via Base64 encoding and are no longer stored as separate files. Thus, the entire HTML report can be saved/archived/exchanged as a single file. The embedding of the plots can be deactivated via the new 'NoEmbeddedPlots' parameter of mxray_createReport.
  • Excel report automatically overwrites existing report:
      In order to have a uniform behavior across all report formats, the Excel report is now automatically overwritten if a report with the same file name already exists. Previously, a corresponding warning dialog was displayed in Excel. Suppressing this dialog is especially important if the report is generated automatically by a script.
  • BugFix: In rare cases, an error was raised during the HTML report
      creation ('XData can not contain duplicate values') if buses with more than 1000 elementary signals were used in combination with the '%Elementary Inputs Unused (globally)' metric. This has been fixed.