Lean README

The project's README from github.com/QuantConnect/Lean. As one markdown file: README.md.

lean-header

Build Status     Regression Tests     LEAN Forum     Discord Chat

Lean Home | Documentation | Download Zip | Docker Hub | Nuget

features-header

LEAN is an event-driven, professional-caliber algorithmic trading platform built with a passion for elegant engineering and deep quant concept modeling. Out-of-the-box alternative data and live-trading support.

feature-list

modular-header LEAN is modular in design, with each component pluggable and customizable. It ships with models for all major plug-in points.

modular-architecture

cli-header lean-animation

QuantConnect Lean CLI is a command-line interface tool for interacting with the Lean algorithmic trading engine, which is an open-source platform for backtesting and live trading algorithms in multiple financial markets. It allows developers to manage projects, run backtests, deploy live algorithms, and perform various other tasks related to algorithmic trading directly from the terminal. The CLI simplifies the workflow by automating tasks, enabling seamless integration with cloud services, and facilitating collaboration with the QuantConnect community. It's designed for quant developers who need a powerful and flexible tool to streamline their trading strategies. Please watch the instructions videos to learn more.

Installation

pip install lean

Commands

Create a new project containing starter code

lean project-create

Run a local Jupyter Lab environment using Docker

lean research

Backtest a project locally using Docker

lean backtest

Optimize a project locally using Docker

lean optimize

Start live trading a project locally using Docker

lean live

Download the LEAN CLI Cheat Sheet for the full list of commands.

modular-architecture

diagram

modular-architecture

This section will cover how to install lean locally for you to use in your environment. For most users we strongly recommend the LEAN CLI which is prebuilt and runs on all platforms. Refer to the following readme files for a detailed guide regarding using your local IDE with Lean.

To install locally, download the zip file with the latest master and unzip it to your favorite location. Alternatively, install Git and clone the repo:

git clone https://github.com/QuantConnect/Lean.git
cd Lean

macOS

NOTE: Visual Studio for Mac has been discontinued, use Visual Studio Code instead

Linux (Debian, Ubuntu)

dotnet build QuantConnect.Lean.sln
cd Launcher/bin/Debug
dotnet QuantConnect.Lean.Launcher.dll

Windows

Python Support

A full explanation of the Python installation process can be found in the Algorithm.Python project.

Local-Cloud Hybrid Development.

Seamlessly develop locally in your favorite development environment, with full autocomplete and debugging support to quickly and easily identify problems with your strategy. Please see the CLI Home for more information.

Issues and Feature Requests

Please submit bugs and feature requests as an issue to the Lean Repository. Before submitting an issue, please read the instructions to ensure it is not duplicated.

Mailing List

The mailing list for the project can be found on LEAN Forum. Please use this to ask for assistance with your installation and setup questions.

Contributors and Pull Requests

Contributions are warmly welcomed, but we ask you to read the existing code to see how it is formatted and commented on and ensure contributions match the existing style. All code submissions must include accompanying tests. Please see the contributor guidelines. All accepted pull requests will get a $50 cloud credit on QuantConnect. Once your pull request has been merged, write to us at [email protected] with a link to your PR to claim your free live trading. QC <3 Open Source.

A huge thank you to all our contributors!


Acknowledgements

The open sourcing of QuantConnect would not have been possible without the support of the Pioneers. The Pioneers formed the core 100 early adopters of QuantConnect who subscribed and allowed us to launch the project into open source.

Ryan H, Pravin B, Jimmie B, Nick C, Sam C, Mattias S, Michael H, Mark M, Madhan, Paul R, Nik M, Scott Y, BinaryExecutor.com, Tadas T, Matt B, Binumon P, Zyron, Mike O, TC, Luigi, Lester Z, Andreas H, Eugene K, Hugo P, Robert N, Christofer O, Ramesh L, Nicholas S, Jonathan E, Marc R, Raghav N, Marcus, Hakan D, Sergey M, Peter McE, Jim M, INTJCapital.com, Richard E, Dominik, John L, H. Orlandella, Stephen L, Risto K, E.Subasi, Peter W, Hui Z, Ross F, Archibald112, MooMooForex.com, Jae S, Eric S, Marco D, Jerome B, James B. Crocker, David Lypka, Edward T, Charlie Guse, Thomas D, Jordan I, Mark S, Bengt K, Marc D, Al C, Jan W, Ero C, Eranmn, Mitchell S, Helmuth V, Michael M, Jeremy P, PVS78, Ross D, Sergey K, John Grover, Fahiz Y, George L.Z., Craig E, Sean S, Brad G, Dennis H, Camila C, Egor U, David T, Cameron W, Napoleon Hernandez, Keeshen A, Daniel E, Daniel H, M.Patterson, Asen K, Virgil J, Balazs Trader, Stan L, Con L, Will D, Scott K, Barry K, Pawel D, S Ray, Richard C, Peter L, Thomas L., Wang H, Oliver Lee, Christian L..

Lean (QuantConnect/Lean)

Searching Database…

22.1K ·GitHub
Что это такое?LEAN — это open-source движок алгоритмической торговли от QuantConnect, построенный по событийной модели и написанный на C# с поддержкой Python. С его помощью вы создаёте стратегии, тестируете их на исторических данных (бэктест) и торгуете вживую, причём поддержка альтернативных данных работает сразу из коробки.
Так это приложение, которое я устанавливаю и запускаю мышкой, или фреймворк, под который пишу код?Это фреймворк, под который вы пишете код: стратегии создаются на C# или Python, а движок LEAN их исполняет. Архитектура модульная — любой компонент можно заменить — и управляется всё через LEAN CLI, Docker или вашу IDE.
Как его запустить?Большинству пользователей README советует готовую сборку LEAN CLI, которая работает на всех платформах. Чтобы собрать из исходников, установите dotnet 10 SDK и склонируйте или распакуйте репозиторий, затем используйте Visual Studio на Windows (нажмите F5), VS Code на macOS или обычные команды dotnet на Linux.
Нужен ли .NET SDK, даже если я пишу стратегии на Python?Да — сам движок написан на C# под .NET, поэтому для сборки и запуска обязателен dotnet 10 SDK (Visual Studio на Windows, VS Code с C# Dev Kit на macOS). Сами стратегии при этом можно писать на Python.
Есть ли подводные камни при установке?Главный — на macOS: Visual Studio for Mac снят с поддержки, поэтому вместо него используйте Visual Studio Code с расширением C# Dev Kit. В остальном всё сводится к тому, чтобы сначала установить dotnet 10 — без него собрать проект не получится.
Он заработает на моём Mac или только на Windows?Работает на Windows, macOS и Linux (отдельно упомянуты Debian и Ubuntu), причём LEAN CLI поставляется в готовом виде для всех платформ. Есть также Docker-образ на Docker Hub — если вам удобнее работать с контейнерами.
Он может совершать реальные сделки или это только бэктест?Живая торговля поддерживается сразу из коробки, а не только бэктест, и альтернативные данные тоже встроены. В придачу: за принятые pull request дают 50 долларов кредита на облако QuantConnect плюс бесплатную live-торговлю.
Что внутри движка можно настраивать?Практически весь стек: LEAN модульный, каждый компонент можно заменить, и по умолчанию в комплекте идут модели для всех основных точек расширения — так что вы можете подставить свои реализации.
Я обязан использовать облако QuantConnect или можно всё запускать локально?Облако не требуется — движок open source под лицензией Apache-2.0 и работает локально. В README также описан гибридный режим «локально плюс облако»: вы разрабатываете у себя с полноценным автодополнением и отладкой.
Size
574 MB
Stars
22.1K
Age
11y
Commits · 90 Days