8 Installation

Below you can find easy step-by-step guides to the installation of IQdesktop and the required components. Note that installation of docker requires administrator rights on the host computer.

8.1 Windows

It is assumed that it is a “single user” Windows computer on which the analyst is typically working on.

8.1.1 Step1: Docker

  • Install docker-desktop that you can obtain from here: https://www.docker.com/products/docker-desktop

  • Add your username to the docker group

    • Press the Windows key
    • Type “Computer Management”
    • Right click “Computer Management” and select “Run as administrator”
    • Navigate to “System Tools” -> “Local Users and Groups” -> “Groups” -> “docker-users”
    • Double click “docker-users” group and add your account/username as member

  • Start docker

  • Update docker settings

    • Find the docker icon in the Windows task bar and right click on it, select “Switch to Linux containers…” as shown in the figure to the right. If this option is not shown then do not change it
    • Select “Settings” => “General” and uncheck “Use the WSL 2 based engine”
    • Select “Settings” => “Resources” => “Advanced” and change the settings as desired. Typically I allow my docker installation to have access to at least half my computers memory and more than half the cores. After all I want to use it for computation.
    • Select “Settings” => “Resources” => “Advanced” and set Swap to 2 GB (higher not needed - lower not a good idea)
    • Select “Settings” => “Resources” => “File Sharing” in the Docker options and set a tick in the box for the C drive

Additional information: https://docs.docker.com/docker-for-windows/install/.

8.1.2 Step 2: IQdesktop

The public version of IQdesktop is hosted on Docker Hub. No login to Docker Hub is required. You can download it to your system as follows:

  • On your systems command line type: docker pull intiquan/iqdesktop:latest
  • Wait until download is completed

The image is relatively large (~8GB). The download might take a while, depending on your internet connection. Once downloaded, the image will remain on your system and does not need to be downloaded again. If you want to install updates to IQdesktop, only incremental changes are downloaded.

8.1.3 Step 3

The next subsection provides information on how to update IQdesktop to a newer version and how to install versioned IQdesktop images that were received from IntiQuan (not obtained from Docker Hub).

8.1.4 Updating IQdesktop

The currently installed version of IQdesktop can be updated to the latest one by typing the following on the command line:

  • docker pull intiquan/iqdesktop:latest

8.1.5 Non-public image

Non public versions of IQdesktop come as a download from the IntiQuan system. The files have the name iqdesktop_x.y.z.tar.gz where x.y.z is the version number. In order to install these images on your system do the following:

  • Store the downloaded iqdesktop_x.y.z.tar.gz file on your host system
  • Go to the command line and navigate into the folder where the file is located
  • Type: docker image load < iqdesktop_x.y.z.tar.gz
  • Wait until the import is completed

8.2 MacOS

8.2.1 Step1: Docker

  • Install docker-desktop that you can obtain from here: https://www.docker.com/products/docker-desktop
  • Add your user to the docker group using the command sudo usermod -aG docker "username"
  • Click the Docker menu (whale menu) to see preferences and other options

Additional information: https://docs.docker.com/docker-for-mac/install/.

8.2.2 Step 2: IQdesktop

The public version of IQdesktop is hosted on Docker Hub. No login to Docker Hub is required. You can download it to your system as follows:

  • On your systems command line type: docker pull intiquan/iqdesktop:latest
  • Wait until download is completed

The image is relatively large (~8GB). The download might take a while, depending on your internet connection. Once downloaded, the image will remain on your system and does not need to be downloaded again. If you want to install updates to IQdesktop, only incremental changes are downloaded.

8.2.3 Step 3

The next subsection provides information on how to update IQdesktop to a newer version and how to install versioned IQdesktop images that were received from IntiQuan (not obtained from Docker Hub).

8.2.4 Updating IQdesktop

The currently installed version of IQdesktop can be updated to the latest one by typing the following on the command line:

  • docker pull intiquan/iqdesktop:latest

8.2.5 Non-public image

Non public versions of IQdesktop come as a download from the IntiQuan system. The files have the name iqdesktop_x.y.z.tar.gz where x.y.z is the version number. In order to install these images on your system do the following:

  • Store the downloaded iqdesktop_x.y.z.tar.gz file on your host system
  • Go to the command line and navigate into the folder where the file is located
  • Type: docker image load < iqdesktop_x.y.z.tar.gz
  • Wait until the import is completed

8.3 Linux

Note that the installation process is independent of the host planned to be a single or multi-user system.

8.3.1 Step1: Docker

8.3.2 Step 2: IQdesktop

The public version of IQdesktop is hosted on Docker Hub. No login to Docker Hub is required. You can download it to your system as follows:

  • On your systems command line type: docker pull intiquan/iqdesktop:latest
  • Wait until download is completed

The image is relatively large (~8GB). The download might take a while, depending on your internet connection. Once downloaded, the image will remain on your system and does not need to be downloaded again. If you want to install updates to IQdesktop, only incremental changes are downloaded.

8.3.3 Step 3

The next subsection provides information on how to update IQdesktop to a newer version and how to install versioned IQdesktop images that were received from IntiQuan (not obtained from Docker Hub).

8.3.4 Updating IQdesktop

The currently installed version of IQdesktop can be updated to the latest one by typing the following on the command line:

  • docker pull intiquan/iqdesktop:latest

8.3.5 Non-public image

Non public versions of IQdesktop come as a download from the IntiQuan system. The files have the name iqdesktop_x.y.z.tar.gz where x.y.z is the version number. In order to install these images on your system do the following:

  • Store the downloaded iqdesktop_x.y.z.tar.gz file on your host system
  • Go to the command line and navigate into the folder where the file is located
  • Type: docker image load < iqdesktop_x.y.z.tar.gz
  • Wait until the import is completed

8.4 In the Cloud

IQdesktop deployment in the cloud is straight forward. Nevertheless, it might be a good idea to have a “cloud strategy” not only for your computational system but also for data storage, security, etc.

There are several cloud systems - and IQdesktop will run on all which are able to provide access to an instance with a Linux based operating system on which Docker can run (see here for Docker system requirements).

A simple example on how to get IQdesktop running on AWS within minutes is shown in Appendix C.

Of course, you can also use more sophisticated approacvhes, such as