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.

The Algorithm lab enables you to create, store, and manage your projects in the cloud. Only you can access your projects unless you share them or add collaborators.

View All Projects

The All Projects page displays all of your QuantConnect projects in the organization, including libraries and Boot Camp lessons.

Click a project or directory on the page to open it.

Follow these steps to view the page:

  1. Log in to the Algorithm Lab.
  2. In the left navigation bar, click Projects.
  3. Click Open Project.

Create Projects

Follow these steps to create new projects:

  1. Log in to the Algorithm Lab.
  2. In the left navigation bar, click Projects.
  3. On the Projects page, click Create New Algorithm.
  4. The web IDE displays an empty project.

Close Projects

In the Project panel, click Close to close projects.

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.

To clone a project, in the Project panel, click Clone.

Migrate Projects

Migrate a project to clone the project and move the cloned version of the project from an organization that you own to another organization of which you're a member. You must be the organization administrator to migrate projects out of the organization. Migrate a project to run the project using resources from a different organization and to collaborate on the project with members from a different organization. When you migrate projects, the project files are copied but the content stored in the ObjectStore is not retained.

To migrate a project, in the Project panel, click Migrate.

Rename Projects

Follow these steps to rename projects:

  1. Open the project you want to rename.
  2. In the Project panel, hover over the project name and then click the pencil icon that appears.
  3. In the Name field, enter the new project name and then click Save Changes.

Create Project Directories

Rename 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:

  1. Open the project to which you want to add a parameter.
  2. In the Project panel, click Add New Parameter.
  3. Enter the parameter name.
  4. The parameter name must be unique in the project.

  5. Enter the default value.
  6. Click Create Parameter.
  7. 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 default values for algorithm parameters:

  1. Open the project that contains the parameter for which you want to set a default value.
  2. In the Project panel, hover over the algorithm parameter and then click the pencil icon that appears.
  3. Enter a default value for the parameter and then click Save
  4. The Project panel displays the default parameter value next to the parameter name.

Delete Parameters

Follow these steps to delete algorithm parameters:

  1. Open the project that contains the parameter you want to delete.
  2. In the Project panel, hover over the algorithm parameter and then click the trash can icon that appears.
  3. Remove the GetParameter calls that were associated with the parameter from your code files.

Delete Projects

You can delete a project when it is open or closed.

Delete Open Projects

In the Project panel, click Delete, and then click Yes to delete the project.

Delete Closed Projects

Follow these steps to delete the project:

  1. Open the My Projects page.
  2. If the project is in a directory, click the directory files to navigate to the project file.
  3. Hover over the project file and then click the trash can icon that appears.
  4. "Project deleted" displays.

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: