Development Environment

Configuration

Introduction

The Local Platform is configured by extension settings in VS Code and by the LEAN Engine settings. Change these settings at any time to suit your needs.

Extension Settings

Follow these steps to view the settings of the Local Platform extension:

  1. Open VS Code.
  2. In the top navigation bar, click File > Preferences > Settings.
  3. On the Settings page, in the left navigation menu, click Extensions > QuantConnect.

The following table describes each setting:

NameDescription
Executable Path: DockerA path to the Docker installation you want to use.
Executable Path: LeanA path to the LEAN CLI executable you want to use.
Lean: InitA path to the current organization workspace.
Sync: Local And Cloud ProjectsYes to synchronize cloud and local projects. Otherwise, No. No is only available for Institution organizations.
User: Preferred LanguageThe programming language to use when creating new projects. Py for Python or C# for C#.

LEAN Settings

The Lean configuration contains settings for locally running the LEAN engine. This configuration is created in the lean.json file when you pull or create an organization workspace. The configuration is stored as JSON, with support for both single-line and multiline comments.

The Lean configuration file is based on the Launcher / config.json file from the Lean GitHub repository. When you pull or create an organization workspace, the latest version of this file is downloaded and stored in your organization workspace. Before the file is stored, some properties are automatically removed because the Local Platform automatically sets them.

The Local Platform can update most of the values of the lean.json file. The following table shows the configuration settings that you need to manually adjust in the lean.json file if you want to change their values:

NameDescriptionDefault
show-missing-data-logsLog missing data files. This is useful for debugging.true
algorithm-manager-time-loop-maximumThe maximum amount of time the algorithm can spend in a single time loop.20
maximum-warmup-history-days-look-backThe maximum number of days of data the history provider will provide during warm-up in live trading. The history provider expects older data to be on disk.5
maximum-chart-seriesThe maximum number of chart series you can create in backtests.30
maximum-data-points-per-chart-seriesThe maximum number of data points you can add to a chart series in backtests.1,000,000

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: