MX Module Validation Suite

The MX Module Validation Suite consists of MemryX MXM Deployment Tool, a cross-platform utility for validating and benchmarking systems equipped with MemryX MX3 M.2 modules.
It supports both GUI and CLI modes to test performance, thermal behavior, power consumption, and overall stability.

For detailed usage instructions, refer to the full manual:
manual/MX-M Deployment Tool.pdf

---

Repository Structure

.
├── binary_release/
│   ├── aarch64/
│   │   └── Linux/
│   │       ├── MXMDeploymentTool
│   │       ├── MXMDeploymentToolCli
│   │       ├── config_template.json
│   │       └── results/
│   ├── x86_64/
│   │   ├── Linux/
│   │   │   ├── MXMDeploymentTool
│   │   │   ├── MXMDeploymentToolCli
│   │   │   ├── config_template.json
│   │   │   └── results/
│   │   └── Windows/
│   │       ├── MXMDeploymentTool.exe
│   │       ├── MXMDeploymentToolCli.exe
│   │       ├── config_template.json
│   │       ├── Qt6*.dll
│   │       └── supporting Qt plugin DLLs
├── manual/
│   │   └── MX-M Deployment Tool.pdf
├── scripts/
│   ├── setup_resources_linux.sh
│   └── setup_resources_windows.ps1
└── setup_resources

---

Setup Instructions

The binaries require model resource files (.dfp) that are not included in this repository.
Use the setup script to download and organize them automatically.

From the repository root, run:

./setup_resources

The script:

• Detects your operating system (Linux, macOS, or Windows)
• Runs the appropriate setup script under scripts/
• Downloads required model packages from the MemryX Developer Portal
• Extracts only the .dfp files
• Copies them into platform-specific locations:

Platform	Target Paths
Linux (x86_64 / aarch64)	binary_release/aarch64/Linux/resources/ binary_release/x86_64/Linux/resources/
Windows (x86_64)	binary_release/x86_64/Windows/resources/

After setup completes, the binaries for your platform will have their resource folders ready.

---

Running the Tool

GUI

Linux:

The GUI requires several Qt libraries. These can be installed using the following command:

sudo apt install qt6-base-dev libqt6opengl6-dev libgl1-mesa-dev libxkbcommon-dev libqt6charts6-dev

After installing dependencies, run the tool as follows:

cd binary_release/x86_64/Linux
./MXMDeploymentTool

Windows:

All necessary Qt libraries are already bundled with the release package. No additional installation is required.

binary_release\x86_64\Windows\MXMDeploymentTool.exe

CLI

Linux:

cd binary_release/x86_64/Linux
./MXMDeploymentToolCli 

Windows:

binary_release\x86_64\Windows\MXMDeploymentToolCli.exe

All test results are saved in the local results/ folder in both CSV and JSON formats.

Clean-Up Script

If you need to remove all generated resources/ and results/ folders (for example, to reset the environment or reduce repository size), you can use the built-in cleanup utility.

From the repository root, run:

./clean_up

The script automatically detects your platform and:

• Deletes all resources/ directories:
  • resources/
  • binary_release/aarch64/Linux/resources/
  • binary_release/x86_64/Linux/resources/
  • binary_release/x86_64/Windows/resources/
• Deletes all results/ folders containing output files.

You’ll be prompted for confirmation before deletion.
To skip confirmation (for automation or CI use), use:

./clean_up --force

---

Supported Platforms

• Operating Systems: Ubuntu 22.04 / 24.04, Windows 10 / 11
• Architectures: x86_64 and aarch64
• Modules: MemryX MX3 M.2

---

Documentation

For complete instructions, test configuration details, and examples, see:
manual/MX-M Deployment Tool.pdf