Installation

N.B.: You may need to make sure you have OpenMP installed on your machine before you can install Helix.

On Mac:

brew install libomp

On Linux (Ubuntu)

sudo apt install libomp-dev

On Windows, this doesn’t seem to be a problem. You should be able to proceed with installation.

---

Getting the code

You can obtain the Helix source code by cloning the repository from Github.

git clone https://github.com/Biomaterials-for-Medical-Devices-AI/Helix.git

Setting up your developer environment

First you will need to ensure that you have Python installed. Helix requires version 3.11 or higher to run.

Next you need to create a virtual environment to run Helix.

Mac/Linux

# Create using venv
python -m venv <path/to/env>
source <path/to/env>/bin/activate

# -- OR --

# Create using conda
conda create -n <env_name> python=3.11
conda activate <env_name>

Windows

# Create using venv
python -m venv <path\to\env>
<path/to/env>\Scripts\activate

# -- OR --

# Create using conda
conda create -n <env_name> python=3.11
conda activate <env_name>

Install uv

Once you have activated your virtual environment, you need to install uv. To install uv, use the following command:

pip install uv

Install Helix requirements

To install the requirements for Helix, use the following command:

uv sync --all-groups

The --all-groups flag here will add the developer dependencies for formatting the code, code quality checks and testing.

Running Helix

Once you have installed Helix, you can run it from the terminal like so:

uv run helix

A browser window will open to the main page of the app.