Installation

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

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 BioFEFI source code by cloning the repository from Github.

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

Setting up your developer environment

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

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

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 poetry

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

pip install poetry

Install BioFEFI requirements

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

poetry install

Running BioFEFI

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

poetry run biofefi

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