Key Concepts

Getting Started

Introduction

The local QuantConnect platform enables you to seamlessly develop quant strategies on-premise and in QuantConnect Cloud, getting the best of both environments. With the local platform, you can harness your local version control, autocomplete, and coding tools with the full power of a scalable cloud at your finger tips. We intend to keep complete feature parity with our cloud environment, allowing you to harness cloud or local datasets to power on-premise quantitative research.

Prerequisites

Our local platform requires Docker and the LEAN CLI. When you launch the local platform, we scan for these projects and prompt you to install them to continue. We run all algorithms in a Docker container to avoid installing any dependencies on your computer. The LEAN CLI is required to simplify the interactions with the cloud.

Installation

Basic Usage

Follow these steps to create a new trading algorithm and backtest it in QuantConnect Cloud:

  1. Log in to the Algorithm Lab.
  2. Start Docker Desktop.
  3. Open Visual Studio Code.
  4. In the Initialization Checklist panel, click Login to QuantConnect.
  5. In the Visual Studio Code window, click Open.
  6. On the Code Extension Login page, click Grant Access.
  7. In VS Code, in the Select Workspace panel, click Pull Organization Workspace.
  8. In the Pull QuantConnect Organization Workspace window, click the cloud workspace (organization) that you want to pull.
  9. In the Pull QuantConnect Organization Workspace window, create a directory to serve as the workspace and then click Select.
  10. If you are running Docker on Windows using the legacy Hyper-V backend instead of the new WSL 2 backend, you need to enable file sharing for your temporary directories and for your workspace. To do so, open your Docker settings, go to Resources > File Sharing and add C: / Users / <username> / AppData / Local / Temp and your workspace path to the list. Click Apply & Restart after making the required changes.

  11. In the Open Project panel, click Create Project.
  12. Enter the project name and then press Enter.
  13. Congratulations! You just created your first local project.

  14. In the top-right corner of VS Code, click Build and then click Backtest.
  15. The backtest results page displays your algorithm's performance over the backtest period.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: