Installation

How to install SOLQC on your own personal computer

Installing Docker (~5 minutes)

The first thing you'll need to do is to install docker (wiki link). Docker is a computer program that performs operating-system-level virtualisation. This means that you will be able to run a virtual machine very easily from the command line. And more importantly, you'll be able to run SOLQC with just a simple command. This is a pretty straightforward procedure, just follow the instructions in the following link:

Get Started with Docker | DockerDocker

You'll need to perform 3 steps:

1. Sign-up for docker

2. Download and install docker

3. Run docker.

Mac / Windows

Start the docker desktop application.

Linux

Unless you changed the default settings, docker will be running on default. To start it manually do:

$ sudo systemctl start docker

or

$ sudo service docker start

Note: Currently, docker might work slowly on Apple Silicon Processors (M1 and M2). If possible we recommend using different machines.

Installing SOLQC (~3 minutes)

Make sure docker is running.

To make sure docker is running, run the following command from the terminal :

$ docker stats --no-stream

If it outputs an error then it is not running and you need to start docker.

Now, that you have docker installed and running! follow these instructions:

Download and Start SOLQC

Once you know docker is running, you can install and start SOLQC with this simple line from the terminal (or any other command line prompt) :

$ docker run -p 5000:5000 solqc/tool

Note that in new mac ios version the port 5000 is used. Therefore, in order to run solqc you should disable Airplay. For further details:

https://twissmueller.medium.com/resolving-the-problem-of-port-5000-already-being-in-use-dd2fe4bad0be

The first time you run this line, it will download SOLQC from DockerHub. This might take a couple of minutes. Once the download is finished, it will automatically start SOLQC. To access it, you'll need to open your browser and copy the following address (or just click on 'address'):

http://localhost:5000/

If all went well you should see the following screen:

If you see this screen then you have successfully installed our software, Well done!

We highly recommend going through our toy example in the following section.