Install Prerequisites

The instructions below are for Microsoft Windows and should be similar for Linux or Mac with minor modifications.

When there is a significant difference on non-Windows platforms, it will be called out in a box like this one.
Tips or solutions to common problems will be highlighted in a box like this.

The minimum hardware requirements for using CQG Custom Algo SDK are:

  • 12 GB RAM (preferably 16 GB or more)
  • 4 CPU cores
  • 20 GB free hard disk space

CQG Custom Algo SDK uses Docker to distribute all of the tools you need to build and test your trading algorithm ("Algo"). Once Docker is installed, you can import CQG Custom Algo SDK image and begin developing your Algo.

Docker Download

Download and install Docker Desktop for Windows/Mac.

WSL2 must be enabled in docker settings. This requires Windows 10 version 2004 or greater.

If you are using Linux follow the official install instructions for Docker for your distribution.

During the install Docker may ask you to enable virtualization support and reboot your computer.

Once Docker Desktop is installed, running it will create an icon in your system tray area that looks like the Docker logo.

Right click on the tray icon, choose 'Settings' and select the 'Advanced' tab.

Ensure that the docker image has 8192 MB of memory and at least 2 cores. Memory that you assign to the docker image will not be available to Windows/Mac while Docker is running. CPU cores, however, are shared with the host OS, so it makes sense to allow Docker to use all available cores to compile your algo.

Sharing

Docker also requires access to the Windows drive where you keep the source code.

Open Settings -> Shared Drives and confirm the drive where you intend to keep your Algo source code.

If you run into trouble with drive sharing, see Docker Desktop for Windows tips on troubleshooting common issues.

Editor

CQG Custom Algo SDK includes complete configuration for C++ development with the Visual Studio Code editor. It is our recommendation if you are new to C++ development using Linux, however other editors are also supported.

Previous   Next