Installing MemryX SDK Tools#

Important

For upgrading from pre-Stable SDKs to version 1.0, refer to the SDK 1.0 upgrade guide for detailed instructions.

System Requirements#

This version is designed for Linux or Windows WSL on Intel/AMD platforms, supporting Python 3.9, 3.10, 3.11, and 3.12.

Compatible distributions include Ubuntu 20.04 or later and Debian 11 or later. While other distributions may work, these are the recommended options.

At least 8GB of RAM is recommended for running the Compiler efficiently.

For Mac users, please refer to the FAQ for additional details.

This version is intended for Linux on ARM (v8), supporting Python 3.9, 3.10, 3.11, and 3.12.

Recommended distributions include Ubuntu 20.04 or later, Debian 11 or later, Armbian, and Raspberry Pi OS (64-bit). Other distributions might work as well.

It is recommended to have at least 8GB of RAM for running the Compiler.

Note

The Simulator is currently not available for ARM systems.

First-Time Installation#

Step 1: Prepare Your System

Ensure that you have the correct Python version installed. You can check the Python version on your system using:

python3 --version

If Python is not installed, download and install it from the official Python website .

Additionally, some systems require certain libraries to install the MemryX SDK tools. Always start by updating your package lists to ensure you get the latest versions:

sudo apt update
sudo apt install libhdf5-dev python3-dev cmake python3-venv build-essential

sudo dnf update
sudo dnf install hdf5-devel python3-devel cmake python3-venv build-essential
Step 2: Virtual Environment Setup (Recommended)

While optional, creating a virtual environment is recommended to avoid conflicts with other Python packages.

Use the following commands to create a Python virtual environment in the directory ~/mx (or another preferred location):

python3 -m venv ~/mx
. ~/mx/bin/activate
pip3 install --upgrade pip wheel

Note

  • To use the MemryX SDK, activate the virtual environment whenever you log in: . ~/mx/bin/activate.

  • You can place the virtual environment in any directory, but in this guide, we assume it is located at ~/mx.

Step 3: Install SDK Tools

You can now proceed to install the SDK tools and dependencies:

pip3 install --extra-index-url https://developer.memryx.com/pip memryx

The installation process may take 10 minutes or more to complete. Once finished, you can verify the installation by running:

mx_nc --version

Upgrade#

Important

For information on upgrading pre-Stable SDKs to version 1.0, see the SDK 1.0 upgrade guide.

To upgrade the MemryX SDK tools to the latest version, run the following command:

pip3 install --extra-index-url https://developer.memryx.com/pip --upgrade memryx

Checking the Installed Version#

To verify the version of the installed MemryX SDK tools, use the following command:

mx_nc --version
On this page