Projects

Getting Started

Introduction

Projects contain files to run backtests, launch research notebooks, perform parameter optimizations, and deploy live trading strategies. You need to create projects in order to create strategies and share your work with other members. Projects enable you to generate institutional-grade reports on the performance of your backtests. You can create your projects from scratch or you can utilize pre-built libraries and third-party packages to expedite your development process.

View All Projects

To view all your projects, open the workspace directory on your local machine.

Create Projects

Follow these steps to create a project on the local platform:

  1. Log in to the local platform.
  2. In the left navigation menu, click the VS Code QuantConnect icon QuantConnect icon.
  3. If a project is already open, close it.
  4. In the Open Project panel, click Create Project.
  5. Open a new project
  6. Enter the project name and then press Enter.
  7. Name a new project

The new project directory is added to your workspace directory and the project opens.

Open Projects

Follow these steps to open a project on the local platform:

  1. Log in to local platform.
  2. In the left navigation menu, click the VS Code QuantConnect icon QuantConnect icon.
  3. If a project is already open, close it.
  4. In the Project panel, click Open Project.
  5. Open a new project
  6. In the Open QuantConnect Project window, click a project in your workspace directory and then click Select.
  7. Open an existing project

Close Projects

Follow these steps to close a project:

  1. In the left navigation menu, click the VS Code QuantConnect icon QuantConnect icon.
  2. In the Project panel, click Close.
  3. Close project

Clone Projects

Clone a project to create a new copy of the project and save it within the same organization. When you clone a project, the project files are duplicated but the backtest results are not retained. Cloning enables you to test small changes in your projects before merging the changes back into the original project.

Follow these steps to clone a project:

  1. Open the project.
  2. In the left navigation menu, click the VS Code QuantConnect icon QuantConnect icon.
  3. In the Project panel, click Clone.
  4. Clone a local project

The cloned version of the project opens in a new VS Code window.

Rename Projects

Follow these steps to rename a project:

  1. Open the project.
  2. In the left navigation menu, click the QuantConnect icon.
  3. In the Project panel, hover over the project name and then click the pencil icon that appears.
  4. In the Name field, enter the new project name and then click Save Changes.

The project name must only contain -, _, letters, numbers, and spaces. The project name can't start with a space or be any of the following reserved names: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, or LPT9.

Create Project Directories

Set the name of a project to directoryName / projectName to create a project directory.

Set Descriptions

Follow these steps to set the project description:

  1. Open the project.
  2. In the Project panel, hover over the project name and then click the pencil icon that appears.
  3. In the Description field, enter the new project description and then click Save Changes.

Edit Parameters

You can add parameters, set default parameter values, and remove parameters from your projects.

Add Parameters

Follow these steps to add an algorithm parameter to a project:

  1. Open the project.
  2. In the left navigation menu, click the QuantConnect icon.
  3. In the Project panel, click Add New Parameter.
  4. Enter the parameter name.
  5. The parameter name must be unique in the project.

  6. Enter the default value.
  7. Click Create Parameter.
  8. Add the GetParameter method to your code files to inject the parameter value into your algorithm.

Set Default Parameter Values

Follow these steps to set the default value of an algorithm parameter in a project:

  1. Open the project.
  2. In the left navigation menu, click the QuantConnect icon.
  3. In the Project panel, hover over the algorithm parameter and then click the pencil icon that appears.
  4. Enter a default value for the parameter and then click Save.
  5. The Project panel displays the default parameter value next to the parameter name.

Delete Parameters

Follow these steps to delete an algorithm parameter in a project:

  1. Open the project.
  2. In the left navigation menu, click the QuantConnect icon.
  3. In the Project panel, hover over the algorithm parameter and then click the trash can icon that appears.
  4. Remove the GetParameter calls that were associated with the parameter from your code files.

Delete Projects

Follow these steps to delete a project:

  1. Open the project.
  2. In the left navigation menu, click the VS Code QuantConnect icon QuantConnect icon.
  3. In the Project panel, click Delete.
  4. Delete a local project

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: