ivadomedsupports GPU/CPU on
Windows, and CPU only on
macOSand Windows Subsystem for Linux.
Step 1: Setup dedicated python environment
You can setup
ivadomedusing either Conda or Venv:
Setup Python Venv Virtual Environment.
ivadomedrequires 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 --version
If 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_env
If you use
Ubuntu, you may be prompted to install the
python3-venvmodule when creating the virtual environment. This is expected, so please follow the instructions provided by Python. For other operating systems,
venvwill be installed by default.python -m venv ivadomed_env
Activate the new virtual environment (default named
ivadomed_env)source ivadomed_env/bin/activatecd ivadomed_env/Scripts/ activate
Create new conda environment using
environment.ymlfileconda env create --name ivadomed_env
Activate the new conda environmentconda activate ivadomed_env
There are numerous constraints and limited package availabilities with ComputeCanada cluster environment.
It is best to attempt
venvbased installations and follow up with ComputeCanada technical support as MANY specially compiled packages (e.g. numpy) are exclusively available for Compute Canada HPC environment.
Step 2: Install
ivadomedand its requirements from PyPI:pip install --upgrade pip pip install ivadomed
Bleeding-edge developments are available on the project’s master branch on Github. Install
ivadomedfrom source:git clone https://github.com/ivadomed/ivadomed.git cd ivadomed pip install -e .