Skip to content

Installation Instructions

Matthew Archer edited this page Mar 18, 2021 · 14 revisions
Table of contents

Ubuntu
Windows

Ubuntu

Note: OnkoDICOM should work on other Linux distributions, however it has not been tested on them. If you identify any issues preventing OnkoDICOM from running on other Linux distributions, please make a ticket.

These instructions are based off this comment posted by @sjswerdloff

Onko can be installed on Ubuntu 18.04, if you do not run Ubuntu you can try it on a virtual machine such as Virtualbox A premade Ubuntu virtual machine can be downloaded from OSBoxes.

Onko requires virtualenv, python3-dev, gcc and git installed and can be installed by running this command in the terminal.

sudo apt install virtualenv git python3-dev gcc

Clone the Onko repository

git clone https://github.com/didymo/OnkoDICOM.git

Enter the directory and create a virtual environment with a name of your choice, in this case it's venv.

cd OnkoDICOM
virtualenv --python=python3 venv

Note that when cloning into a PyCharm workspace, it is recommended to create a virtual environment from the terminal outside of PyCharm, as PyCharm's built-in virtual environment creation often leads to issues with the pip version.

Activate the virtual environment

source venv/bin/activate

Install the requirements

pip install -r pre-requirements.txt
pip install -r requirements.txt`

You can execute Onko by running

python main.py

Windows

In order to run OnkoDICOM on Windows, you will need to have installed:

  • 64-bit Python 3.7 or later. OnkoDICOM will not run on 64-bit computers that have a 32-bit version of Python installed. Additionally, OnkoDICOM has not been tested on 32-bit machines.
  • Visual Studio Build Tools

If you do not already have virtualenv installed into your global packages, execute the command:

pip install virtualenv

First, clone the OnkoDICOM repository and switch to it:

git clone git clone https://github.com/Fincap/OnkoDICOM.git
cd OnkoDICOM

Then, create and activate the virtual environement:

python -m virtualenv venv
venv\Scripts\activate

If you get an error saying execution of scripts is disabled on your system, use this solution to fix it.

Once you are within the virtual environment, install the requirements:

pip install -r pre-requirements.txt
pip install -r requirements.txt

After the requirements are installed, you can run OnkoDICOM with the command:

python main.py

OnkoDICOM will always need to be run within the virtualenvironment, so make sure it is activated before attempting to run Onko.