QuantConnect LEAN Tutorials

Tutorial Website | Documentation | Download LEAN | Slack Channel

This repository is a collection of WordPress and Jupyter notebook tutorials for LEAN demonstrating financial concepts and LEAN. Tutorials are categorized into folders with each Category and Tutorial Series. The Jupyter notebook and the associated HTML webpage must use matching file names. The HTML is generated and displayed with wordpress.

Lean Engine is an open-source fully managed C# algorithmic trading engine built for desktop and cloud usage. It was designed in Mono and operates in Windows, Linux and Mac platforms. For more information about the LEAN Algorithmic Trading engine see the Lean Engine repository.

New Tutorial Requests and Edits

Please submit new tutorial requests as an issue to the Tutorials repository. Before submitting an issue please read others to ensure it is not a duplicate. Edits and fixes for clarity are warmly welcomed!

Mailing List

The mailing list for the project can be found on Google Groups

Contributors and Pull Requests

Contributions are warmly very welcomed but we ask you read the existing code to see how it is formatted, commented and ensure contributions match the existing style. All code submissions must include accompanying tests. Please see the contributor guide lines.

Strategy Library Development Workflow

To publish a strategy to our Strategy Library, follow these steps:

1. Review filtered sources like SSRN, arxiv, and other academic journals/papers for a strategy to implement. Try to adhere to the Quant League competition criteria and the Alpha Streams minimum criteria and review process.
2. Post a 3-point development plan to our Slack channel and wait for approval by @jaredbroad or @alexcatarino. See an example here.
3. Develop the strategy (add license and imports to main.py).
4. Add an Issue to the Tutorials repo (example).
5. Add @alexcatarino as a collaborator to the project.
6. Publish a strategy write-up in the Slack channel and wait for approval (see Strategy Library for examples).
7. Convert the strategy write-up to HTML form (examples).
8. Make PR (following the Contributor's Guidelines):
   • If the write-up includes images, upload them here.
   • Add summary HTML files to Strategy Library directory. If it's a non-Quantpedia strategy, set the ID number (in the directory name) to the next available after 1023.
   • If the strategy is from Quantpedia, add strategy ID and backtest ID to quantpedia.json.
   • Add strategy metadata to this file (Currently semi-sorted by Quantpedia strategy ID).
9. After the PR is merged, send @jaredbroad the URL and a 1-sentence summary of what the paper/strategy is about and post the strategy to the forum with the backtest of the algorithm and a short summary of the project (example).