Installation
Supported OS
Currently,
ivadomed
supports GPU/CPU onLinux
andWindows
, and CPU only onmacOS
and Windows Subsystem for Linux.
Step 1: Setup dedicated python environment
You can setup
ivadomed
using either Conda or Venv:
Setup Python Venv Virtual Environment.
ivadomed
requires Python >= 3.7 and <3.10.First, make sure that a compatible version of Python 3 is installed on your system by running:
python3 --versionpython --versionIf your system’s Python is not 3.7, 3.8, or 3.9 (or if you don’t have Python 3 installed at all), please install Python before continuing.
Once you have a supported version of Python installed, run the following command:
# Replacing ``3.X`` with the Python version number that you installed): python3.X -m venv ivadomed_envNote
If you use
Debian
orUbuntu
, you may be prompted to install thepython3-venv
module when creating the virtual environment. This is expected, so please follow the instructions provided by Python. For other operating systems,venv
will be installed by default.python -m venv ivadomed_envActivate the new virtual environment (default named
ivadomed_env
)source ivadomed_env/bin/activatecd ivadomed_env/Scripts/ activate
Create new conda environment using
environment.yml
fileconda env create --name ivadomed_envActivate the new conda environment
conda activate ivadomed_envThere are numerous constraints and limited package availabilities with ComputeCanada cluster environment.
It is best to attempt
venv
based installations and follow up with ComputeCanada technical support as MANY specially compiled packages (e.g. numpy) are exclusively available for Compute Canada HPC environment.If you are using Compute Canada, you can load modules as mentioned here and also here.
Step 2: Install ivadomed
Install
ivadomed
and its requirements from PyPI:pip install --upgrade pip pip install ivadomedBleeding-edge developments are available on the project’s master branch on Github. Install
ivadomed
from source:git clone https://github.com/ivadomed/ivadomed.git cd ivadomed pip install -e .